diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/Makefile.am | 20 | ||||
| -rw-r--r-- | man/startx.man | 224 | ||||
| -rw-r--r-- | man/xinit.man | 199 |
3 files changed, 443 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..074bc36 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1,20 @@ + +appmandir = $(APP_MAN_DIR) +appman_PRE = startx.man xinit.man +appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX)) + +EXTRA_DIST = $(appman_PRE) +CLEANFILES = $(appman_DATA) +SUFFIXES = .$(APP_MAN_SUFFIX) .man + +MAN_SUBSTS+= -e 's|__XSERVERNAME__|$(XSERVERNAME)|g' \ + -e 's|__XCONFIGFILE__|$(XCONFIGFILE)|g' \ + -e 's|__XCONFIGFILEMAN__|$(XCONFIGFILEMAN)|g' \ + -e 's|__xinitdir__|$(XINITDIR)|g' \ + -e 's|__bindir__|$(bindir)|g' \ + -e 's|__libdir__|$(libdir)|g' \ + -e 's|__SCOMAN__|$(SCOMAN)|g' + +# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure +.man.$(APP_MAN_SUFFIX): + $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@ diff --git a/man/startx.man b/man/startx.man new file mode 100644 index 0000000..0405be0 --- /dev/null +++ b/man/startx.man @@ -0,0 +1,224 @@ +.\" +.\" Copyright 1993, 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. +.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR +.\" 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. +.\" +.\" +.TH STARTX __appmansuffix__ __xorgversion__ +.SH NAME +startx \- initialize an X session +.SH SYNOPSIS +.B startx +[ [ +.I client +] +.I options +\&\.\|.\|. ] [ +.B \-\^\- +[ +.I server +] [ +.I display +] +.I options +\&.\|.\|. ] +.SH DESCRIPTION +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 +.BR xinit (__appmansuffix__). +The special argument +.RB '--' +marks the end of client arguments and the beginning of server options. +It may be convenient to specify server options with startx to change on a +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 +.BR __XSERVERNAME__ (__appmansuffix__) +server and specified in the +.BR __XCONFIGFILEMAN__ +configuration. Some examples of specifying server arguments follow; consult +the manual page for your X server to determine which arguments are legal. +.RS +.PP +startx -- -depth 16 +.PP +startx -- -dpi 100 +.PP +startx -- -layout Multihead +.RE +.if '__SCOMAN__'' .ig +.PP +To determine the client to run, +.B startx +looks for the following files, in order: +.RS +.PP +.I $(HOME)/.startxrc +.PP +.I __libdir__/sys.startxrc +.PP +.I $(HOME)/.xinitrc +.PP +.I __xinitdir__/xinitrc +.RE +.PP +.. +.if !'x.__SCOMAN__'x.' .ig +.PP +To determine the client to run, +.B startx +first looks for a file called +.I .xinitrc +in the user's home directory. If that is not found, it uses +the file +.I xinitrc +in the +.I xinit +library directory. +.. +If command line client options are given, they override this +behavior and revert to the +.BR xinit (__appmansuffix__) +behavior. +To determine the server to run, +.B startx +first looks for a file called +.I .xserverrc +in the user's home directory. If that is not found, it uses +the file +.I xserverrc +in the +.I xinit +library directory. +If command line server options are given, they override this +behavior and revert to the +.BR xinit (__appmansuffix__) +behavior. Users rarely need to provide a +.I .xserverrc +file. +See the +.BR xinit (__appmansuffix__) +manual page for more details on the arguments. +.PP +The system-wide +.I xinitrc +and +.I xserverrc +files are found in the +.I __xinitdir__ +directory. +.PP +The +.I .xinitrc +is typically a shell script which starts many clients according to the +user's preference. When this shell script exits, +.B startx +kills the server and performs any other session shutdown needed. +Most of the clients started by +.I .xinitrc +should be run in the background. The last client should run in the +foreground; when it exits, the session will exit. People often choose +a session manager, window manager, or \fIxterm\fP as the ''magic'' client. +.SH EXAMPLE +.PP +Below is a sample \fI\.xinitrc\fP that starts several applications and +leaves the window manager running as the ''last'' application. Assuming that +the window manager has been configured properly, the user +then chooses the ''Exit'' menu item to shut down X. +.sp +.in +4 +.nf +xrdb \-load $HOME/.Xresources +xsetroot \-solid gray & +xbiff \-geometry \-430+5 & +oclock \-geometry 75x75\-0\-0 & +xload \-geometry \-80\-0 & +xterm \-geometry +0+60 \-ls & +xterm \-geometry +0\-100 & +xconsole \-geometry \-0+0 \-fn 5x7 & +exec twm +.fi +.in -4 +.SH "ENVIRONMENT VARIABLES" +.TP 25 +DISPLAY +This variable gets set to the name of the display to which clients should +connect. Note that this gets +.IR set , +not read. +.TP 25 +XAUTHORITY +This variable, if not already defined, gets set to +.IR $(HOME)/.Xauthority . +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 +.BR Xserver (__appmansuffix__) +and +.IR Xsecurity (__miscmansuffix__) +manual pages for more information on X client/server authentication. +.SH FILES +.if '__SCOMAN__'' .ig +.TP 25 +.I $(HOME)/.startxrc +Client to run. Typically a shell script which runs many programs in +the background. +.TP 25 +.I __libdir__/sys.startxrc +Client to use if the user has no +.I .startxrc +file. +.. +.TP 25 +.I $(HOME)/.xinitrc +Client to run. Typically a shell script which runs many programs in +the background. +.TP 25 +.I $(HOME)/.xserverrc +Server to run. The default is +.IR X . +.TP 25 +.I __xinitdir__/xinitrc +Client to run if the user has no +.I .xinitrc +file. +.TP 25 +.I __xinitdir__/xserverrc +Server to run if the user has no +.I .xserverrc +file. +.SH "SEE ALSO" +.BR xinit (__appmansuffix__), +.BR X (__miscmansuffix__), +.BR Xserver (__appmansuffix__), +.BR __XSERVERNAME__ (__appmansuffix__), +.BR __XCONFIGFILEMAN__ diff --git a/man/xinit.man b/man/xinit.man new file mode 100644 index 0000000..31b93aa --- /dev/null +++ b/man/xinit.man @@ -0,0 +1,199 @@ +.\" +.\" 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. +.\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR +.\" 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. +.\" +.TH XINIT __appmansuffix__ __xorgversion__ +.SH NAME +xinit \- X Window System initializer +.SH SYNOPSIS +.B xinit +[ [ +.I client +] +.I options +\&\.\|.\|. ] [ +.B \-\^\- +[ +.I server +] [ +.I display +] +.I options +\&.\|.\|. ] +.SH DESCRIPTION +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, +\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, \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, +\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. The site administrator should, therefore, make a link to the +appropriate type of server on the machine, or create a shell script that +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: +.sp + 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 +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 \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 \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 +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, \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 \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/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 \-\^\- ./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" +This will start a server named \fIX\fP on display 1 with the arguments +\fI\-a 2 \-t 5\fP. It will then start a remote shell on the machine +\fBfasthost\fP in which it will run the command \fIcpupig\fP, telling it +to display back on the local workstation. +.PP +Below is a sample \fI\.xinitrc\fP that starts a clock, several terminals, and +leaves the window manager running as the ``last'' application. Assuming that +the window manager has been configured properly, the user +then chooses the ``Exit'' menu item to shut down X. +.sp +.in +8 +.nf +xrdb \-load $HOME/.Xresources +xsetroot \-solid gray & +xclock \-g 50x50\-0+0 \-bw 0 & +xload \-g 50x50\-50+0 \-bw 0 & +xterm \-g 80x24+0+0 & +xterm \-g 80x24+0\-0 & +twm +.fi +.in -8 +.sp +Sites that want to create a common startup environment could simply create +a default \fI\.xinitrc\fP that references a site-wide startup file: +.sp +.in +8 +.nf +\&#!/bin/sh +\&. /usr/local/lib/site.xinitrc +.fi +.in -8 +.sp +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: +.sp +.in +8 +.nf +\&#!/bin/sh +xinit /usr/local/lib/site.xinitrc \-\^\- __bindir__/X -br +.fi +.in -8 +.sp +.SH "ENVIRONMENT VARIABLES" +.TP 15 +.B DISPLAY +This variable gets set to the name of the display to which clients should +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 +used. +.SH FILES +.TP 15 +.I .xinitrc +default client script +.TP 15 +.I xterm +client to run if \fI.xinitrc\fP does not exist +.TP 15 +.I .xserverrc +default server script +.TP 15 +.I X +server to run if \fI.xserverrc\fP does not exist +.SH "SEE ALSO" +.BR X (__miscmansuffix__), +.BR startx (__appmansuffix__), +.BR Xserver (__appmansuffix__), +.BR __XSERVERNAME__ (__appmansuffix__), +.BR __XCONFIGFILEMAN__, +.BR xterm (__appmansuffix__) +.SH AUTHOR +Bob Scheifler, MIT Laboratory for Computer Science |