xset/man/xset.man

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