1
.\" $Xorg: xset.man,v 1.4 2001/02/09 02:05:59 xorgcvs Exp $
2
.\" Copyright 1988, 1998 The Open Group
4
.\" Permission to use, copy, modify, distribute, and sell this software and its
5
.\" documentation for any purpose is hereby granted without fee, provided that
6
.\" the above copyright notice appear in all copies and that both that
7
.\" copyright notice and this permission notice appear in supporting
10
.\" The above copyright notice and this permission notice shall be included
11
.\" in all copies or substantial portions of the Software.
13
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
14
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
15
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
16
.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
17
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
18
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
19
.\" OTHER DEALINGS IN THE SOFTWARE.
21
.\" Except as contained in this notice, the name of The Open Group shall
22
.\" not be used in advertising or otherwise to promote the sale, use or
23
.\" other dealings in this Software without prior written authorization
24
.\" from The Open Group.
26
.\" $XFree86: xc/programs/xset/xset.man,v 3.14 2001/12/14 20:02:22 dawes Exp $
28
.TH XSET 1 __xorgversion__
30
xset - user preference utility for X
33
[-display \fIdisplay\fP]
35
[-b] [b {on|off}] [b [\fIvolume\fP [\fIpitch\fP [\fIduration\fP]]]]
39
[-c] [c {on|off}] [c [\fIvolume\fP]]
43
[dpms \fIstandby\fP [\fI suspend\fP [\fI off\fP]]]
44
[dpms force {standby|suspend|off|on}]
52
[fp default] [fp rehash]
54
[-led [\fIinteger\fP]]
55
[+led [\fIinteger\fP]]
59
[mouse [\fIaccel_mult\fP[/\fIaccel_div\fP] [\fIthreshold\fP]]] [mouse default]
61
[p \fIpixel\fP \fIcolor\fP]
63
[-r [keycode]] [r [keycode]]
64
[r {on|off}] [r rate \fIdelay\fP [\fIrate\fP]]
66
[s [\fIlength\fP [\fIperiod\fP]]] [s {blank|noblank}]
67
[s {expose|noexpose}] [s {on|off}] [s default] [s activate] [s reset]
71
This program is used to set various user preference options of the display.
75
.B \-display \fIdisplay\fP
76
This option specifies the server to use; see \fIX(__miscmansuffix__)\fP.
80
The \fBb\fP option controls bell volume, pitch and duration.
81
This option accepts up to three numerical parameters, a preceding
82
dash(-), or a 'on/off' flag. If no parameters are
83
given, or the 'on' flag is used, the system defaults will be used.
84
If the dash or 'off' are given, the bell will be turned
86
If only one numerical parameter is given, the
87
bell volume will be set to that value, as a percentage of its maximum.
88
Likewise, the second numerical
89
parameter specifies the bell pitch, in hertz, and
90
the third numerical parameter
91
specifies the duration in milliseconds. Note that not
92
all hardware can vary the bell characteristics. The X server will set
93
the characteristics of the bell as closely as it can to the user's
98
The \fBbc\fP option controls \fIbug compatibility\fP mode in the server,
99
if possible; a preceding dash(-) disables the mode, otherwise the mode
100
is enabled. Various pre-R4 clients pass illegal values in some
101
protocol requests, and pre-R4 servers did not correctly generate
102
errors in these cases. Such clients, when run against an R4 server,
103
will terminate abnormally or otherwise fail to operate correctly.
104
Bug compatibility mode explicitly reintroduces certain bugs into the
105
X server, so that many such clients can still be run. This mode should be
106
used with care; new application development should be done with this mode
107
disabled. The server must support the MIT-SUNDRY-NONSTANDARD
108
protocol extension in order for this option to work.
111
The \fBc\fP option controls key click.
112
This option can take an optional value, a preceding dash(-),
114
If no parameter or the 'on' flag is given, the system defaults
115
will be used. If the dash or 'off' flag is used, keyclick will be
117
If a value from 0 to 100 is given, it is used to
118
indicate volume, as a percentage of the maximum.
119
The X server will set
120
the volume to the nearest value that the hardware can support.
124
The \fB\-dpms\fP option disables DPMS (Energy Star) features.
127
The \fB+dpms\fP option enables DPMS (Energy Star) features.
129
.B dpms \fIflags...\fP
130
The \fBdpms\fP option allows the DPMS (Energy Star) parameters to be
131
set. The option can take up to three numerical values, or the `force'
132
flag followed by a DPMS state. The `force' flags forces the server
133
to immediately switch to the DPMS state specified. The DPMS state can
134
be one of `standby', `suspend', `off', or `on'. When numerical values are
135
given, they set the inactivity period
136
(in units of seconds)
137
before the three modes are activated.
138
The first value given is for the `standby' mode, the second is for the
139
`suspend' mode, and the third is for the `off' mode. Setting these
140
values implicitly enables the DPMS features. A value of zero disables
143
.B fp= \fIpath,...\fP
144
The \fBfp=\fP sets the font path to the entries given in the path argument.
145
The entries are interpreted by the server, not by the client.
146
Typically they are directory names or font server names, but the
147
interpretation is server-dependent.
150
The \fBdefault\fP argument causes the font path to be reset to the server's
154
The \fBrehash\fP argument resets the font path to its current value,
155
causing the server to reread the font databases in
156
the current font path. This is generally only used when adding new fonts to
157
a font directory (after running \fImkfontdir\fP to recreate the font database).
160
.B "\-fp \fRor\fP fp\-"
161
The \fB\-fp\fP and \fBfp\-\fP options remove elements from the current
162
font path. They must be followed by a comma-separated list of entries.
165
.B "\+fp \fRor\fP fp\+"
166
This \fB\+fp\fP and \fBfp\+\fP options prepend and append elements to the
167
current font path, respectively. They must be followed by a comma-separated
172
The \fBled\fP option controls the keyboard LEDs.
173
This controls the turning on or off of one or all of the LEDs.
174
It accepts an optional integer, a preceding dash(-) or an 'on/off' flag.
175
If no parameter or the 'on' flag is given, all LEDs are turned on.
176
If a preceding dash or the flag 'off' is given, all LEDs are turned off.
177
If a value between 1 and 32 is given, that LED will be turned on or off
178
depending on the existence of a preceding dash.
179
A common LED which can be controlled is the ``Caps Lock'' LED. ``xset
180
led 3'' would turn led #3 on. ``xset -led 3'' would turn it off.
181
The particular LED values may refer to different LEDs on different
186
The \fBm\fP option controls the mouse parameters; it may be
188
The parameters for the mouse are `acceleration' and `threshold'.
189
The acceleration can be specified as an integer, or as a simple
191
The mouse, or whatever pointer the machine is connected to,
192
will go `acceleration' times as fast when it travels more than `threshold'
193
pixels in a short time. This way, the mouse can be used for precise
194
alignment when it is moved slowly, yet it can be set to travel across
195
the screen in a flick of the wrist when desired. One or both
198
option can be omitted, but if only one is
199
given, it will be interpreted as the acceleration.
200
If no parameters or the flag 'default' is used, the system defaults will
205
The \fBp\fP option controls pixel color values.
206
The parameters are the color map entry number in decimal,
207
and a color specification. The root background colors may be changed
208
on some servers by altering the entries for BlackPixel and WhitePixel.
209
Although these are often 0 and 1, they need not be. Also, a server may
210
choose to allocate those colors privately, in which case an error will
211
be generated. The map entry must not be a read-only color,
212
or an error will result.
216
The \fBr\fP option controls the autorepeat.
217
Invoking with "\fB-r\fP", or "\fBr\ off\fP", will disable autorepeat, whereas
218
"\fBr\fP", or "\fBr\ on\fP" will enable autorepeat.
219
Following the "\fB-r\fP" or "\fBr\fP" option with an integer keycode between 0 and
220
255 will disable or enable autorepeat on that key respectively, but only
221
if it makes sense for the particular keycode. Keycodes below 8 are
222
not typically valid for this command. Example: "\fBxset\ -r\ 10\fP" will
223
disable autorepeat for the "1" key on the top row of an IBM PC keyboard.
225
If the server supports the XFree86-Misc extension, or the XKB extension,
227
of 'rate' is accepted and should be followed by zero, one or two numeric
228
values. The first specifies the delay before autorepeat starts and
229
the second specifies the repeat rate. In the case that the server
230
supports the XKB extension, the delay is the number of milliseconds
231
before autorepeat starts, and the rate is the number of repeats
232
per second. If the rate or delay is not given, it will be set
233
to the default value.
237
The \fBs\fP option lets you set the screen saver parameters.
238
This option accepts up to two numerical parameters, a 'blank/noblank'
239
flag, an 'expose/noexpose' flag, an 'on/off' flag, an 'activate/reset' flag,
240
or the 'default' flag.
241
If no parameters or the 'default' flag is used, the system will be set
242
to its default screen saver characteristics.
243
The 'on/off' flags simply turn the screen saver functions on or off.
244
The 'activate' flag forces activation of screen saver even if the screen
245
saver had been turned off.
246
The 'reset' flag forces deactivation of screen saver if it is active.
247
The 'blank' flag sets the
248
preference to blank the video (if the hardware can do so) rather than
249
display a background pattern, while 'noblank' sets the
250
preference to display a pattern rather than blank the video.
251
The 'expose' flag sets the
252
preference to allow window exposures (the server can freely discard
253
window contents), while 'noexpose' sets the preference to disable
254
screen saver unless the server can regenerate the screens without
255
causing exposure events.
256
The length and period
257
parameters for the screen saver function determines how long the
258
server must be inactive for screen saving to activate, and the period
259
to change the background pattern to avoid burn in.
260
The arguments are specified in seconds.
261
If only one numerical parameter is given, it will be used for the length.
265
The \fBq\fP option gives you information on the current settings.
267
These settings will be reset to default values when you log out.
269
Note that not all X implementations are guaranteed to honor all of these
272
X(__miscmansuffix__), Xserver(1), xmodmap(1), xrdb(1), xsetroot(1)
274
Bob Scheifler, MIT Laboratory for Computer Science
276
David Krikorian, MIT Project Athena (X11 version)
278
XFree86-Misc support added by David Dawes and Joe Moss
280
Manpage updates added by Mike A. Harris <mharris@redhat.com>
added
removed
xset/xset.man
