From 536a3e66159bb4cbd75b861b9b942da5b1885a26 Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Sat, 3 Oct 2009 15:21:20 -0700 Subject: Man page updates Signed-off-by: Alan Coopersmith --- startx.man | 34 ++++++++++++++-------------- xinit.man | 75 +++++++++++++++++++++++++++++++------------------------------- 2 files changed, 55 insertions(+), 54 deletions(-) diff --git a/startx.man b/startx.man index 33e731c..73eab50 100644 --- a/startx.man +++ b/startx.man @@ -26,7 +26,7 @@ .\" .\" $XFree86: xc/programs/xinit/startx.man,v 1.7 2001/04/19 15:08:32 dawes Exp $ .\" -.TH STARTX 1 __xorgversion__ +.TH STARTX __appmansuffix__ __xorgversion__ .SH NAME startx \- initialize an X session .SH SYNOPSIS @@ -45,14 +45,16 @@ startx \- initialize an X session .I options \&.\|.\|. ] .SH DESCRIPTION -The \fIstartx\fP script is a front end to \fIxinit\fP that provides a +The \fBstartx\fP script is a front end to +.BR xinit (__appmansuffix__) +that provides a somewhat nicer user interface for running a single session of the X Window System. It is often run with no arguments. .PP Arguments immediately following the .I startx command are used to start a client in the same manner as -.IR xinit (1). +.BR xinit (__appmansuffix__). The special argument .RB '--' marks the end of client arguments and the beginning of server options. @@ -61,9 +63,9 @@ per-session basis the default color depth, the server's notion of the number of dots-per-inch the display device presents, or take advantage of a different server layout, as permitted by the -.IR __XSERVERNAME__ (1) +.BR __XSERVERNAME__ (__appmansuffix__) server and specified in the -.IR __XCONFIGFILE__ (__filemansuffix__) +.BR __XCONFIGFILE__ (__filemansuffix__) file. Some examples of specifying server arguments follow; consult the manual page for your X server to determine which arguments are legal. .RS @@ -77,7 +79,7 @@ startx -- -layout Multihead #ifdef __SCOMAN__ .PP To determine the client to run, -.I startx +.B startx looks for the following files, in order: .RS .PP @@ -93,7 +95,7 @@ looks for the following files, in order: #else .PP To determine the client to run, -.I startx +.B startx first looks for a file called .I .xinitrc in the user's home directory. If that is not found, it uses @@ -105,10 +107,10 @@ library directory. #endif If command line client options are given, they override this behavior and revert to the -.IR xinit (1) +.BR xinit (__appmansuffix__) behavior. To determine the server to run, -.I startx +.B startx first looks for a file called .I .xserverrc in the user's home directory. If that is not found, it uses @@ -119,12 +121,12 @@ in the library directory. If command line server options are given, they override this behavior and revert to the -.IR xinit (1) +.BR xinit (__appmansuffix__) behavior. Users rarely need to provide a .I .xserverrc file. See the -.IR xinit (1) +.BR xinit (__appmansuffix__) manual page for more details on the arguments. .PP The system-wide @@ -139,7 +141,7 @@ The .I .xinitrc is typically a shell script which starts many clients according to the user's preference. When this shell script exits, -.I startx +.B startx kills the server and performs any other session shutdown needed. Most of the clients started by .I .xinitrc @@ -181,7 +183,7 @@ This is to prevent the X server, if not given the .I \-auth argument, from automatically setting up insecure host-based authentication for the local host. See the -.IR Xserver (1) +.BR Xserver (__appmansuffix__) and .IR Xsecurity (__miscmansuffix__) manual pages for more information on X client/server authentication. @@ -216,6 +218,6 @@ Server to run if the user has no .I .xserverrc file. .SH "SEE ALSO" -.IR xinit (1), -.IR Xserver (1), -.IR __XSERVERNAME__ (1) +.BR xinit (__appmansuffix__), +.BR Xserver (__appmansuffix__), +.BR __XSERVERNAME__ (__appmansuffix__) diff --git a/xinit.man b/xinit.man index a60187a..b9c1965 100644 --- a/xinit.man +++ b/xinit.man @@ -1,15 +1,15 @@ .\" $Xorg: xinit.man,v 1.4 2001/02/09 02:05:49 xorgcvs Exp $ .\" Copyright 1988, 1998 The Open Group -.\" +.\" .\" Permission to use, copy, modify, distribute, and sell this software and its .\" documentation for any purpose is hereby granted without fee, provided that .\" the above copyright notice appear in all copies and that both that .\" copyright notice and this permission notice appear in supporting .\" documentation. -.\" +.\" .\" The above copyright notice and this permission notice shall be included .\" in all copies or substantial portions of the Software. -.\" +.\" .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. @@ -17,15 +17,15 @@ .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR .\" OTHER DEALINGS IN THE SOFTWARE. -.\" +.\" .\" Except as contained in this notice, the name of The Open Group shall .\" not be used in advertising or otherwise to promote the sale, use or .\" other dealings in this Software without prior written authorization .\" from The Open Group. -.\" +.\" .\" $XFree86: xc/programs/xinit/xinit.man,v 3.9 2001/02/07 23:25:56 dawes Exp $ -.\" -.TH XINIT 1 __xorgversion__ +.\" +.TH XINIT __appmansuffix__ __xorgversion__ .SH NAME xinit \- X Window System initializer .SH SYNOPSIS @@ -44,33 +44,32 @@ xinit \- X Window System initializer .I options \&.\|.\|. ] .SH DESCRIPTION -The \fIxinit\fP program is used to start the X Window System server and a first -client program on systems that -cannot start X directly from \fI/etc/init\fP or in environments -that use multiple window systems. When this first client exits, -\fIxinit\fP will kill the X server and then terminate. +The \fBxinit\fP program is used to start the X Window System server and a first +client program on systems that are not using a display manager such as +.BR xdm (__appmansuffix__) +or in environments +that use multiple window systems. When this first client exits, +\fBxinit\fP will kill the X server and then terminate. .PP If no specific client program is given on the command line, -\fIxinit\fP will look for a file in the user's home directory +\fBxinit\fP will look for a file in the user's home directory called \fI.xinitrc\fP to run as a shell script to start up client programs. -If no such file exists, \fIxinit\fP will use the following as a default: +If no such file exists, \fBxinit\fP will use the following as a default: .sp xterm \-geometry +1+1 \-n login \-display :0 .sp .PP If no specific server program is given on the command line, -\fIxinit\fP will look for a file in the user's home directory +\fBxinit\fP will look for a file in the user's home directory called \fI.xserverrc\fP to run as a shell script to start up the server. If no such file exists, \fIxinit\fP will use the following as a default: .sp X :0 .sp Note that this assumes that there is a program named \fIX\fP in the current -search path. However, servers are usually named \fIXdisplaytype\fP where -\fIdisplaytype\fP is the type of graphics display which is driven by this -server. The site administrator should, therefore, make a link to the +search path. The site administrator should, therefore, make a link to the appropriate type of server on the machine, or create a shell script that -runs \fIxinit\fP with the appropriate server. +runs \fBxinit\fP with the appropriate server. .PP Note, when using a \fI.xserverrc\fP script be sure to ``exec'' the real X server. Failing to do this can make the X server slow to start and exit. For example: @@ -78,49 +77,49 @@ Failing to do this can make the X server slow to start and exit. For example: exec Xdisplaytype .PP An important point is that programs which are run by \fI\.xinitrc\fP -should be run in the background if they do +should be run in the background if they do not exit right away, so that they don't prevent other programs from starting up. However, the last long-lived program started (usually a window manager or terminal emulator) should be left in the foreground so that the script won't exit (which -indicates that the user is done and that \fIxinit\fP should exit). +indicates that the user is done and that \fBxinit\fP should exit). .PP An alternate client and/or server may be specified on the command line. The desired client program and its arguments should be given -as the first command line arguments to \fIxinit\fP. To specify a particular -server command line, append a double dash (\-\^\-) to the \fIxinit\fP command +as the first command line arguments to \fBxinit\fP. To specify a particular +server command line, append a double dash (\-\^\-) to the \fBxinit\fP command line (after any client and arguments) followed by the desired server command. .PP Both the client program name and the server program name must begin with a slash (/) or a period (.). Otherwise, they are treated as an arguments to be -appended to their respective startup lines. This makes it possible to -add arguments (for example, foreground and background colors) without +appended to their respective startup lines. This makes it possible to +add arguments (for example, foreground and background colors) without having to retype the whole command line. .PP If an explicit server name is not given and the first argument following the -double dash (\-\^\-) is a colon followed by a digit, \fIxinit\fP will use that -number as the display -number instead of zero. All remaining arguments are appended to the server +double dash (\-\^\-) is a colon followed by a digit, \fBxinit\fP will use that +number as the display +number instead of zero. All remaining arguments are appended to the server command line. .PP .SH EXAMPLES -Below are several examples of how command line arguments in \fIxinit\fP are +Below are several examples of how command line arguments in \fBxinit\fP are used. .TP 8 .B "xinit" This will start up a server named \fIX\fP and run the user's \fI\.xinitrc\fP, if it exists, or else start an \fIxterm\fP. .TP 8 -.B "xinit \-\^\- /usr/local/bin/Xqdss :1" +.B "xinit \-\^\- /usr/local/bin/Xvnc :1" This is how one could start a specific type of server on an alternate display. .TP 8 .B "xinit \-geometry =80x65+10+10 \-fn 8x13 \-j \-fg white \-bg navy" This will start up a server named \fIX\fP, and will append the given arguments to the default \fIxterm\fP command. It will ignore \fI\.xinitrc\fP. .TP 8 -.B "xinit \-e widgets \-\^\- ./Xsun \-l \-c" -This will use the command \fI\.\/Xsun \-l \-c\fP to start the server and will +.B "xinit \-e widgets \-\^\- ./Xorg \-l \-c" +This will use the command \fI\.\/Xorg \-l \-c\fP to start the server and will append the arguments \fI\-e widgets\fP to the default \fIxterm\fP command. .TP 8 .B "xinit /usr/ucb/rsh fasthost cpupig \-display ws:1 \-\^\- :1 \-a 2 \-t 5" @@ -156,7 +155,7 @@ a default \fI\.xinitrc\fP that references a site-wide startup file: .fi .in -8 .sp -Another approach is to write a script that starts \fIxinit\fP with a specific +Another approach is to write a script that starts \fBxinit\fP with a specific shell script. Such scripts are usually named \fIx11\fP, \fIxstart\fP, or \fIstartx\fP and are a convenient way to provide a simple interface for novice users: @@ -176,7 +175,7 @@ connect. .TP 15 .B XINITRC This variable specifies an init file containing shell commands to start up the -initial windows. By default, \fI\.xinitrc\fP in the home directory will be +initial windows. By default, \fI\.xinitrc\fP in the home directory will be used. .SH FILES .TP 15 @@ -192,9 +191,9 @@ default server script .I X server to run if \fI.xserverrc\fP does not exist .SH "SEE ALSO" -.IR X (__miscmansuffix__), -.IR startx (1), -.IR Xserver (1), -.IR xterm (1) +.BR X (__miscmansuffix__), +.BR startx (__appmansuffix__), +.BR Xserver (__appmansuffix__), +.BR xterm (__appmansuffix__) .SH AUTHOR Bob Scheifler, MIT Laboratory for Computer Science -- cgit v1.2.3