|
|
1.1 root 1: .TH X 1 "25 January 1986" "X Version 10"
2: .SH NAME
3: X - A network transparent window system for Unix
4: .SH DESCRIPTION
5: .PP
6: X is a network transparent windowing system developed at MIT which
7: runs under Ultrix-32 Version 1.2 and 4.3BSD Unix.
8: .PP
9: X display servers run on computers with bitmap terminals.
10: The server
11: distributes user input to, and accepts output requests from various
12: client programs located either on the same machine or elsewhere in the
13: Internet.
14: While
15: a client normally runs on the same machine as the X server it is talking
16: to, this need not be the case.
17: .PP
18: X supports overlapping windows, fully recursive subwindows, text and
19: graphics operations within windows.
20: For a full explanation of functions, see
21: ``Xlib - C Language X Interface'' document.
22: .PP
23: When you first log in on a display running X, you are
24: using the \fIxterm(1)\fP terminal emulator program.
25: You need not learn anything extra to use a display running X as
26: a terminal beyond moving the mouse cursor into the login window to
27: log in normally.
28: .PP
29: X attempts to provide hooks for your favorite style of user interface;
30: feel free to write your own if you don't like the style provided by
31: existing window managers (see \fIxwm(1)\fP, \fIxnwm(1)\fP, or \fIuwm(1)\fP).
32: These programs are used to manipulate existing top level windows,
33: including moving, resizing, and iconifying existing windows.
34: You should start your favorite window manager when you log in
35: on a display running X.
36: .PP
37: Current client programs of X include a terminal emulator (\fIxterm(1)\fP),
38: window managers (\fIxwm(1)\fP, \fIxnwm(1)\fP and \fIuwm(1)\fP),
39: bitmap editor (\fIbitmap(1)\fP),
40: access control program (\fIxhost(1)\fP),
41: user preference setting program (\fIxset(1)\fP),
42: load monitor (\fIxload(1)\fP), clock (\fIxclock(1)\fP),
43: impress previewer (\fIximpv(1)\fP),
44: font displayer (\fIxfd(1)\fP), demos (\fIxdemo(1)\fP),
45: and editors (e.g., \fIxted\fP).
46: On some systems, mail notification has been integrated (\fIbiff(1)\fP).
47: .SH OPTIONS
48: The following options can be given on the command line to the X server, usually
49: started by \fIinit(1)\fP using information stored in the file \fI/etc/ttys\fP.
50: (see \fIttys(5)\fP, \fIX(8c)\fP for details):
51: .ta \w'-0 color 'u
52: .br
53: \fB-a\fP # sets mouse acceleration (pixels)
54: .br
55: \fB-c\fP turns off key-click
56: .br
57: \fBc\fP # sets key-click volume (0-8)
58: .br
59: \fB-f\fP # sets feep(bell) volume (0-7)
60: .br
61: \fB-l\fP sets LockUpDownMode
62: .br
63: \fBl\fP sets LockToggleMode
64: .br
65: \fBm\fP forces "monochrome" mode on a color display
66: .br
67: \fB-p\fP # sets screen-saver pattern cycle time (minutes)
68: .br
69: \fB-r\fP turns off auto-repeat
70: .br
71: \fBr\fP turns on auto-repeat
72: .br
73: \fB-s\fP # sets screen-saver timeout (minutes)
74: .br
75: \fB-t\fP # sets mouse threshold (pixels)
76: .br
77: \fBv\fP sets video-on screen-saver preference
78: .br
79: \fB-v\fP sets video-off screen-saver preference
80: .br
81: \fB-0\fP \fIcolor\fP sets color map entry 0 (BlackPixel)
82: .br
83: \fB-1\fP \fIcolor\fP sets color map entry 1 (WhitePixel)
84: .br
85: \fB-D\fP \fIrgbdb\fP sets RGB database file
86: .sp
87: The defaults are
88: ``-a 4 c 6 -f 3 l -p 60 r -s 10 -t 2 -0 #008 -1 #ffffff -D /usr/lib/rgb''.
89: .sp 2
90: .SH X DEFAULTS
91: .PP
92: Many X programs follow the convention of using a file called \fI.Xdefaults\fP
93: in your home directory to allow tailoring the default values of many
94: items on the display (default font, border width, icon behavior, and so
95: on).
96: The format of this file is ``programname.keyword:value'',
97: where the default value for each keyword is set to the specified string.
98: If the program name is missing, the default ``keyword'' value is set to the
99: value for all programs.
100: Case is not significant in keywords.
101: Any whitespace before the value is ignored.
102: Any global defaults should precede program defaults in the file.
103: See the manual pages for a list of what defaults can be set in a given program.
104: Here is an overblown example \fI~/.Xdefaults\fP file.
105: .PP
106: .nf
107: .TA .5i 2.5i
108: .ta .5i 2.5i
109: \# this is a comment
110: .BorderWidth: 2
111: .BitmapIcon: on
112: .MakeWindow.Background: #8e8
113: .MakeWindow.Border: #f26
114: .MakeWindow.BodyFont: cor
115: .MakeWindow.Foreground: medium slate blue
116: .MakeWindow.Freeze: on
117: .MakeWindow.Mouse: #e6f
118: .MakeWindow.MouseMask: black
119: .MakeWindow.ClipToScreen: on
120: .Menufreeze: on
121: .Menubackground: maroon
122: .Panefont: 8x13
123: .SelectionFont: 8x13
124: .SelectionBorder: black
125: .Paneborderwidth: 1
126: xterm.Panespread: .25
127: biff.Background: violet red
128: biff.BodyFont: 9x15
129: biff.Border: black
130: biff.Foreground: green yellow
131: biff.Mouse: coral
132: bitmap.Background: forest green
133: bitmap.Border: salmon
134: bitmap.Foreground: white
135: bitmap.Highlight: red
136: bitmap.Mouse: black
137: xclock.Background: plum
138: xclock.Border: black
139: xclock.Foreground: red
140: xclock.Highlight: blue
141: xclock.Mode: analog
142: xshell.action.LeftButton: xterm =80x65-0+0 -fn 6x10
143: xshell.action.MiddleButton: xted =80x65+0-0
144: xshell.action.RightButton: xterm =20x20-0-0 -fn 6x10 -e dc
145: xshell.action.$: xterm =80x65+0+0 -fn 6x10 -e sh
146: xshell.action.#: xterm =80x65+0+0 -fn 6x10 -e su
147: xshell.ReverseVideo: on
148: xshell.WindowGeometry: =-0-0
149: xshell.Quiet: on
150: xdemo.Background: white
151: xdemo.Border: black
152: xdemo.balls.Background: maroon
153: xdemo.balls.Foreground: white
154: xdemo.circles.Foreground: khaki
155: xdemo.draw.Background: light gray
156: xdemo.draw.BodyFont: oldeng
157: xdemo.draw.Foreground: midnight blue
158: xdemo.draw.Mouse: white
159: xdemo.menulife.Background: medium turquoise
160: xdemo.menulife.Foreground: orange red
161: xdemo.menulife.MenuBackground: light blue
162: xdemo.menulife.MenuFont: oldeng
163: xdemo.menulife.MenuForeground: dark orchid
164: xdemo.menulife.MenuMouse: orange
165: xdemo.menulife.Mouse: salmon
166: xdemo.plaid.Foreground: red
167: xdemo.qix.Foreground: violet red
168: xdemo.slide.Foreground: forest green
169: xdemo.wallpaper.Foreground: medium turquoise
170: xdemo.xor.Foreground: blue violet
171: ximpv.Background: dark green
172: ximpv.Border: red
173: ximpv.Foreground: cyan
174: ximpv.Mouse: white
175: xload.Background: #ff0068
176: xload.Border: black
177: xload.Foreground: slate blue
178: xload.Highlight: yellow
179: xload.ReverseVideo: on
180: xted.Background: firebrick
181: xted.BodyFont: kiltercrn
182: xted.Border: tan
183: xted.Cursor: yellow
184: xted.Foreground: white
185: xted.Highlight: goldenrod
186: xted.Mouse: cyan
187: xterm.Background: #355
188: xterm.BodyFont: 6x13p
189: xterm.Cursor: green
190: xterm.Foreground: white
191: xfax.Background: white
192: xfax.Border: green
193: xfax.Foreground: red
194: xfax.Mouse: blue
195: .fi
196: .PP
197: By default when you log in,
198: only programs running on your local computer will be allowed to
199: interact with your display.
200: If someone else on a different machine wants to show you something,
201: you can use the \fIxhost(1)\fP program to allow access to your display.
202: .SH "SIZING WINDOWS"
203: .PP
204: Many programs ask you to manually size their top-level window. When started,
205: such a program will typically popup an identification window in the upper left
206: corner of the display. The window can be created with the center button:
207: press the button to define one corner of the window,
208: move the cursor to where the opposite corner of the window should be
209: and release the button. For text applications, the left and right buttons
210: can also be used. Pressing the left button typically produces an 80 by 24
211: window, which can then be moved around, and placed by releasing the button.
212: Similarly, the right button typically produces an 80 by full screen window.
213: For graphics applications, the left button typically creates a default size
214: window in a default location, while the right button creates a default size
215: window at the position of the cursor.
216: .PP
217: Most applications (e.g., \fIxted\fP,
218: \fIxdemo\fP, and \fIxfax\fP) read options to control sizing
219: of initial windows.
220: The ``MakeWindow.BodyFont'' option controls the font for the
221: popup window.
222: The ``MakeWindow.BorderWidth'' and ``MakeWindow.InternalBorder''
223: options control the outer and inner borders.
224: The ``MakeWindow.ReverseVideo''
225: option can be set to ``on'' to reverse colors. On color displays, the
226: ``MakeWindow.Foreground'', ``MakeWindow.Background'', and ``MakeWindow.Border''
227: options control the color of the popup window, and the ``MakeWindow.Mouse'' and
228: ``MakeWindow.MouseMask'' options control the color of the mouse cursor. The
229: ``MakeWindow.Freeze'' option,
230: when set to ``on'', will stop all other output while
231: the window is sized, and use a steady outline instead of continuously flashing
232: the window outline.
233: The ``MakeWindow.ClipToScreen'' option will clip the resulting window to
234: fit on the screen.
235: (Currently only implemented in programs using
236: the \fIXCreateTerm\fP subroutine.)
237: .SH "GEOMETRY SPECIFICATION"
238: Most programs accept a geometry specification.
239: This allows automatic creation and placement of windows on the screen
240: at login and other convenient times.
241: .B \=\[WIDTH\]\[xHEIGHT\]\[{\+\-}XOFF\[{\+\-}YOFF\]\]
242: The []'s denote optional parameters, the {}'s surround alternatives.
243: WIDTH and HEIGHT are in number of characters for text
244: oriented applications,
245: and usually in pixels for graphics oriented applications.
246: XOFF and YOFF are in
247: pixels.
248: If you don't
249: give XOFF and/or YOFF, then you must use the mouse to create the window.
250: If you give XOFF and/or YOFF, then a WIDTHxHEIGHT window will
251: automatically be creating without intervention.
252: XOFF and YOFF specify deltas
253: from a corner of the screen to the corresponding corner of the window, as
254: follows:
255: .nf
256: .ta .5i 2.5i
257: .br
258: \+XOFF+YOFF upper left to upper left
259: .br
260: \-XOFF+YOFF upper right to upper right
261: .br
262: \+XOFF-YOFF lower left to lower left
263: .br
264: \-XOFF-YOFF lower right to lower right
265: .fi
266: .SH KEYBOARD
267: .PP
268: If you don't like the standard keyboard layout or the default definitions
269: of keymap and function keys, the keyboards on most displays can be remapped to
270: suit your taste. Many programs look for a file called \fI.Xkeymap\fP in your
271: home directory. This is a binary file, produced from a source map with
272: the \fIkeycomp(1)\fP program.
273: .SH COLORS
274: .PP
275: Many programs allow you to specify colors for background, border, text, etc.
276: A color specification can be given either as an english name (see
277: \fI/usr/lib/rgb.txt\fP for defined names), or three hexadecimal values for the
278: red, green, and blue components, in one of the following formats:
279: .PP
280: .nf
281: #RGB
282: #RRGGBB
283: #RRRGGGBBB
284: #RRRRGGGGBBBB
285: .fi
286: .PP
287: .SH "DISPLAY SPECIFICATION"
288: .PP
289: When you first log in, the environment variable ``DISPLAY'' will be
290: set to a string ``machine:display'' (for example, ``mit-athena:0'') which
291: will determine which display an X application will talk to by default.
292: .PP
293: Most applications will also interpret an argument with a ``:'' in it
294: to be the display to use.
295: .PP
296: When using DECnet, the format ``node::display'' should be used.
297: .SH "MENU DEFAULTS"
298: .PP
299: As there is now a standard menu package for X (\fIXMenu(3x)\fP),
300: you can tune the behavior of menus in programs using this package
301: with a set of \fIXdefaults\fP.
302: \fIXterm\fP's `Mode Menu' is controlled by these defaults for
303: example.
304: .PP
305: .TP 8
306: .B MenuFreeze
307: Determines whether or not to grab the
308: .I X
309: server while a menu is posted.
310: One of: on, off.
311: The default value is off.
312: .PP
313: .TP 8
314: .B MenuStyle
315: Determines the menu display style.
316: One of: left_hand, right_hand, center.
317: The default value is right_hand.
318: .PP
319: .TP 8
320: .B MenuMode
321: Determines the menu selection high light mode.
322: One of: box, invert.
323: If box mode is chosen then the SelectionBorderWidth and SelectionBorderColor
324: parameters effect the box line width and color respectively.
325: If invert mode is chose then the SelectionForeground and MenuBackground
326: colors are used for the inversion.
327: The default value is invert.
328: .PP
329: .TP 8
330: .B MenuMouse
331: Determines the color of the mouse cursor while it is within
332: the menu.
333: Any valid
334: .I X
335: color may be used.
336: The default value is black.
337: .PP
338: .TP 8
339: .B MenuBackground
340: Determines the menu background color.
341: Any valid
342: .I X
343: color may be used.
344: The default value is white.
345: .PP
346: .TP 8
347: .B MenuInactivePattern
348: Determines which of the five possible bitmap patterns will be used to tile
349: inactive panes.
350: One of: dimple1, dimple3, gray1, gray3, cross_weave.
351: The default value is gray3.
352: .PP
353: .TP 8
354: .B PaneStyle
355: Determines the display style of all menu panes.
356: One of: flush_left, flush_right, center.
357: The default value is center.
358: .PP
359: .TP 8
360: .B PaneFont
361: Determines the font used for the label (heading text) of each pane.
362: Any valid
363: .I X
364: font may be used.
365: The default value is 8x13.
366: .PP
367: .TP 8
368: .B PaneForeground
369: Determines the pane foreground color.
370: This is the color used for the label (heading text) in each pane.
371: Any valid
372: .I X
373: color may be used.
374: The default value is black.
375: .PP
376: .TP 8
377: .B PaneBorder
378: Determines the color of all menu pane borders.
379: Any valid
380: .I X
381: color may be used.
382: The default value is black.
383: .PP
384: .TP 8
385: .B PaneBorderWidth
386: Determines the width (in pixels) of all menu pane borders.
387: Any integer greater than or equal to 0 may be used.
388: The default value is 2.
389: .PP
390: .TP 8
391: .B PaneSpread
392: Determines the horizontal spread of menu panes.
393: Any double greater than or equal to 0.0 may be used.
394: A value of 1.0 specifies a one to one ratio between horizontal spread and
395: vertical spread.
396: A value less than 1.0 will compress the menu panes inward and a value greater
397: than 1.0 will expand them outward.
398: The default value is 1.0.
399: .PP
400: .TP 8
401: .B SelectionStyle
402: Determines the display style of all menu selections.
403: One of: flush_left, flush_right, center.
404: The default value is flush_left.
405: .PP
406: .TP 8
407: .B SelectionFont
408: Determines the font used for the text in each selection.
409: Any valid X font may be used.
410: The default value is 6x10.
411: .PP
412: .TP 8
413: .B SelectionForeground
414: Determines the selection foreground color.
415: This is the color used for the text in each selection.
416: Any valid
417: .I X
418: color may be used.
419: The default value is black.
420: .PP
421: .TP 8
422: .B SelectionBorder
423: Determines the color of all menu selection borders.
424: Any valid
425: .I X
426: color
427: may be used.
428: The default value is black.
429: .PP
430: .TP 8
431: .B SelectionBorderWidth
432: Determines the width (in pixels) of all menu selection borders.
433: Any integer greater than or equal to 0 may be used.
434: The default value is 1.
435: .PP
436: .TP 8
437: .B SelectionSpread
438: Determines the inter-selection spread.
439: Any double greater than or equal to 0.0 may be used.
440: A value of 1.0 specifies that 1.0 times the height of the current selection
441: font will be used for padding
442: The default value is 0.25.
443: .SH "SEE ALSO"
444: .PP
445: X(8c), xterm(1), bitmap(1), xwm(1), xnwm(1), xhost(1), xclock(1), xload(1), xset(1), keycomp(1), xdemo(1), biff(1), qv(4), vs(4), init(8), ttys(5), uwm(1),
446: xrefresh(1), xwininfo(1), ximpv(1), xdvi(1), pikapix(1), xwd(1), xwud(1),
447: xinit(1), xted(1), xdemo(1), Xqvss(8c), Xvs100(8c), Xsun(8c), Xnest(8c)
448: .br
449: `Xlib - C Language X Interface'
450: .SH AUTHORS
451: .PP
452: It is no longer feasible to list all people who have contributed
453: something to X; below is a short list of people who have added significant
454: code to device independent parts of X.
455: .br
456: Bob Scheifler (MIT-LCS),
457: Jim Gettys (MIT-Project Athena, DEC),
458: Mark Vandevoorde (MIT-Project Athena, DEC),
459: Tony Della Fera (MIT-Project Athena, DEC),
460: Ron Newman (MIT-Project Athena, MIT),
461: Shane Hartman and Stuart Malone (MIT-LCS),
462: Doug Mink (Smithsonian Astrophysical Observatory),
463: Bob McNamara (DEC-MAD),
464: and Stephen Sutphen (University of Alberta).
465: .sp
466: Special thanks must go to Paul Asente (of DECWRL and Stanford University),
467: who wrote "W" which saved us much time and energy early in this project,
468: and who is now an active X contributor as well,
469: and Chris Kent (of DECWRL and Purdue University) who both struggled mightily
470: (and won!) to turn the Vs100 into something useful under Unix.
471: .sp
472: We are very grateful for the interest shown by many groups in the country,
473: which has encouraged us to make X more than our personal toy.
474: Great thanks must go to Digital's Ultrix Engineering Group for the
475: QDSS implementation, and to Digital's Workstations Group for the QVSS
476: implementation.
477: .sp 2
478: Copyright (c) 1984, 1985, 1986 by Massachusetts Institute of Technology.
479: .sp
480: Permission to use, copy, modify, and distribute this
481: software and its documentation for any purpose and without
482: fee is hereby granted, provided that the above copyright
483: notice appear in all copies and that both that copyright
484: notice and this permission notice appear in supporting
485: documentation, and that the name of M.I.T. not be used in
486: advertising or publicity pertaining to distribution of the
487: software without specific, written prior permission.
488: M.I.T. makes no representations about the suitability of
489: this software for any purpose. It is provided "as is"
490: without express or implied warranty.
491: .sp
492: This software is not subject to any license of the American
493: Telephone and Telegraph Company or of the Regents of the
494: University of California.
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.