2
.\" $Xorg: xrdb.man,v 1.4 2001/02/09 02:05:56 xorgcvs Exp $
3
.\" Copyright 1991, Digital Equipment Corporation.
4
.\" Copyright 1991, 1994, 1998 The Open Group
6
.\" Permission to use, copy, modify, distribute, and sell this software and its
7
.\" documentation for any purpose is hereby granted without fee, provided that
8
.\" the above copyright notice appear in all copies and that both that
9
.\" copyright notice and this permission notice appear in supporting
12
.\" The above copyright notice and this permission notice shall be included
13
.\" in all copies or substantial portions of the Software.
15
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
16
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18
.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
19
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21
.\" OTHER DEALINGS IN THE SOFTWARE.
23
.\" Except as contained in this notice, the name of The Open Group shall
24
.\" not be used in advertising or otherwise to promote the sale, use or
25
.\" other dealings in this Software without prior written authorization
26
.\" from The Open Group.
28
.\" $XFree86: xc/programs/xrdb/xrdb.man,v 1.7 2001/01/27 18:21:22 dawes Exp $
30
.TH XRDB 1 __xorgversion__
32
xrdb - X server resource database utility
35
[-option ...] [\fIfilename\fP]
38
is used to get or set the contents of the RESOURCE_MANAGER property
39
on the root window of screen 0, or the SCREEN_RESOURCES property on
40
the root window of any or all screens, or everything combined.
41
You would normally run this program from your X startup file.
43
Most X clients use the RESOURCE_MANAGER and SCREEN_RESOURCES properties to
44
get user preferences about
45
color, fonts, and so on for applications. Having this information in
46
the server (where it is available to all clients) instead of on disk,
47
solves the problem in previous versions of X that required you to
48
maintain \fIdefaults\fP files on every machine that you might use.
49
It also allows for dynamic changing of defaults without editing files.
51
The RESOURCE_MANAGER property is used for resources that apply to all
52
screens of the display. The SCREEN_RESOURCES property on each screen
53
specifies additional (or overriding) resources to be used for that screen.
54
(When there is only one screen, SCREEN_RESOURCES is normally not used,
55
all resources are just placed in the RESOURCE_MANAGER property.)
59
(or the contents from standard input if - or no filename is given)
60
is optionally passed through the C preprocessor with the
61
following symbols defined, based on the capabilities of the server
64
.B SERVERHOST=\fIhostname\fP
65
the hostname portion of the display to which you are connected.
68
the SERVERHOST hostname string turned into a legal identifier.
69
For example, "my-dpy.lcs.mit.edu" becomes SRVR_my_dpy_lcs_mit_edu.
71
.B HOST=\fIhostname\fP
75
.B DISPLAY_NUM=\fInum\fP
76
the number of the display on the server host.
78
.B CLIENTHOST=\fIhostname\fP
79
the name of the host on which
84
the CLIENTHOST hostname string turned into a legal identifier.
85
For example, "expo.lcs.mit.edu" becomes CLNT_expo_lcs_mit_edu.
88
the vendor release number for the server. The interpretation of this
89
number will vary depending on VENDOR.
92
the X protocol minor version supported by this server (currently 0).
95
the X protocol major version supported by this server (should always be 11).
97
.B VENDOR="\fIvendor\fP"
98
a string literal specifying the vendor of the server.
101
the VENDOR name string turned into a legal identifier.
102
For example, "MIT X Consortium" becomes VNDR_MIT_X_Consortium.
105
A symbol is defined for each protocol extension supported by the server.
106
Each extension string name is turned into a legal identifier.
107
For example, "X3D-PEX" becomes EXT_X3D_PEX.
109
.B NUM_SCREENS=\fInum\fP
110
the total number of screens.
112
.B SCREEN_NUM=\fInum\fP
113
the number of the current screen (from zero).
115
.B BITS_PER_RGB=\fInum\fP
116
the number of significant bits in an RGB color specification. This is the
117
log base 2 of the number of distinct shades of each primary that the hardware
118
can generate. Note that it usually is not related to PLANES.
120
.B CLASS=\fIvisualclass\fP
121
one of StaticGray, GrayScale, StaticColor, PseudoColor, TrueColor,
122
DirectColor. This is the visual class of the root window.
124
.B CLASS_\fIvisualclass\fP=\fIvisualid\fP
125
the visual class of the root window in a form you can \fI#ifdef\fP on.
126
The value is the numeric id of the visual.
129
defined only if CLASS is one of StaticColor, PseudoColor, TrueColor, or
132
.B CLASS_\fIvisualclass\fP_\fIdepth\fP=\fInum\fP
133
A symbol is defined for each visual supported for the screen.
134
The symbol includes the class of the visual and its depth;
135
the value is the numeric id of the visual.
136
(If more than one visual has the same class and depth, the numeric id
137
of the first one reported by the server is used.)
140
the height of the root window in pixels.
143
the width of the root window in pixels.
146
the number of bit planes (the depth) of the root window.
148
.B X_RESOLUTION=\fInum\fP
149
the x resolution of the screen in pixels per meter.
151
.B Y_RESOLUTION=\fInum\fP
152
the y resolution of the screen in pixels per meter.
154
SRVR_\fIname\fP, CLNT_\fIname\fP, VNDR_\fIname\fP, and EXT_\fIname\fP
155
identifiers are formed by changing all characters other than letters
156
and digits into underscores (_).
158
Lines that begin with an exclamation mark (!) are ignored and may
163
can read from standard input, it can be used to
164
the change the contents of properties directly from
165
a terminal or from a shell script.
169
program accepts the following options:
172
This option (or any unsupported option) will cause a brief description of
173
the allowable options and parameters to be printed.
175
.B \-display \fIdisplay\fP
176
This option specifies the X server to be used; see \fIX(__miscmansuffix__)\fP.
177
It also specifies the screen to use for the \fI-screen\fP option,
178
and it specifies the screen from which preprocessor symbols are
179
derived for the \fI-global\fP option.
182
This option indicates that operation should be performed on the
183
screen-independent resource property (RESOURCE_MANAGER), as well as
184
the screen-specific property (SCREEN_RESOURCES) on every screen of the
185
display. For example, when used in conjunction with \fI-query\fP,
186
the contents of all properties are output. For \fI-load\fP, \fI-override\fP
188
the input file is processed once for each screen. The resources which occur
189
in common in the output for every screen are collected, and these are applied
190
as the screen-independent resources. The remaining resources are applied
191
for each individual per-screen property. This the default mode of operation.
194
This option indicates that the operation should only be performed on
195
the screen-independent RESOURCE_MANAGER property.
198
This option indicates that the operation should only be performed on
199
the SCREEN_RESOURCES property of the default screen of the display.
202
This option indicates that the operation should be performed on
203
the SCREEN_RESOURCES property of each screen of the display.
204
For \fI-load\fP, \fI-override\fP and \fI-merge\fP, the input file is
205
processed for each screen.
208
This option indicates that changes to the specified properties (when used with
209
\fI-load\fP, \fI-override\fP or \fI-merge\fP)
210
or to the resource file (when used with \fI-edit\fP) should be shown on the
211
standard output, but should not be performed.
214
This option indicates that warning about duplicate entries should not be
217
.B -cpp \fIfilename\fP
218
This option specifies the pathname of the C preprocessor program to be used.
221
was designed to use CPP, any program that acts as a filter
222
and accepts the -D, -I, and -U options may be used.
225
This option indicates that
227
should not run the input file through a preprocessor before loading it
231
This option indicates that the symbols that are defined for the preprocessor
232
should be printed onto the standard output.
235
This option indicates that the current contents of the specified
236
properties should be printed onto the standard output. Note that since
237
preprocessor commands in the input resource file are part of the input
238
file, not part of the property, they won't appear in the output from this
241
option can be used to merge the contents of properties back into the input
242
resource file without damaging preprocessor commands.
245
This option indicates that the input should be loaded as the new value
246
of the specified properties, replacing whatever was there (i.e.
247
the old contents are removed). This is the default action.
250
This option indicates that the input should be added to, instead of
251
replacing, the current contents of the specified properties.
252
New entries override previous entries.
255
This option indicates that the input should be merged and lexicographically
256
sorted with, instead of replacing, the current contents of the specified
260
This option indicates that the specified properties should be removed
264
This option indicates that the server should be instructed not to reset if
265
\fIxrdb\fP is the first client. This should never be necessary under normal
266
conditions, since \fIxdm\fP and \fIxinit\fP always act as the first client.
268
.B \-edit \fIfilename\fP
269
This option indicates that the contents of the specified properties
270
should be edited into the given file, replacing any values already listed
271
there. This allows you to put changes that you have made to your defaults
272
back into your resource file, preserving any comments or preprocessor lines.
274
.B \-backup \fIstring\fP
275
This option specifies a suffix to be appended to the filename used with
277
to generate a backup file.
279
.B \-D\fIname[=value]\fP
280
This option is passed through to the preprocessor and is used to define
281
symbols for use with conditionals such as
285
This option is passed through to the preprocessor and is used to remove
286
any definitions of this symbol.
288
.B \-I\fIdirectory\fP
289
This option is passed through to the preprocessor and is used to specify
290
a directory to search for files that are referenced with
293
Generalizes \fI~/.Xdefaults\fP files.
295
X(__miscmansuffix__), appres(__appmansuffix__), listres(__appmansuffix__),
296
Xlib Resource Manager documentation, Xt resource documentation
300
to figure out which display to use.
303
The default for no arguments should be to query, not to overwrite, so that
304
it is consistent with other programs.
306
Bob Scheifler, Phil Karlton, rewritten from the original by Jim Gettys
added
removed
xrdb/xrdb.man
