polychromatic-cli.1

.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "polychromatic-cli" "1" "2022-12-03"
.P
.SH NAME
.P
Polychromatic - RGB lighting management software for GNU/Linux
.P
.SH SYNOPSIS
.P
\fBpolychromatic-cli\fR [OPTIONS]
.P
.SH DESCRIPTION
.P
This is the command line interface for configuring device options and retrieving
status information from connected hardware.\&
.P
.SH OPTIONS
.P
.SS DEVICE SELECTION
.P
.RS 4
Use the following arguments to select the devices to read/set changes to.\&
Omitting these arguments selects all devices.\&
.P
\fB-d\fR, \fB--device\fR <ID>
.RS 4
Select the device by form factor.\&
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
accessory
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
display
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
fan
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
gpu
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
headset
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
keyboard
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
keypad
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
laptop
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
mouse
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
mousemat
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
ram
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
speaker
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
stand

.RE
.P
.RE
\fB-n\fR, \fB--name\fR <NAME>
.RS 4
Select a device by its full name, such as "Razer BlackWidow Chroma"
.P
.RE
\fB-s\fR, \fB--serial\fR <SERIAL>
.RS 4
Select a device by its serial string.\&
.P
.RE
.RE
.SS DEVICE INFORMATION
.P
.RS 4
\fB-l\fR, \fB--list-devices\fR
.RS 4
List the selected device(s) and their zone(s)
.P
.RE
\fB-k\fR, \fB--list-options\fR
.RS 4
List supported parameters and current settings in a table.\&
.P
.RE
.RE
.SS DEVICE OPERATION
.P
.RS 4
\fB-z\fR, \fB--zone\fR <ID>
.RS 4
Make a change to the specified zone.\& Some hardware have multiple
lighting regions.\& When omitted, all zones will be selected.\&
.P
.RE
\fB-o\fR, \fB--option\fR <ID>
.RS 4
Set an option on the device.\& For example, "static"
.P
Some options require a \fI--parameter\fR and/or \fI--colour\fR, see below.\&
.P
.RE
\fB-p\fR, \fB--parameter\fR <ID>
.RS 4
Set a parameter for the specified option if applicable.\& For example,
for a wave effect, use "right" or its numerical value (1).\&
.P
Numerical values are useful when setting multiple devices simultaneously
that do not share the same ID, such as a mouse'\&s wave is "up" (1) or
"down" (2) instead of "right" (1) and "left" (2).\&
.P
.RE
\fB-c\fR, \fB--colours\fR <#RRGGBB>[,#RRGGBB.\&.\&.\&]
.RS 4
Set a colour for the specified option if applicable.\&
.P
The input only accepts 6 byte hexadecimal values, such as #00FF00.\&
The hash must be escaped or wrapped in quotes to avoid being interpreted
as a comment by your shell.\& Alternately, the hash can be omitted.\&
.P
Multiple colours may be specified using a comma.\&
.P
.RE
\fB-e\fR, \fB--effect\fR <NAME/PATH>
.RS 4
Plays a custom software effect by its name or an absolute path to
the file.\&
.P
Not to be confused with an \fI--option\fR for hardware effects, see above.\&
.P
.RE
\fB--dpi\fR <X>[,Y]
.RS 4
Sets the DPI (dots per inch) of a mouse.\& The axis can be set
independently, otherwise the same value will be used for both X/Y.\&
.P
DPI is responsible for the speed of the mouse cursor.\&
.P
.RE
.RE
.SH MISCELLANEOUS
.P
.RS 4
\fB-h\fR, \fB--help\fR
.RS 4
Shows the help information.\&
.P
.RE
\fB-v\fR, \fB--verbose\fR
.RS 4
Prints more details about the application'\&s operation.\&
.P
.RE
\fB--version\fR
.RS 4
Prints version information:
.RS 4
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
Software version
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
Commit hash (when run from the repository directory)
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
Python version

.RE
.P
.RE
.RE
\fB--no-pretty-column\fR
.RS 4
Disables the pretty column function of the program.\& This may be required
for compatibility with specific terminals and consoles.\&
.P
.RE
\fB--locale [lang]\fR
.RS 4
Force the application to display in a specific locale.\&
For example, "fr_FR" or "nl".\&