| 1 |
.\" Copyright 1988, 1998 The Open Group |
| 2 |
.\" |
| 3 |
.\" Permission to use, copy, modify, distribute, and sell this software and its |
| 4 |
.\" documentation for any purpose is hereby granted without fee, provided that |
| 5 |
.\" the above copyright notice appear in all copies and that both that |
| 6 |
.\" copyright notice and this permission notice appear in supporting |
| 7 |
.\" documentation. |
| 8 |
.\" |
| 9 |
.\" The above copyright notice and this permission notice shall be included |
| 10 |
.\" in all copies or substantial portions of the Software. |
| 11 |
.\" |
| 12 |
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
| 13 |
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 14 |
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| 15 |
.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR |
| 16 |
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| 17 |
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| 18 |
.\" OTHER DEALINGS IN THE SOFTWARE. |
| 19 |
.\" |
| 20 |
.\" Except as contained in this notice, the name of The Open Group shall |
| 21 |
.\" not be used in advertising or otherwise to promote the sale, use or |
| 22 |
.\" other dealings in this Software without prior written authorization |
| 23 |
.\" from The Open Group. |
| 24 |
.\" |
| 25 |
.TH XSET 1 "xset 1.2.5" "X Version 11" |
| 26 |
.SH NAME |
| 27 |
xset - user preference utility for X |
| 28 |
.SH SYNOPSIS |
| 29 |
.B xset |
| 30 |
[-display \fIdisplay\fP] |
| 31 |
.br |
| 32 |
[-b] [b {on|off}] [b [\fIvolume\fP [\fIpitch\fP [\fIduration\fP]]]] |
| 33 |
.br |
| 34 |
[-bc] [bc] |
| 35 |
.br |
| 36 |
[-c] [c {on|off}] [c [\fIvolume\fP]] |
| 37 |
.br |
| 38 |
[+dpms] [-dpms] |
| 39 |
.br |
| 40 |
[dpms \fIstandby\fP [\fI suspend\fP [\fI off\fP]]] |
| 41 |
.br |
| 42 |
[dpms force {standby|suspend|off|on}] |
| 43 |
.br |
| 44 |
[fp=\fIpathlist\fP] |
| 45 |
[-fp=\fIpathlist\fP] |
| 46 |
[+fp=\fIpathlist\fP] |
| 47 |
[fp-\fIpathlist\fP] |
| 48 |
[fp+\fIpathlist\fP] |
| 49 |
.br |
| 50 |
[fp default] [fp rehash] |
| 51 |
.br |
| 52 |
[-led [\fIinteger\fP|named \fIindicator\fP]] |
| 53 |
[led [\fIinteger\fP|named \fIindicator\fP]] |
| 54 |
.br |
| 55 |
[led {on|off}] |
| 56 |
.br |
| 57 |
[mouse [\fIaccel_mult\fP[/\fIaccel_div\fP] [\fIthreshold\fP]]] [mouse default] |
| 58 |
.br |
| 59 |
[p \fIpixel\fP \fIcolor\fP] |
| 60 |
.br |
| 61 |
[-r [keycode]] [r [keycode]] |
| 62 |
[r {on|off}] [r rate \fIdelay\fP [\fIrate\fP]] |
| 63 |
.br |
| 64 |
[s [\fIlength\fP [\fIperiod\fP]]] [s {blank|noblank}] |
| 65 |
.br |
| 66 |
[s {expose|noexpose}] [s {on|off}] [s default] [s activate] [s reset] |
| 67 |
.br |
| 68 |
[q] |
| 69 |
.br |
| 70 |
[-version] |
| 71 |
.SH DESCRIPTION |
| 72 |
This program is used to set various user preference options of the display. |
| 73 |
.SH OPTIONS |
| 74 |
.PP |
| 75 |
.TP 8 |
| 76 |
.B \-display \fIdisplay\fP |
| 77 |
This option specifies the server to use; see \fIX(7)\fP. |
| 78 |
.PP |
| 79 |
.TP 8 |
| 80 |
.B b |
| 81 |
The \fBb\fP option controls bell volume, pitch and duration. |
| 82 |
This option accepts up to three numerical parameters, a preceding |
| 83 |
dash(-), or a 'on/off' flag. If no parameters are |
| 84 |
given, or the 'on' flag is used, the system defaults will be used. |
| 85 |
If the dash or 'off' are given, the bell will be turned |
| 86 |
off. |
| 87 |
If only one numerical parameter is given, the |
| 88 |
bell volume will be set to that value, as a percentage of its maximum. |
| 89 |
Likewise, the second numerical |
| 90 |
parameter specifies the bell pitch, in hertz, and |
| 91 |
the third numerical parameter |
| 92 |
specifies the duration in milliseconds. Note that not |
| 93 |
all hardware can vary the bell characteristics. The X server will set |
| 94 |
the characteristics of the bell as closely as it can to the user's |
| 95 |
specifications. |
| 96 |
.PP |
| 97 |
.TP 8 |
| 98 |
.B bc |
| 99 |
The \fBbc\fP option controls \fIbug compatibility\fP mode in the server, |
| 100 |
if possible; a preceding dash(-) disables the mode, otherwise the mode |
| 101 |
is enabled. Various pre-R4 clients pass illegal values in some |
| 102 |
protocol requests, and pre-R4 servers did not correctly generate |
| 103 |
errors in these cases. Such clients, when run against an R4 server, |
| 104 |
will terminate abnormally or otherwise fail to operate correctly. |
| 105 |
Bug compatibility mode explicitly reintroduces certain bugs into the |
| 106 |
X server, so that many such clients can still be run. This mode should be |
| 107 |
used with care; new application development should be done with this mode |
| 108 |
disabled. The server must support the MIT-SUNDRY-NONSTANDARD |
| 109 |
protocol extension in order for this option to work. |
| 110 |
.TP 8 |
| 111 |
.B c |
| 112 |
The \fBc\fP option controls key click. |
| 113 |
This option can take an optional value, a preceding dash(-), |
| 114 |
or an 'on/off' flag. |
| 115 |
If no parameter or the 'on' flag is given, the system defaults |
| 116 |
will be used. If the dash or 'off' flag is used, keyclick will be |
| 117 |
disabled. |
| 118 |
If a value from 0 to 100 is given, it is used to |
| 119 |
indicate volume, as a percentage of the maximum. |
| 120 |
The X server will set |
| 121 |
the volume to the nearest value that the hardware can support. |
| 122 |
.PP |
| 123 |
.TP 8 |
| 124 |
.B \-dpms |
| 125 |
The \fB\-dpms\fP option disables Display Power Management Signaling (DPMS) features. |
| 126 |
.TP 8 |
| 127 |
.B +dpms |
| 128 |
The \fB+dpms\fP option enables Display Power Management Signaling (DPMS) features. |
| 129 |
.TP 8 |
| 130 |
.B dpms \fIflags...\fP |
| 131 |
The \fBdpms\fP option allows the Display Power Management Signaling (DPMS) |
| 132 |
parameters to be set. |
| 133 |
The option can take up to three numerical values, or the `force' |
| 134 |
flag followed by a DPMS state. The `force' flags forces the server |
| 135 |
to immediately switch to the DPMS state specified. The DPMS state can |
| 136 |
be one of `standby', `suspend', `off', or `on'. When numerical values are |
| 137 |
given, they set the inactivity period |
| 138 |
(in units of seconds) |
| 139 |
before the three modes are activated. |
| 140 |
The first value given is for the `standby' mode, the second is for the |
| 141 |
`suspend' mode, and the third is for the `off' mode. Setting these |
| 142 |
values implicitly enables the DPMS features. A value of zero disables |
| 143 |
a particular mode. |
| 144 |
.TP 8 |
| 145 |
.B fp= \fIpath,...\fP |
| 146 |
The \fBfp=\fP sets the font path to the entries given in the path argument. |
| 147 |
The entries are interpreted by the server, not by the client. |
| 148 |
Typically they are directory names or font server names, but the |
| 149 |
interpretation is server-dependent. |
| 150 |
.TP 8 |
| 151 |
.B fp \fBdefault\fP |
| 152 |
The \fBdefault\fP argument causes the font path to be reset to the server's |
| 153 |
default. |
| 154 |
.TP 8 |
| 155 |
.B fp \fBrehash\fP |
| 156 |
The \fBrehash\fP argument resets the font path to its current value, |
| 157 |
causing the server to reread the font databases in |
| 158 |
the current font path. This is generally only used when adding new fonts to |
| 159 |
a font directory (after running \fImkfontdir\fP to recreate the font database). |
| 160 |
.PP |
| 161 |
.TP 8 |
| 162 |
.B "\-fp \fRor\fP fp\-" |
| 163 |
The \fB\-fp\fP and \fBfp\-\fP options remove elements from the current |
| 164 |
font path. They must be followed by a comma-separated list of entries. |
| 165 |
.PP |
| 166 |
.TP 8 |
| 167 |
.B "\+fp \fRor\fP fp\+" |
| 168 |
This \fB\+fp\fP and \fBfp\+\fP options prepend and append elements to the |
| 169 |
current font path, respectively. They must be followed by a comma-separated |
| 170 |
list of entries. |
| 171 |
.PP |
| 172 |
.TP 8 |
| 173 |
.B led |
| 174 |
The \fBled\fP option controls the keyboard LEDs. |
| 175 |
This controls the turning on or off of one or all of the LEDs. |
| 176 |
It accepts an optional integer, a preceding dash(-) or an 'on/off' flag. |
| 177 |
If no parameter or the 'on' flag is given, all LEDs are turned on. |
| 178 |
If a preceding dash or the flag 'off' is given, all LEDs are turned off. |
| 179 |
If a value between 1 and 32 is given, that LED will be turned on or off |
| 180 |
depending on the existence of a preceding dash. |
| 181 |
``xset led 3'' would turn led #3 on. ``xset -led 3'' would turn it off. |
| 182 |
The particular LED values may refer to different LEDs on different |
| 183 |
hardware. |
| 184 |
If the X server supports the XKEYBOARD (XKB) extension, leds may be |
| 185 |
referenced by the XKB indicator name by specifying the `named' keyword |
| 186 |
and the indicator name. For example, to turn on the Scroll Lock LED: |
| 187 |
.IP |
| 188 |
xset led named "Scroll Lock" |
| 189 |
.PP |
| 190 |
.TP 8 |
| 191 |
.B mouse |
| 192 |
The \fBm\fP option controls the mouse parameters; it may be |
| 193 |
abbreviated to 'm'. Of course, it applies to most pointing devices, not just |
| 194 |
mice. The parameters for the pointing device are `acceleration' and |
| 195 |
`threshold'. The acceleration can be specified as an integer, or as a simple |
| 196 |
fraction. Threshold is just an integer. The setting is applied to all connected |
| 197 |
pointing devices. xinput(1) should be used if you need device-specific settings. |
| 198 |
.PP |
| 199 |
By default the pointer (the on-screen representation of the pointing device) |
| 200 |
will go `acceleration' times as fast when the device travels more than |
| 201 |
`threshold' mickeys (i.e. would-be pixels) in 10 ms, including a small |
| 202 |
transition range. This way, the pointing device can be used for precise |
| 203 |
alignment when it is moved slowly, yet it can be set to travel across |
| 204 |
the screen in a flick of the wrist when desired. One or both |
| 205 |
parameters for the |
| 206 |
.B m |
| 207 |
option can be omitted, but if only one is |
| 208 |
given, it will be interpreted as the acceleration. |
| 209 |
If no parameters or the flag 'default' is used, the system defaults will |
| 210 |
be set. |
| 211 |
.PP |
| 212 |
If the `threshold' parameter is provided and 0, the `acceleration' |
| 213 |
parameter will be used in the exponent of a more natural and continuous |
| 214 |
formula, giving precise control for slow motion but big reach for fast |
| 215 |
motion, and a progressive transition for motions in between. |
| 216 |
Recommended `acceleration' value in this case is 3/2 to 3, but not |
| 217 |
limited to that range. |
| 218 |
.PP |
| 219 |
In the X.org X Server 1.6 and above, the behaviour described so far is linked |
| 220 |
to the default profile. There are other profiles (i.e. functions determining |
| 221 |
pointer acceleration from device velocity) and additional settings, so the |
| 222 |
above description may not apply to non-default cases. In the X.org Server 1.7, |
| 223 |
these are available as input device properties (see xinput). |
| 224 |
|
| 225 |
.PP |
| 226 |
.TP 8 |
| 227 |
.B p |
| 228 |
The \fBp\fP option controls pixel color values. |
| 229 |
The parameters are the color map entry number in decimal, |
| 230 |
and a color specification. The root background colors may be changed |
| 231 |
on some servers by altering the entries for BlackPixel and WhitePixel. |
| 232 |
Although these are often 0 and 1, they need not be. Also, a server may |
| 233 |
choose to allocate those colors privately, in which case an error will |
| 234 |
be generated. The map entry must not be a read-only color, |
| 235 |
or an error will result. |
| 236 |
.PP |
| 237 |
.TP 8 |
| 238 |
.B r |
| 239 |
The \fBr\fP option controls the autorepeat. |
| 240 |
Invoking with "\fB-r\fP", or "\fBr\ off\fP", will disable autorepeat, whereas |
| 241 |
"\fBr\fP", or "\fBr\ on\fP" will enable autorepeat. |
| 242 |
Following the "\fB-r\fP" or "\fBr\fP" option with an integer keycode between 0 and |
| 243 |
255 will disable or enable autorepeat on that key respectively, but only |
| 244 |
if it makes sense for the particular keycode. Keycodes below 8 are |
| 245 |
not typically valid for this command. Example: "\fBxset\ -r\ 10\fP" will |
| 246 |
disable autorepeat for the "1" key on the top row of an IBM PC keyboard. |
| 247 |
|
| 248 |
If the server supports the XFree86-Misc extension, or the XKB extension, |
| 249 |
then a parameter |
| 250 |
of 'rate' is accepted and should be followed by zero, one or two numeric |
| 251 |
values. The first specifies the delay before autorepeat starts and |
| 252 |
the second specifies the repeat rate. In the case that the server |
| 253 |
supports the XKB extension, the delay is the number of milliseconds |
| 254 |
before autorepeat starts, and the rate is the number of repeats |
| 255 |
per second. If the rate or delay is not given, it will be set |
| 256 |
to the default value. |
| 257 |
.PP |
| 258 |
.TP 8 |
| 259 |
.B s |
| 260 |
The \fBs\fP option lets you set the screen saver parameters. |
| 261 |
This option accepts up to two numerical parameters, a 'blank/noblank' |
| 262 |
flag, an 'expose/noexpose' flag, an 'on/off' flag, an 'activate/reset' flag, |
| 263 |
or the 'default' flag. |
| 264 |
If no parameters or the 'default' flag is used, the system will be set |
| 265 |
to its default screen saver characteristics. |
| 266 |
The 'on/off' flags simply turn the screen saver functions on or off. |
| 267 |
The 'activate' flag forces activation of screen saver even if the screen |
| 268 |
saver had been turned off. |
| 269 |
The 'reset' flag forces deactivation of screen saver if it is active. |
| 270 |
The 'blank' flag sets the |
| 271 |
preference to blank the video (if the hardware can do so) rather than |
| 272 |
display a background pattern, while 'noblank' sets the |
| 273 |
preference to display a pattern rather than blank the video. |
| 274 |
The 'expose' flag sets the |
| 275 |
preference to allow window exposures (the server can freely discard |
| 276 |
window contents), while 'noexpose' sets the preference to disable |
| 277 |
screen saver unless the server can regenerate the screens without |
| 278 |
causing exposure events. |
| 279 |
The length and period |
| 280 |
parameters for the screen saver function determines how long the |
| 281 |
server must be inactive for screen saving to activate, and the period |
| 282 |
to change the background pattern to avoid burn in. |
| 283 |
The arguments are specified in seconds. |
| 284 |
If only one numerical parameter is given, it will be used for the length. |
| 285 |
.PP |
| 286 |
.TP 8 |
| 287 |
.B q |
| 288 |
The \fBq\fP option gives you information on the current settings. |
| 289 |
.PP |
| 290 |
.TP 8 |
| 291 |
.B -version |
| 292 |
The \fB-version\fP option prints the program version and exits without |
| 293 |
doing anything else. |
| 294 |
.PP |
| 295 |
These settings will be reset to default values when you log out. |
| 296 |
.PP |
| 297 |
Note that not all X implementations are guaranteed to honor all of these |
| 298 |
options. |
| 299 |
.SH "SEE ALSO" |
| 300 |
X(7), Xserver(1), xmodmap(1), xrdb(1), xsetroot(1), xinput(1) |
| 301 |
.SH AUTHOR |
| 302 |
Bob Scheifler, MIT Laboratory for Computer Science |
| 303 |
.br |
| 304 |
David Krikorian, MIT Project Athena (X11 version) |
| 305 |
.br |
| 306 |
XFree86-Misc support added by David Dawes and Joe Moss |
| 307 |
.br |
| 308 |
Manpage updates added by Mike A. Harris <[email protected]> |