X.man 51 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285
  1. .\" t
  2. .\"
  3. .\" Copyright (c) 1994, 2004 The Open Group
  4. .\" Copyright \(co 2000 The XFree86 Project, Inc.
  5. .\"
  6. .\" All rights reserved.
  7. .\"
  8. .\" Permission is hereby granted, free of charge, to any person obtaining a
  9. .\" copy of this software and associated documentation files (the
  10. .\" "Software"), to deal in the Software without restriction, including
  11. .\" without limitation the rights to use, copy, modify, merge, publish,
  12. .\" distribute, and/or sell copies of the Software, and to permit persons
  13. .\" to whom the Software is furnished to do so, provided that the above
  14. .\" copyright notice(s) and this permission notice appear in all copies of
  15. .\" the Software and that both the above copyright notice(s) and this
  16. .\" permission notice appear in supporting documentation.
  17. .\"
  18. .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19. .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20. .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
  21. .\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  22. .\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
  23. .\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
  24. .\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
  25. .\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
  26. .\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  27. .\"
  28. .\" Except as contained in this notice, the name of a copyright holder
  29. .\" shall not be used in advertising or otherwise to promote the sale, use
  30. .\" or other dealings in this Software without prior written authorization
  31. .\" of the copyright holder.
  32. .\"
  33. .\" X Window System is a trademark of The Open Group.
  34. .\"
  35. .TH X __miscmansuffix__ __vendorversion__
  36. .SH NAME
  37. X \- a portable, network-transparent window system
  38. .SH OVERVIEW
  39. .PP
  40. The X Window System is a network transparent window system which runs
  41. on a wide range of computing and graphics machines. It should be
  42. relatively straightforward to build the X.Org Foundation software
  43. distribution on most ANSI C and POSIX compliant systems. Commercial
  44. implementations are also available for a wide range of platforms.
  45. .PP
  46. The X.Org Foundation requests that the following names be used when
  47. referring to this software:
  48. .sp
  49. .TS
  50. center;
  51. c.
  52. X
  53. X Window System
  54. X Version 11
  55. X Window System, Version 11
  56. X11
  57. .TE
  58. .sp
  59. .I "X Window System"
  60. is a trademark of The Open Group.
  61. .SH DESCRIPTION
  62. X Window System servers run on computers with bitmap displays.
  63. The server distributes user input to and accepts output requests from various
  64. client programs through a variety of different interprocess
  65. communication channels. Although the most common case is for the client
  66. programs to be
  67. running on the same machine as the server, clients can be run transparently
  68. from other machines (including machines with different architectures and
  69. operating systems) as well.
  70. .PP
  71. X supports overlapping hierarchical subwindows and text and
  72. graphics operations, on both monochrome and color
  73. displays.
  74. For a full explanation of the functions that are available, see
  75. the \fIXlib - C Language X Interface\fP manual,
  76. the \fIX Window System Protocol\fP specification,
  77. the \fIX Toolkit Intrinsics - C Language Interface\fP manual,
  78. and various toolkit documents.
  79. .PP
  80. The number of programs that use \fIX\fP is quite large.
  81. Programs provided in the core X.Org Foundation distribution include:
  82. a terminal emulator, \fIxterm\fP;
  83. a window manager, \fItwm\fP;
  84. a display manager, \fIxdm\fP;
  85. a console redirect program, \fIxconsole\fP;
  86. a bitmap editor, \fIbitmap\fP;
  87. resource listing/manipulation tools, \fIappres\fP, \fIeditres\fP;
  88. access control programs, \fIxauth\fP, \fIxhost\fP, and \fIiceauth\fP;
  89. user preference setting programs, \fIxrdb\fP, \fIxcmsdb\fP,
  90. \fIxset\fP, \fIxsetroot\fP, \fIxstdcmap\fP, and \fIxmodmap\fP;
  91. clocks, \fIxclock\fP and \fIoclock\fP;
  92. a font displayer, \fIxfd\fP;
  93. utilities for listing information about fonts, windows, and displays,
  94. \fIxlsfonts\fP, \fIxwininfo\fP, \fIxlsclients\fP,
  95. \fIxdpyinfo\fP, \fIxlsatoms\fP, and \fIxprop\fP;
  96. screen image manipulation utilities, \fIxwd\fP, \fIxwud\fP, and \fIxmag\fP;
  97. a performance measurement utility, \fIx11perf\fP;
  98. a font compiler, \fIbdftopcf\fP;
  99. a font server and related utilities, \fIxfs\fP, \fIfsinfo\fP, \fIfslsfonts\fP, \fIfstobdf\fP;
  100. a display server and related utilities, \fIXserver\fP, \fIrgb\fP, \fImkfontdir\fP;
  101. a clipboard manager, \fIxclipboard\fP;
  102. keyboard description compiler and related utilities, \fIxkbcomp\fP, \fIsetxkbmap\fP
  103. \fIxkbprint\fP, \fIxkbbell\fP, \fIxkbevd\fP, \fIxkbvleds\fP, and \fIxkbwatch\fP;
  104. a utility to terminate clients, \fIxkill\fP;
  105. a firewall security proxy, \fIxfwp\fP;
  106. and a utility to cause part or all of the screen to be redrawn, \fIxrefresh\fP.
  107. .PP
  108. Many other utilities, window managers, games, toolkits, etc. are included
  109. as user-contributed software in the X.Org Foundation distribution, or are
  110. available on the Internet.
  111. See your site administrator for details.
  112. .SH "STARTING UP"
  113. .PP
  114. There are two main ways of getting the X server and an initial set of
  115. client applications started. The particular method used depends on what
  116. operating system you are running and whether or not you use other window
  117. systems in addition to X.
  118. .TP 8
  119. .B "Display Manager"
  120. If you want to always have X running on your display, your site administrator
  121. can set your machine up to use a Display Manager such as \fIxdm\fP, \fIgdm\fP,
  122. or \fIkdm\fP. This program
  123. is typically started by the system at boot time and takes care of keeping the
  124. server running and getting users logged in. If you are running one of these
  125. display managers, you will normally see a window on the screen welcoming you
  126. to the system and asking for your login information. Simply type them in as
  127. you would at a normal terminal. If you make a mistake, the display manager
  128. will display an error message and ask you to try again. After you
  129. have successfully logged in, the display manager will start up your X
  130. environment. The documentation for the display manager you use can provide
  131. more details.
  132. .TP 8
  133. .B "\fIxinit\fP (run manually from the shell)"
  134. Sites that support more than one window system might choose to use the
  135. \fIxinit\fP program for starting X manually. If this is true for your
  136. machine, your site administrator will probably have provided a program
  137. named "x11", "startx", or "xstart" that will do site-specific initialization
  138. (such as loading convenient default resources, running a window manager,
  139. displaying a clock, and starting several terminal emulators) in a nice
  140. way. If not, you can build such a script using the \fIxinit\fP program.
  141. This utility simply runs one user-specified program to start the server,
  142. runs another to start up any desired clients, and then waits for either to
  143. finish. Since either or both of the user-specified programs may be a shell
  144. script, this gives substantial flexibility at the expense of a
  145. nice interface. For this reason, \fIxinit\fP is not intended for end users.
  146. .SH "DISPLAY NAMES"
  147. .PP
  148. From the user's perspective, every X server has a \fIdisplay name\fP of the
  149. form:
  150. .sp
  151. .RS
  152. \fIhostname:displaynumber.screennumber\fP
  153. .RE
  154. .sp
  155. This information is used by the application to determine how it should
  156. connect to the server and which screen it should use by default
  157. (on displays with multiple monitors):
  158. .TP 8
  159. .I hostname
  160. The \fIhostname\fP specifies the name of the machine to which the display is
  161. physically connected. If the hostname is not given, the most efficient way of
  162. communicating to a server on the same machine will be used.
  163. .TP 8
  164. .I displaynumber
  165. The phrase "display" is usually used to refer to a collection of monitors that
  166. share a common set of input devices (keyboard, mouse, tablet, etc.).
  167. Most workstations tend to only have one display. Larger, multi-user
  168. systems, however, frequently have several displays so that more than
  169. one person can be doing graphics work at once. To avoid confusion, each
  170. display on a machine is assigned a \fIdisplay number\fP (beginning at 0)
  171. when the X server for that display is started. The display number must always
  172. be given in a display name.
  173. .TP 8
  174. .I screennumber
  175. Some displays share their input devices among two or more monitors.
  176. These may be configured as a single logical screen, which allows windows to
  177. move across screens, or as individual screens, each with their own set of
  178. windows. If configured such that each monitor has its own set of windows,
  179. each screen is assigned a
  180. \fIscreen number\fP (beginning at 0) when the X server for that display is
  181. started. If the screen number is not given, screen 0 will be used.
  182. .PP
  183. On POSIX systems, the default display name is stored
  184. in your DISPLAY environment variable. This variable is set automatically
  185. by the \fIxterm\fP terminal emulator. However, when you log into another
  186. machine on a network, you may need to set DISPLAY by hand to point to your
  187. display. For example,
  188. .PP
  189. .nf
  190. % setenv DISPLAY myws:0
  191. $ DISPLAY=myws:0; export DISPLAY
  192. .fi
  193. .PP
  194. The \fIssh\fP program can be used to start an X program on a remote machine;
  195. it automatically sets the DISPLAY variable correctly.
  196. .PP
  197. Finally, most X programs accept a command line option of
  198. \fB\-display \fIdisplayname\fR to temporarily override the contents of
  199. DISPLAY. This is most commonly used to pop windows on another person's
  200. screen or as part of a "remote shell" command to start an xterm pointing back
  201. to your display. For example,
  202. .sp
  203. .nf
  204. % xeyes \-display joesws:0 \-geometry 1000x1000+0+0
  205. % rsh big xterm \-display myws:0 \-ls </dev/null &
  206. .fi
  207. .PP
  208. X servers listen for connections on a variety of different
  209. communications channels (network byte streams, shared memory, etc.).
  210. Since there can be more than one way of contacting a given server,
  211. The \fIhostname\fP part of the display name is used to determine the
  212. type of channel
  213. (also called a transport layer) to be used. X servers generally
  214. support the following types of connections:
  215. .TP 8
  216. .I "local"
  217. .br
  218. The hostname part of the display name should be the empty string.
  219. For example: \fI:0\fP, \fI:1\fP, and \fI:0.1\fP. The most efficient
  220. local transport will be chosen.
  221. .TP 8
  222. .I TCP\/IP
  223. .br
  224. The hostname part of the display name should be the server machine's
  225. hostname or IP address. Full Internet names, abbreviated names, IPv4
  226. addresses, and IPv6 addresses are all allowed. For example:
  227. \fIx.org:0\fP, \fIexpo:0\fP, \fI[::1]:0\fP,
  228. \fI198.112.45.11:0\fP, \fIbigmachine:1\fP, and \fIhydra:0.1\fP.
  229. .PP
  230. .SH "ACCESS CONTROL"
  231. An X server can use several types of access control. Mechanisms provided
  232. in Release 7 are:
  233. .TS
  234. l l.
  235. Host Access Simple host-based access control.
  236. MIT\-MAGIC\-COOKIE\-1 Shared plain-text "cookies".
  237. XDM\-AUTHORIZATION\-1 Secure DES based private-keys.
  238. SUN\-DES\-1 Based on Sun's secure rpc system.
  239. Server Interpreted Server-dependent methods of access control
  240. .TE
  241. .PP
  242. \fIXdm\fP initializes access control for the server and also places
  243. authorization information in a file accessible to the user.
  244. .PP
  245. Normally, the list of hosts from
  246. which connections are always accepted should be empty, so that only clients
  247. with are explicitly authorized can connect to the display. When you add
  248. entries to the host list (with \fIxhost\fP), the server no longer performs any
  249. authorization on connections from those machines. Be careful with this.
  250. .PP
  251. The file from which \fIXlib\fP extracts authorization data can be
  252. specified with the environment variable \fBXAUTHORITY\fP, and defaults to
  253. the file \fB.Xauthority\fP in the home directory. \fIXdm\fP uses
  254. \fB$HOME/.Xauthority\fP and will create it or merge in authorization records
  255. if it already exists when a user logs in.
  256. .PP
  257. If you use several machines and share a common home directory
  258. across all of the machines by means of a network file system,
  259. you never really have to worry about authorization files,
  260. the system should work correctly by default.
  261. Otherwise, as the authorization files are machine-independent,
  262. you can simply copy the files to share them.
  263. To manage authorization files, use \fIxauth\fP.
  264. This program allows you to extract
  265. records and insert them into other files. Using this, you can send
  266. authorization to remote machines when you login,
  267. if the remote machine does not share a common home directory with
  268. your local machine.
  269. Note that authorization information transmitted
  270. ``in the clear'' through a network file system or
  271. using \fIftp\fP or \fIrcp\fP can be ``stolen''
  272. by a network eavesdropper, and as such may enable unauthorized access.
  273. In many environments, this level of security is not a concern, but if it is,
  274. you need to know the exact semantics of the particular authorization
  275. data to know if this is actually a problem.
  276. .PP
  277. For more information on access control, see the
  278. \fIXsecurity\fP(__miscmansuffix__) manual page.
  279. .SH "GEOMETRY SPECIFICATIONS"
  280. One of the advantages of using window systems instead of
  281. hardwired terminals is that
  282. applications don't have to be restricted to a particular size or location
  283. on the screen.
  284. Although the layout of windows on a display is controlled
  285. by the window manager that the user is running (described below),
  286. most X programs accept
  287. a command line argument of the form \fB\-geometry \fIWIDTHxHEIGHT+XOFF+YOFF\fR
  288. (where \fIWIDTH\fP, \fIHEIGHT\fP, \fIXOFF\fP, and \fIYOFF\fP are numbers)
  289. for specifying a preferred size and location for this application's main
  290. window.
  291. .PP
  292. The \fIWIDTH\fP and \fIHEIGHT\fP parts of the geometry specification are
  293. usually measured in either pixels or characters, depending on the application.
  294. The \fIXOFF\fP and \fIYOFF\fP parts are measured in pixels and are used to
  295. specify the distance of the window from the left or right and top and bottom
  296. edges of the screen, respectively. Both types of offsets are measured from the
  297. indicated edge of the screen to the corresponding edge of the window. The X
  298. offset may be specified in the following ways:
  299. .TP 8
  300. .I +XOFF
  301. The left edge of the window is to be placed \fIXOFF\fP pixels in from the
  302. left edge of the screen (i.e., the X coordinate of the window's origin will be
  303. \fIXOFF\fP). \fIXOFF\fP may be negative, in which case the window's left edge
  304. will be off the screen.
  305. .TP 8
  306. .I \-XOFF
  307. The right edge of the window is to be placed \fIXOFF\fP pixels in from the
  308. right edge of the screen. \fIXOFF\fP may be negative, in which case the
  309. window's right edge will be off the screen.
  310. .PP
  311. The Y offset has similar meanings:
  312. .TP 8
  313. .I +YOFF
  314. The top edge of the window is to be \fIYOFF\fP pixels below the
  315. top edge of the screen (i.e., the Y coordinate of the window's origin will be
  316. \fIYOFF\fP). \fIYOFF\fP may be negative, in which case the window's top edge
  317. will be off the screen.
  318. .TP 8
  319. .I \-YOFF
  320. The bottom edge of the window is to be \fIYOFF\fP pixels above the
  321. bottom edge of the screen. \fIYOFF\fP may be negative, in which case
  322. the window's bottom edge will be off the screen.
  323. .PP
  324. Offsets must be given as pairs; in other words, in order to specify either
  325. \fIXOFF\fP or \fIYOFF\fP both must be present. Windows can be placed in the
  326. four corners of the screen using the following specifications:
  327. .TP 8
  328. .I +0+0
  329. upper left hand corner.
  330. .TP 8
  331. .I \-0+0
  332. upper right hand corner.
  333. .TP 8
  334. .I \-0\-0
  335. lower right hand corner.
  336. .TP 8
  337. .I +0\-0
  338. lower left hand corner.
  339. .PP
  340. In the following examples, a terminal emulator is placed in roughly
  341. the center of the screen and
  342. a load average monitor, mailbox, and clock are placed in the upper right
  343. hand corner:
  344. .sp
  345. .nf
  346. xterm \-fn 6x10 \-geometry 80x24+30+200 &
  347. xclock \-geometry 48x48\-0+0 &
  348. xload \-geometry 48x48\-96+0 &
  349. xbiff \-geometry 48x48\-48+0 &
  350. .fi
  351. .PP
  352. .SH "WINDOW MANAGERS"
  353. The layout of windows on the screen is controlled by special programs called
  354. \fIwindow managers\fP. Although many window managers will honor geometry
  355. specifications as given, others may choose to ignore them (requiring the user
  356. to explicitly draw the window's region on the screen with the pointer, for
  357. example).
  358. .PP
  359. Since window managers are regular (albeit complex) client programs,
  360. a variety of different user interfaces can be built. The X.Org Foundation distribution
  361. comes with a window manager named \fItwm\fP which supports overlapping windows,
  362. popup menus, point-and-click or click-to-type input models, title bars, nice
  363. icons (and an icon manager for those who don't like separate icon windows).
  364. .PP
  365. See the user-contributed software in the X.Org Foundation distribution for other
  366. popular window managers.
  367. .SH "FONT NAMES"
  368. Collections of characters for displaying text and symbols in X are known as
  369. \fIfonts\fP. A font typically contains images that share a common appearance
  370. and look nice together (for example, a single size, boldness, slant, and
  371. character set). Similarly, collections of fonts that are based on a common
  372. type face (the variations are usually called roman, bold, italic, bold italic,
  373. oblique, and bold oblique) are called \fIfamilies\fP.
  374. .PP
  375. Fonts come in various sizes. The X server supports \fIscalable\fP fonts,
  376. meaning it is possible to create a font of arbitrary size from a single
  377. source for the font. The server supports scaling from \fIoutline\fP
  378. fonts and \fIbitmap\fP fonts. Scaling from outline fonts usually produces
  379. significantly better results than scaling from bitmap fonts.
  380. .PP
  381. An X server can obtain fonts from individual files stored in directories
  382. in the file system, or from one or more font servers,
  383. or from a mixtures of directories and font servers.
  384. The list of places the server looks when trying to find
  385. a font is controlled by its \fIfont path\fP. Although most installations
  386. will choose to have the server start up with all of the commonly used font
  387. directories in the font path, the font path can be changed at any time
  388. with the \fIxset\fP program.
  389. However, it is important to remember that the directory names are
  390. on the \fBserver\fP's machine, not on the application's.
  391. .PP
  392. Bitmap font files are usually created by compiling a textual font description
  393. into binary form, using \fIbdftopcf\fP.
  394. Font databases are created by running the \fImkfontdir\fP program in the
  395. directory containing the source or compiled versions of the fonts.
  396. Whenever fonts are added to a directory, \fImkfontdir\fP should be rerun
  397. so that the server can find the new fonts. To make the server reread the
  398. font database, reset the font path with the \fIxset\fP program. For example,
  399. to add a font to a private directory, the following commands could be used:
  400. .sp
  401. .nf
  402. % cp newfont.pcf ~/myfonts
  403. % mkfontdir ~/myfonts
  404. % xset fp rehash
  405. .fi
  406. .PP
  407. The \fIxfontsel\fP and \fIxlsfonts\fP programs can be used to browse
  408. through the fonts available on a server.
  409. Font names tend to be fairly long as they contain all of the information
  410. needed to uniquely identify individual fonts. However, the X server
  411. supports wildcarding of font names, so the full specification
  412. .sp
  413. .nf
  414. \fI\-adobe\-courier\-medium\-r\-normal\-\-10\-100\-75\-75\-m\-60\-iso8859\-1\fP
  415. .fi
  416. .sp
  417. might be abbreviated as:
  418. .sp
  419. .nf
  420. \fI\-*\-courier\-medium\-r\-normal\-\-*\-100\-*\-*\-*\-*\-iso8859\-1\fP
  421. .fi
  422. .PP
  423. Because the shell also has special meanings for \fI*\fP and \fI?\fP,
  424. wildcarded font names should be quoted:
  425. .sp
  426. .nf
  427. % xlsfonts \-fn '\-*\-courier\-medium\-r\-normal\-\-*\-100\-*\-*\-*\-*\-*\-*'
  428. .fi
  429. .PP
  430. The \fIxlsfonts\fP program can be used to list all of the fonts that
  431. match a given pattern. With no arguments, it lists all available fonts.
  432. This will usually list the same font at many different sizes. To see
  433. just the base scalable font names, try using one of the following patterns:
  434. .sp
  435. .nf
  436. \fI\-*\-*\-*\-*\-*\-*\-0\-0\-0\-0\-*\-0\-*\-*\fP
  437. \fI\-*\-*\-*\-*\-*\-*\-0\-0\-75\-75\-*\-0\-*\-*\fP
  438. \fI\-*\-*\-*\-*\-*\-*\-0\-0\-100\-100\-*\-0\-*\-*\fP
  439. .fi
  440. .PP
  441. To convert one of the resulting names into a font at a specific size,
  442. replace one of the first two zeros with a nonzero value.
  443. The field containing the first zero is for the pixel size; replace it
  444. with a specific height in pixels to name a font at that size.
  445. Alternatively, the field containing the second zero is for the point size;
  446. replace it with a specific size in decipoints (there are 722.7 decipoints to
  447. the inch) to name a font at that size.
  448. The last zero is an average width field, measured in tenths of pixels;
  449. some servers will anamorphically scale if this value is specified.
  450. .SH "FONT SERVER NAMES"
  451. One of the following forms can be used to name a font server that
  452. accepts TCP connections:
  453. .sp
  454. .nf
  455. tcp/\fIhostname\fP:\fIport\fP
  456. tcp/\fIhostname\fP:\fIport\fP/\fIcataloguelist\fP
  457. .fi
  458. .PP
  459. The \fIhostname\fP specifies the name (or decimal numeric address)
  460. of the machine on which the font server is running. The \fIport\fP
  461. is the decimal TCP port on which the font server is listening for connections.
  462. The \fIcataloguelist\fP specifies a list of catalogue names,
  463. with '+' as a separator.
  464. .PP
  465. Examples: \fItcp/x.org:7100\fP, \fItcp/198.112.45.11:7100/all\fP.
  466. .SH "COLOR NAMES"
  467. Most applications provide ways of tailoring (usually through resources or
  468. command line arguments) the colors of various elements
  469. in the text and graphics they display.
  470. A color can be specified either by an abstract color name,
  471. or by a numerical color specification.
  472. The numerical specification can identify a color in either
  473. device-dependent (RGB) or device-independent terms.
  474. Color strings are case-insensitive.
  475. .PP
  476. X supports the use of abstract color names, for example, "red", "blue".
  477. A value for this abstract name is obtained by searching one or more color
  478. name databases.
  479. \fIXlib\fP first searches zero or more client-side databases;
  480. the number, location, and content of these databases is
  481. implementation dependent.
  482. If the name is not found, the color is looked up in the
  483. X server's database.
  484. The text form of this database is commonly stored in the file
  485. \fI\__datadir__/X11/rgb.txt\fP.
  486. .PP
  487. A numerical color specification
  488. consists of a color space name and a set of values in the following syntax:
  489. .sp
  490. .nf
  491. \fI<color_space_name>\fP:\fI<value>/.../<value>\fP
  492. .fi
  493. .PP
  494. An RGB Device specification is identified by
  495. the prefix "rgb:" and has the following syntax:
  496. .sp
  497. .nf
  498. rgb:\fI<red>/<green>/<blue>\fP
  499. \fI<red>\fP, \fI<green>\fP, \fI<blue>\fP := \fIh\fP | \fIhh\fP | \fIhhh\fP | \fIhhhh\fP
  500. \fIh\fP := single hexadecimal digits
  501. .fi
  502. .sp
  503. Note that \fIh\fP indicates the value scaled in 4 bits,
  504. \fIhh\fP the value scaled in 8 bits,
  505. \fIhhh\fP the value scaled in 12 bits,
  506. and \fIhhhh\fP the value scaled in 16 bits, respectively.
  507. These values are passed directly to the X server,
  508. and are assumed to be gamma corrected.
  509. .PP
  510. The eight primary colors can be represented as:
  511. .sp
  512. .TS
  513. center;
  514. l l.
  515. black rgb:0/0/0
  516. red rgb:ffff/0/0
  517. green rgb:0/ffff/0
  518. blue rgb:0/0/ffff
  519. yellow rgb:ffff/ffff/0
  520. magenta rgb:ffff/0/ffff
  521. cyan rgb:0/ffff/ffff
  522. white rgb:ffff/ffff/ffff
  523. .TE
  524. .PP
  525. For backward compatibility, an older syntax for RGB Device is
  526. supported, but its continued use is not encouraged.
  527. The syntax is an initial sharp sign character followed by
  528. a numeric specification, in one of the following formats:
  529. .sp
  530. .TS
  531. center;
  532. l l.
  533. #RGB (4 bits each)
  534. #RRGGBB (8 bits each)
  535. #RRRGGGBBB (12 bits each)
  536. #RRRRGGGGBBBB (16 bits each)
  537. .TE
  538. .PP
  539. The R, G, and B represent single hexadecimal digits.
  540. When fewer than 16 bits each are specified,
  541. they represent the most-significant bits of the value
  542. (unlike the "rgb:" syntax, in which values are scaled).
  543. For example, #3a7 is the same as #3000a0007000.
  544. .PP
  545. An RGB intensity specification is identified
  546. by the prefix "rgbi:" and has the following syntax:
  547. .sp
  548. .nf
  549. rgbi:\fI<red>/<green>/<blue>\fP
  550. .fi
  551. .PP
  552. The red, green, and blue are floating point values
  553. between 0.0 and 1.0, inclusive.
  554. They represent linear intensity values, with
  555. 1.0 indicating full intensity, 0.5 half intensity, and so on.
  556. These values will be gamma corrected by \fIXlib\fP
  557. before being sent to the X server.
  558. The input format for these values is an optional sign,
  559. a string of numbers possibly containing a decimal point,
  560. and an optional exponent field containing an E or e
  561. followed by a possibly signed integer string.
  562. .PP
  563. The standard device-independent string specifications have
  564. the following syntax:
  565. .sp
  566. .TS
  567. center;
  568. l l.
  569. CIEXYZ:\fI<X>/<Y>/<Z>\fP (\fInone\fP, 1, \fInone\fP)
  570. CIEuvY:\fI<u>/<v>/<Y>\fP (~.6, ~.6, 1)
  571. CIExyY:\fI<x>/<y>/<Y>\fP (~.75, ~.85, 1)
  572. CIELab:\fI<L>/<a>/<b>\fP (100, \fInone\fP, \fInone\fP)
  573. CIELuv:\fI<L>/<u>/<v>\fP (100, \fInone\fP, \fInone\fP)
  574. TekHVC:\fI<H>/<V>/<C>\fP (360, 100, 100)
  575. .TE
  576. .PP
  577. All of the values (C, H, V, X, Y, Z, a, b, u, v, y, x) are
  578. floating point values. Some of the values are constrained to
  579. be between zero and some upper bound; the upper bounds are
  580. given in parentheses above.
  581. The syntax for these values is an optional '+' or '\-' sign,
  582. a string of digits possibly containing a decimal point,
  583. and an optional exponent field consisting of an 'E' or 'e'
  584. followed by an optional '+' or '\-' followed by a string of digits.
  585. .PP
  586. For more information on device independent color,
  587. see the \fIXlib\fP reference manual.
  588. .SH KEYBOARDS
  589. .PP
  590. The X keyboard model is broken into two layers: server-specific codes
  591. (called \fIkeycodes\fP) which represent the physical keys, and
  592. server-independent symbols (called \fIkeysyms\fP) which
  593. represent the letters or words that appear on the keys.
  594. Two tables are kept in the server for converting keycodes to keysyms:
  595. .TP 8
  596. .I "modifier list"
  597. Some keys (such as Shift, Control, and Caps Lock) are known as \fImodifier\fP
  598. and are used to select different symbols that are attached to a single key
  599. (such as Shift-a generates a capital A, and Control-l generates a control
  600. character ^L). The server keeps a list of keycodes corresponding to the
  601. various modifier keys. Whenever a key is pressed or released, the server
  602. generates an \fIevent\fP that contains the keycode of the indicated key as
  603. well as a mask that specifies which of the modifier keys are currently pressed.
  604. Most servers set up this list to initially contain
  605. the various shift, control, and shift lock keys on the keyboard.
  606. .TP 8
  607. .I "keymap table"
  608. Applications translate event keycodes and modifier masks into keysyms
  609. using a \fIkeysym table\fP which contains one row for each keycode and one
  610. column for various modifier states. This table is initialized by the server
  611. to correspond to normal typewriter conventions. The exact semantics of
  612. how the table is interpreted to produce keysyms depends on the particular
  613. program, libraries, and language input method used, but the following
  614. conventions for the first four keysyms in each row are generally adhered to:
  615. .PP
  616. The first four elements of the list are split into two groups of keysyms.
  617. Group 1 contains the first and second keysyms;
  618. Group 2 contains the third and fourth keysyms.
  619. Within each group,
  620. if the first element is alphabetic and the
  621. the second element is the special keysym \fINoSymbol\fP,
  622. then the group is treated as equivalent to a group in which
  623. the first element is the lowercase letter and the second element
  624. is the uppercase letter.
  625. .PP
  626. Switching between groups is controlled by the keysym named MODE SWITCH,
  627. by attaching that keysym to some key and attaching
  628. that key to any one of the modifiers Mod1 through Mod5.
  629. This modifier is called the ``group modifier.''
  630. Group 1 is used when the group modifier is off,
  631. and Group 2 is used when the group modifier is on.
  632. .PP
  633. Within a group,
  634. the modifier state determines which keysym to use.
  635. The first keysym is used when the Shift and Lock modifiers are off.
  636. The second keysym is used when the Shift modifier is on,
  637. when the Lock modifier is on and the second keysym is uppercase alphabetic,
  638. or when the Lock modifier is on and is interpreted as ShiftLock.
  639. Otherwise, when the Lock modifier is on and is interpreted as CapsLock,
  640. the state of the Shift modifier is applied first to select a keysym;
  641. but if that keysym is lowercase alphabetic,
  642. then the corresponding uppercase keysym is used instead.
  643. .SH OPTIONS
  644. Most X programs attempt to use the same names for command line options and
  645. arguments. All applications written with the X Toolkit Intrinsics
  646. automatically accept the following options:
  647. .TP 8
  648. .B \-display \fIdisplay\fP
  649. This option specifies the name of the X server to use.
  650. .TP 8
  651. .B \-geometry \fIgeometry\fP
  652. This option specifies the initial size and location of the window.
  653. .TP 8
  654. .B \-bg \fIcolor\fP, \fB\-background \fIcolor\fP
  655. Either option specifies the color to use for the window background.
  656. .TP 8
  657. .B \-bd \fIcolor\fP, \fB\-bordercolor \fIcolor\fP
  658. Either option specifies the color to use for the window border.
  659. .TP 8
  660. .B \-bw \fInumber\fP, \fB\-borderwidth \fInumber\fP
  661. Either option specifies the width in pixels of the window border.
  662. .TP 8
  663. .B \-fg \fIcolor\fP, \fB\-foreground \fIcolor\fP
  664. Either option specifies the color to use for text or graphics.
  665. .TP 8
  666. .B \-fn \fIfont\fP, \fB\-font \fIfont\fP
  667. Either option specifies the font to use for displaying text.
  668. .TP 8
  669. .B \-iconic
  670. .br
  671. This option indicates that the user would prefer that the application's
  672. windows initially not be visible as if the windows had be immediately
  673. iconified by the user. Window managers may choose not to honor the
  674. application's request.
  675. .TP 8
  676. .B \-name
  677. .br
  678. This option specifies the name under which resources for the
  679. application should be found. This option is useful in shell
  680. aliases to distinguish between invocations of an application,
  681. without resorting to creating links to alter the executable file name.
  682. .TP 8
  683. .B \-rv\fP, \fB\-reverse\fP
  684. Either option indicates that the program should simulate reverse video if
  685. possible, often by swapping the foreground and background colors. Not all
  686. programs honor this or implement it correctly. It is usually only used on
  687. monochrome displays.
  688. .TP 8
  689. .B \+rv
  690. .br
  691. This option indicates that the program should not simulate reverse video.
  692. This is used to
  693. override any defaults since reverse video doesn't always work properly.
  694. .TP 8
  695. .B \-selectionTimeout
  696. This option specifies the timeout in milliseconds within which two
  697. communicating applications must respond to one another for a selection
  698. request.
  699. .TP 8
  700. .B \-synchronous
  701. This option indicates that requests to the X server should be sent
  702. synchronously, instead of asynchronously. Since
  703. .I Xlib
  704. normally buffers requests to the server, errors do not necessarily get reported
  705. immediately after they occur. This option turns off the buffering so that
  706. the application can be debugged. It should never be used with a working
  707. program.
  708. .TP 8
  709. .B \-title \fIstring\fP
  710. This option specifies the title to be used for this window. This information
  711. is sometimes
  712. used by a window manager to provide some sort of header identifying the window.
  713. .TP 8
  714. .B \-xnllanguage \fIlanguage[_territory][.codeset]\fP
  715. This option specifies the language, territory, and codeset for use in
  716. resolving resource and other filenames.
  717. .TP 8
  718. .B \-xrm \fIresourcestring\fP
  719. This option specifies a resource name and value to override any defaults. It
  720. is also very useful for setting resources that don't have explicit command
  721. line arguments.
  722. .SH RESOURCES
  723. To make the tailoring of applications to personal preferences easier, X
  724. provides a mechanism for storing default values for program resources
  725. (e.g. background color, window title, etc.) that is used by programs that
  726. use toolkits based on the X Toolkit Intrinsics library libXt. (Programs
  727. using the common Gtk+ and Qt toolkits use other configuration mechanisms.)
  728. Resources are specified as strings
  729. that are read in from various places when an application is run.
  730. Program components are named in a hierarchical fashion,
  731. with each node in the hierarchy identified by a class and an instance name.
  732. At the top level is the class and instance name of the application itself.
  733. By convention, the class name of the application is the same as the program
  734. name, but with the first letter capitalized (e.g. \fIBitmap\fP or \fIEmacs\fP)
  735. although some programs that begin with the letter ``x'' also capitalize the
  736. second letter for historical reasons.
  737. .PP
  738. The precise syntax for resources is:
  739. .PP
  740. .nf
  741. ResourceLine = Comment | IncludeFile | ResourceSpec | <empty line>
  742. Comment = "!" {<any character except null or newline>}
  743. IncludeFile = "#" WhiteSpace "include" WhiteSpace FileName WhiteSpace
  744. FileName = <valid filename for operating system>
  745. ResourceSpec = WhiteSpace ResourceName WhiteSpace ":" WhiteSpace Value
  746. ResourceName = [Binding] {Component Binding} ComponentName
  747. Binding = "\&." | "*"
  748. WhiteSpace = {<space> | <horizontal tab>}
  749. Component = "?" | ComponentName
  750. ComponentName = NameChar {NameChar}
  751. NameChar = "a"\-"z" | "A"\-"Z" | "0"\-"9" | "_" | "\-"
  752. Value = {<any character except null or unescaped newline>}
  753. .fi
  754. .PP
  755. Elements separated by vertical bar (|) are alternatives.
  756. Curly braces ({\&.\&.\&.}) indicate zero or more repetitions
  757. of the enclosed elements.
  758. Square brackets ([\&.\&.\&.]) indicate that the enclosed element is optional.
  759. Quotes ("\&.\&.\&.") are used around literal characters.
  760. .PP
  761. IncludeFile lines are interpreted by replacing the line with the
  762. contents of the specified file. The word "include" must be in lowercase.
  763. The filename is interpreted relative to the directory of the file in
  764. which the line occurs (for example, if the filename contains no
  765. directory or contains a relative directory specification).
  766. .PP
  767. If a ResourceName contains a contiguous sequence of two or more Binding
  768. characters, the sequence will be replaced with single "\&." character
  769. if the sequence contains only "\&." characters,
  770. otherwise the sequence will be replaced with a single "*" character.
  771. .PP
  772. A resource database never contains more than one entry for a given
  773. ResourceName. If a resource file contains multiple lines with the
  774. same ResourceName, the last line in the file is used.
  775. .PP
  776. Any whitespace character before or after the name or colon in a ResourceSpec
  777. are ignored.
  778. To allow a Value to begin with whitespace,
  779. the two-character sequence ``\\\^\fIspace\fP'' (backslash followed by space)
  780. is recognized and replaced by a space character,
  781. and the two-character sequence ``\\\^\fItab\fP''
  782. (backslash followed by horizontal tab)
  783. is recognized and replaced by a horizontal tab character.
  784. To allow a Value to contain embedded newline characters,
  785. the two-character sequence ``\\\^n'' is recognized and replaced by a
  786. newline character.
  787. To allow a Value to be broken across multiple lines in a text file,
  788. the two-character sequence ``\\\^\fInewline\fP''
  789. (backslash followed by newline) is
  790. recognized and removed from the value.
  791. To allow a Value to contain arbitrary character codes,
  792. the four-character sequence ``\\\^\fInnn\fP'',
  793. where each \fIn\fP is a digit character in the range of ``0''\-``7'',
  794. is recognized and replaced with a single byte that contains
  795. the octal value specified by the sequence.
  796. Finally, the two-character sequence ``\\\\'' is recognized
  797. and replaced with a single backslash.
  798. .PP
  799. When an application looks for the value of a resource, it specifies
  800. a complete path in the hierarchy, with both class and instance names.
  801. However, resource values are usually given with only partially specified
  802. names and classes, using pattern matching constructs.
  803. An asterisk (*) is a loose binding and is used to represent any number
  804. of intervening components, including none.
  805. A period (.) is a tight binding and is used to separate immediately
  806. adjacent components.
  807. A question mark (?) is used to match any single component name or class.
  808. A database entry cannot end in a loose binding;
  809. the final component (which cannot be "?") must be specified.
  810. The lookup algorithm searches the resource database for the entry that most
  811. closely matches (is most specific for) the full name and class being queried.
  812. When more than one database entry matches the full name and class,
  813. precedence rules are used to select just one.
  814. .LP
  815. The full name and class are scanned from left to right (from highest
  816. level in the hierarchy to lowest), one component at a time.
  817. At each level, the corresponding component and/or binding of each
  818. matching entry is determined, and these matching components and
  819. bindings are compared according to precedence rules.
  820. Each of the rules is applied at each level,
  821. before moving to the next level,
  822. until a rule selects a single entry over all others.
  823. The rules (in order of precedence) are:
  824. .IP 1. 5
  825. An entry that contains a matching component (whether name, class, or "?")
  826. takes precedence over entries that elide the level (that is, entries
  827. that match the level in a loose binding).
  828. .IP 2. 5
  829. An entry with a matching name takes precedence over both
  830. entries with a matching class and entries that match using "?".
  831. An entry with a matching class takes precedence over
  832. entries that match using "?".
  833. .IP 3. 5
  834. An entry preceded by a tight binding takes precedence over entries
  835. preceded by a loose binding.
  836. .PP
  837. Programs based on the X Toolkit Intrinsics
  838. obtain resources from the following sources
  839. (other programs usually support some subset of these sources):
  840. .TP 8
  841. .B "RESOURCE_MANAGER root window property"
  842. Any global resources that should be available to clients on all machines
  843. should be stored in the RESOURCE_MANAGER property on the
  844. root window of the first screen using the \fIxrdb\fP program.
  845. This is frequently taken care
  846. of when the user starts up X through the display manager or \fIxinit\fP.
  847. .TP 8
  848. .B "SCREEN_RESOURCES root window property"
  849. Any resources specific to a given screen (e.g. colors)
  850. that should be available to clients on all machines
  851. should be stored in the SCREEN_RESOURCES property on the
  852. root window of that screen.
  853. The \fIxrdb\fP program will sort resources automatically and place them
  854. in RESOURCE_MANAGER or SCREEN_RESOURCES, as appropriate.
  855. .TP 8
  856. .B "application-specific files"
  857. Directories named by the environment variable XUSERFILESEARCHPATH
  858. or the environment variable XAPPLRESDIR (which names a single
  859. directory and should end with a '/' on POSIX systems), plus directories in a
  860. standard place (usually under __datadir__/X11/,
  861. but this can be overridden with the XFILESEARCHPATH environment variable)
  862. are searched for for application-specific resources.
  863. For example, application default resources are usually kept in
  864. __datadir__/X11/app-defaults/.
  865. See the \fIX Toolkit Intrinsics - C Language Interface\fP manual for
  866. details.
  867. .TP 8
  868. .B XENVIRONMENT
  869. Any user- and machine-specific resources may be specified by setting
  870. the XENVIRONMENT environment variable to the name of a resource file
  871. to be loaded by all applications. If this variable is not defined,
  872. a file named \fI$HOME\fP/.Xdefaults\-\fIhostname\fP is looked for instead,
  873. where \fIhostname\fP is the name of the host where the application
  874. is executing.
  875. .TP 8
  876. .B \-xrm \fIresourcestring\fP
  877. Resources can also be specified from the
  878. command line. The \fIresourcestring\fP is a single resource name and value as
  879. shown above. Note that if the string contains characters interpreted by
  880. the shell (e.g., asterisk), they must be quoted.
  881. Any number of \fB\-xrm\fP arguments may be given on the
  882. command line.
  883. .PP
  884. Program resources are organized into groups called \fIclasses\fP, so that
  885. collections of individual resources (each of which are
  886. called \fIinstances\fP)
  887. can be set all at once. By convention, the instance name of a resource
  888. begins with a lowercase letter and class name with an upper case letter.
  889. Multiple word resources are concatenated with the first letter of the
  890. succeeding words capitalized. Applications written with the X Toolkit
  891. Intrinsics will have at least the following resources:
  892. .PP
  893. .TP 8
  894. .B background (\fPclass\fB Background)
  895. This resource specifies the color to use for the window background.
  896. .PP
  897. .TP 8
  898. .B borderWidth (\fPclass\fB BorderWidth)
  899. This resource specifies the width in pixels of the window border.
  900. .PP
  901. .TP 8
  902. .B borderColor (\fPclass\fB BorderColor)
  903. This resource specifies the color to use for the window border.
  904. .PP
  905. Most applications using the X Toolkit Intrinsics also have the resource
  906. \fBforeground\fP
  907. (class \fBForeground\fP), specifying the color to use for text
  908. and graphics within the window.
  909. .PP
  910. By combining class and instance specifications, application preferences
  911. can be set quickly and easily. Users of color displays will frequently
  912. want to set Background and Foreground classes to particular defaults.
  913. Specific color instances such as text cursors can then be overridden
  914. without having to define all of the related resources. For example,
  915. .sp
  916. .nf
  917. bitmap*Dashed: off
  918. XTerm*cursorColor: gold
  919. XTerm*multiScroll: on
  920. XTerm*jumpScroll: on
  921. XTerm*reverseWrap: on
  922. XTerm*curses: on
  923. XTerm*Font: 6x10
  924. XTerm*scrollBar: on
  925. XTerm*scrollbar*thickness: 5
  926. XTerm*multiClickTime: 500
  927. XTerm*charClass: 33:48,37:48,45\-47:48,64:48
  928. XTerm*cutNewline: off
  929. XTerm*cutToBeginningOfLine: off
  930. XTerm*titeInhibit: on
  931. XTerm*ttyModes: intr ^c erase ^? kill ^u
  932. XLoad*Background: gold
  933. XLoad*Foreground: red
  934. XLoad*highlight: black
  935. XLoad*borderWidth: 0
  936. emacs*Geometry: 80x65\-0\-0
  937. emacs*Background: rgb:5b/76/86
  938. emacs*Foreground: white
  939. emacs*Cursor: white
  940. emacs*BorderColor: white
  941. emacs*Font: 6x10
  942. xmag*geometry: \-0\-0
  943. xmag*borderColor: white
  944. .fi
  945. .PP
  946. If these resources were stored in a file called \fI.Xresources\fP in your home
  947. directory, they could be added to any existing resources in the server with
  948. the following command:
  949. .sp
  950. .nf
  951. % xrdb \-merge $HOME/.Xresources
  952. .fi
  953. .sp
  954. This is frequently how user-friendly startup scripts merge user-specific
  955. defaults
  956. into any site-wide defaults. All sites are encouraged to set up convenient
  957. ways of automatically loading resources. See the \fIXlib\fP
  958. manual section \fIResource Manager Functions\fP for more information.
  959. .SH ENVIRONMENT
  960. .TP
  961. .B DISPLAY
  962. This is the only mandatory environment variable. It must point to an
  963. X server. See section "Display Names" above.
  964. .TP
  965. .B XAUTHORITY
  966. This must point to a file that contains authorization data. The default
  967. is \fI$HOME/.Xauthority\fP. See
  968. .BR Xsecurity (__miscmansuffix__),
  969. .BR xauth (__appmansuffix__),
  970. .BR xdm (__appmansuffix__),
  971. .BR Xau (3).
  972. .TP
  973. .B ICEAUTHORITY
  974. This must point to a file that contains authorization data. The default
  975. is \fI$HOME/.ICEauthority\fP.
  976. .TP
  977. .BR LC_ALL ", " LC_CTYPE ", " LANG
  978. The first non-empty value among these three determines the current
  979. locale's facet for character handling, and in particular the default
  980. text encoding. See
  981. .BR locale (__miscmansuffix__),
  982. .BR setlocale (3),
  983. .BR locale (1).
  984. .TP
  985. .B XMODIFIERS
  986. This variable can be set to contain additional information important
  987. for the current locale setting. Typically set to \fI@im=<input-method>\fP
  988. to enable a particular input method. See
  989. .BR XSetLocaleModifiers (__libmansuffix__).
  990. .TP
  991. .B XLOCALEDIR
  992. This must point to a directory containing the locale.alias file and
  993. Compose and XLC_LOCALE file hierarchies for all locales. The default value
  994. is\fI __datadir__/X11/locale\fP.
  995. .TP
  996. .B XENVIRONMENT
  997. This must point to a file containing X resources. The default is
  998. \fI$HOME/.Xdefaults\-<hostname>\fP. Unlike \fI$HOME/.Xresources\fP,
  999. it is consulted each time an X application starts.
  1000. .TP
  1001. .B XFILESEARCHPATH
  1002. This must contain a colon separated list of path templates, where libXt
  1003. will search for resource files. The default value consists of
  1004. .sp
  1005. .nf
  1006. __sysconfdir__/X11/%L/%T/%N%C%S:\\
  1007. __sysconfdir__/X11/%l/%T/%N%C%S:\\
  1008. __sysconfdir__/X11/%T/%N%C%S:\\
  1009. __sysconfdir__/X11/%L/%T/%N%S:\\
  1010. __sysconfdir__/X11/%l/%T/%N%S:\\
  1011. __sysconfdir__/X11/%T/%N%S:\\
  1012. __datadir__/X11/%L/%T/%N%C%S:\\
  1013. __datadir__/X11/%l/%T/%N%C%S:\\
  1014. __datadir__/X11/%T/%N%C%S:\\
  1015. __datadir__/X11/%L/%T/%N%S:\\
  1016. __datadir__/X11/%l/%T/%N%S:\\
  1017. __datadir__/X11/%T/%N%S:\\
  1018. __libdir__/X11/%L/%T/%N%C%S:\\
  1019. __libdir__/X11/%l/%T/%N%C%S:\\
  1020. __libdir__/X11/%T/%N%C%S:\\
  1021. __libdir__/X11/%L/%T/%N%S:\\
  1022. __libdir__/X11/%l/%T/%N%S:\\
  1023. __libdir__/X11/%T/%N%S
  1024. .fi
  1025. .sp
  1026. A path template is transformed to a pathname by substituting:
  1027. .sp
  1028. .nf
  1029. %D => the implementation-specific default path
  1030. %N => name (basename) being searched for
  1031. %T => type (dirname) being searched for
  1032. %S => suffix being searched for
  1033. %C => value of the resource "customization"
  1034. (class "Customization")
  1035. %L => the locale name
  1036. %l => the locale's language (part before '_')
  1037. %t => the locale's territory (part after '_` but before '.')
  1038. %c => the locale's encoding (part after '.')
  1039. .fi
  1040. .TP
  1041. .B XUSERFILESEARCHPATH
  1042. This must contain a colon separated list of path templates,
  1043. where libXt will search for user dependent resource files. The default
  1044. value is:
  1045. .sp
  1046. .nf
  1047. $XAPPLRESDIR/%L/%N%C:\\
  1048. $XAPPLRESDIR/%l/%N%C:\\
  1049. $XAPPLRESDIR/%N%C:\\
  1050. $HOME/%N%C:\\
  1051. $XAPPLRESDIR/%L/%N:\\
  1052. $XAPPLRESDIR/%l/%N:\\
  1053. $XAPPLRESDIR/%N:\\
  1054. $HOME/%N
  1055. .fi
  1056. .sp
  1057. $XAPPLRESDIR defaults to \fI$HOME\fP, see below.
  1058. .sp
  1059. A path template is transformed to a pathname by substituting:
  1060. .sp
  1061. .nf
  1062. %D => the implementation-specific default path
  1063. %N => name (basename) being searched for
  1064. %T => type (dirname) being searched for
  1065. %S => suffix being searched for
  1066. %C => value of the resource "customization"
  1067. (class "Customization")
  1068. %L => the locale name
  1069. %l => the locale's language (part before '_')
  1070. %t => the locale's territory (part after '_` but before '.')
  1071. %c => the locale's encoding (part after '.')
  1072. .fi
  1073. .TP
  1074. .B XAPPLRESDIR
  1075. This must point to a base directory where the user stores the application
  1076. dependent resource files. The default value is \fI$HOME\fP. Only used if
  1077. XUSERFILESEARCHPATH is not set.
  1078. .TP
  1079. .B XKEYSYMDB
  1080. This must point to a file containing nonstandard keysym definitions.
  1081. The default value is\fI __datadir__/X11/XKeysymDB\fP.
  1082. .TP
  1083. .B XCMSDB
  1084. This must point to a color name database file. The default value is
  1085. \fI __libdir__/X11/Xcms.txt\fP.
  1086. .TP
  1087. .B RESOURCE_NAME
  1088. This serves as main identifier for resources belonging to the program
  1089. being executed. It defaults to the basename of pathname of the program.
  1090. .TP
  1091. .B SESSION_MANAGER
  1092. Denotes the session manager to which the application should connect. See
  1093. .BR xsm (__appmansuffix__),
  1094. .BR rstart (__appmansuffix__).
  1095. .TP
  1096. .B XF86BIGFONT_DISABLE
  1097. Setting this variable to a non-empty value disables the XFree86\-Bigfont
  1098. extension. This extension is a mechanism to reduce the memory consumption
  1099. of big fonts by use of shared memory.
  1100. .LP
  1101. .B XKB_FORCE
  1102. .br
  1103. .B XKB_DISABLE
  1104. .br
  1105. .B XKB_DEBUG
  1106. .br
  1107. .B _XKB_CHARSET
  1108. .br
  1109. .B _XKB_LOCALE_CHARSETS
  1110. .br
  1111. .B _XKB_OPTIONS_ENABLE
  1112. .br
  1113. .B _XKB_LATIN1_LOOKUP
  1114. .br
  1115. .B _XKB_CONSUME_LOOKUP_MODS
  1116. .br
  1117. .B _XKB_CONSUME_SHIFT_AND_LOCK
  1118. .br
  1119. .B _XKB_IGNORE_NEW_KEYBOARDS
  1120. .br
  1121. .B _XKB_CONTROL_FALLBACK
  1122. .br
  1123. .B _XKB_COMP_LED
  1124. .B _XKB_COMP_FAIL_BEEP
  1125. .PP
  1126. These variables influence the X Keyboard Extension.
  1127. .SH EXAMPLES
  1128. The following is a collection of sample command lines for some of the
  1129. more frequently used commands. For more information on a particular command,
  1130. please refer to that command's manual page.
  1131. .sp
  1132. .nf
  1133. % xrdb $HOME/.Xresources
  1134. % xmodmap \-e "keysym BackSpace = Delete"
  1135. % mkfontdir /usr/local/lib/X11/otherfonts
  1136. % xset fp+ /usr/local/lib/X11/otherfonts
  1137. % xmodmap $HOME/.keymap.km
  1138. % xsetroot \-solid 'rgbi:.8/.8/.8'
  1139. % xset b 100 400 c 50 s 1800 r on
  1140. % xset q
  1141. % twm
  1142. % xmag
  1143. % xclock \-geometry 48x48-0+0 \-bg blue \-fg white
  1144. % xeyes \-geometry 48x48\-48+0
  1145. % xbiff \-update 20
  1146. % xlsfonts '*helvetica*'
  1147. % xwininfo \-root
  1148. % xdpyinfo \-display joesworkstation:0
  1149. % xhost \-joesworkstation
  1150. % xrefresh
  1151. % xwd | xwud
  1152. % bitmap companylogo.bm 32x32
  1153. % xcalc \-bg blue \-fg magenta
  1154. % xterm \-geometry 80x66\-0\-0 \-name myxterm $*
  1155. .fi
  1156. .SH DIAGNOSTICS
  1157. A wide variety of error messages are generated from various programs.
  1158. The default error handler in \fIXlib\fP (also used by many toolkits) uses
  1159. standard resources to construct diagnostic messages when errors occur. The
  1160. defaults for these messages are usually stored in
  1161. \fI\__datadir__/X11/XErrorDB\fP. If this file is not present,
  1162. error messages will be rather terse and cryptic.
  1163. .PP
  1164. When the X Toolkit Intrinsics encounter errors converting resource strings to
  1165. the
  1166. appropriate internal format, no error messages are usually printed. This is
  1167. convenient when it is desirable to have one set of resources across a variety
  1168. of displays (e.g. color vs. monochrome, lots of fonts vs. very few, etc.),
  1169. although it can pose problems for trying to determine why an application might
  1170. be failing. This behavior can be overridden by the setting the
  1171. \fIStringConversionWarnings\fP resource.
  1172. .PP
  1173. To force the X Toolkit Intrinsics to always print string conversion error
  1174. messages,
  1175. the following resource should be placed in the file that gets
  1176. loaded onto the RESOURCE_MANAGER property
  1177. using the \fIxrdb\fP program (frequently called \fI.Xresources\fP
  1178. or \fI.Xres\fP in the user's home directory):
  1179. .sp
  1180. .nf
  1181. *StringConversionWarnings: on
  1182. .fi
  1183. .sp
  1184. To have conversion messages printed for just a particular application,
  1185. the appropriate instance name can be placed before the asterisk:
  1186. .sp
  1187. .nf
  1188. xterm*StringConversionWarnings: on
  1189. .fi
  1190. .SH "SEE ALSO"
  1191. .PP
  1192. .\" introductions
  1193. .BR XOrgFoundation (__miscmansuffix__),
  1194. .BR XStandards (__miscmansuffix__),
  1195. .BR Xsecurity (__miscmansuffix__),
  1196. .\" clients, utilities, and demos
  1197. .BR appres (__appmansuffix__),
  1198. .BR bdftopcf (__appmansuffix__),
  1199. .BR bitmap (__appmansuffix__),
  1200. .BR editres (__appmansuffix__),
  1201. .BR fsinfo (__appmansuffix__),
  1202. .BR fslsfonts (__appmansuffix__),
  1203. .BR fstobdf (__appmansuffix__),
  1204. .BR iceauth (__appmansuffix__),
  1205. .BR imake (__appmansuffix__),
  1206. .BR makedepend (__appmansuffix__),
  1207. .BR mkfontdir (__appmansuffix__),
  1208. .BR oclock (__appmansuffix__),
  1209. .BR resize (__appmansuffix__),
  1210. .BR smproxy (__appmansuffix__),
  1211. .BR twm (__appmansuffix__),
  1212. .BR x11perf (__appmansuffix__),
  1213. .BR x11perfcomp (__appmansuffix__),
  1214. .BR xauth (__appmansuffix__),
  1215. .BR xclipboard (__appmansuffix__),
  1216. .BR xclock (__appmansuffix__),
  1217. .BR xcmsdb (__appmansuffix__),
  1218. .BR xconsole (__appmansuffix__),
  1219. .BR xdm (__appmansuffix__),
  1220. .BR xdpyinfo (__appmansuffix__),
  1221. .BR xfd (__appmansuffix__),
  1222. .BR xfs (__appmansuffix__),
  1223. .BR xfwp (__appmansuffix__),
  1224. .BR xhost (__appmansuffix__),
  1225. .BR xinit (__appmansuffix__),
  1226. .BR xkbbell (__appmansuffix__),
  1227. .BR xkbcomp (__appmansuffix__),
  1228. .BR xkbevd (__appmansuffix__),
  1229. .BR xkbprint (__appmansuffix__),
  1230. .BR xkbvleds (__appmansuffix__),
  1231. .BR xkbwatch (__appmansuffix__),
  1232. .BR xkill (__appmansuffix__),
  1233. .BR xlogo (__appmansuffix__),
  1234. .BR xlsatoms (__appmansuffix__),
  1235. .BR xlsclients (__appmansuffix__),
  1236. .BR xlsfonts (__appmansuffix__),
  1237. .BR xmag (__appmansuffix__),
  1238. .BR xmodmap (__appmansuffix__),
  1239. .BR xprop (__appmansuffix__),
  1240. .BR xrdb (__appmansuffix__),
  1241. .BR xrefresh (__appmansuffix__),
  1242. .BR xrx (__appmansuffix__),
  1243. .BR xset (__appmansuffix__),
  1244. .BR xsetroot (__appmansuffix__),
  1245. .BR xsm (__appmansuffix__),
  1246. .BR xstdcmap (__appmansuffix__),
  1247. .BR xterm (__appmansuffix__),
  1248. .BR xwd (__appmansuffix__),
  1249. .BR xwininfo (__appmansuffix__),
  1250. .BR xwud (__appmansuffix__).
  1251. .\" servers
  1252. .BR Xserver (__appmansuffix__),
  1253. .BR Xorg (__appmansuffix__),
  1254. .BR Xephyr (__appmansuffix__),
  1255. .BR Xnest (__appmansuffix__),
  1256. .BR Xvfb (__appmansuffix__),
  1257. .\" specifications
  1258. .I "Xlib \- C Language X Interface\fR,\fP"
  1259. and
  1260. .I "X Toolkit Intrinsics \- C Language Interface"
  1261. .SH TRADEMARKS
  1262. .PP
  1263. X Window System is a trademark of The Open Group.
  1264. .SH AUTHORS
  1265. .PP
  1266. A cast of thousands, literally. Releases 6.7 and later are
  1267. brought to you by the X.Org Foundation. The names of all people who
  1268. made it a reality will be found in the individual documents and
  1269. source files.
  1270. .PP
  1271. Releases 6.6 and 6.5 were done by The X.Org Group. Release 6.4 was done by
  1272. The X Project Team. The Release 6.3 distribution was from The X Consortium,
  1273. Inc. The staff members at the X Consortium responsible for that release
  1274. were: Donna Converse (emeritus), Stephen Gildea (emeritus), Kaleb Keithley,
  1275. Matt Landau (emeritus), Ralph Mor (emeritus), Janet O'Halloran, Bob
  1276. Scheifler, Ralph Swick, Dave Wiggins (emeritus), and Reed Augliere.
  1277. .PP
  1278. The X Window System standard was originally developed at the
  1279. Laboratory for Computer Science at the Massachusetts Institute
  1280. of Technology, and all rights thereto were assigned to the X Consortium
  1281. on January 1, 1994.
  1282. X Consortium, Inc. closed its doors on December 31, 1996. All rights to the
  1283. X Window System have been assigned to The Open Group.