Debian Codegraph @

upstream/debian-unstable/man1/startx.1

raw
1 .\"
2 .\" Copyright 1993, 1998 The Open Group
3 .\"
4 .\" Permission to use, copy, modify, distribute, and sell this software and its
5 .\" documentation for any purpose is hereby granted without fee, provided that
6 .\" the above copyright notice appear in all copies and that both that
7 .\" copyright notice and this permission notice appear in supporting
8 .\" documentation.
9 .\"
10 .\" The above copyright notice and this permission notice shall be included
11 .\" in all copies or substantial portions of the Software.
12 .\"
13 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
14 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
15 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
16 .\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
17 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
18 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
19 .\" OTHER DEALINGS IN THE SOFTWARE.
20 .\"
21 .\" Except as contained in this notice, the name of The Open Group shall
22 .\" not be used in advertising or otherwise to promote the sale, use or
23 .\" other dealings in this Software without prior written authorization
24 .\" from The Open Group.
25 .\"
26 .\"
27 .TH STARTX 1 "xinit 1.4.2" "X Version 11"
28 .SH NAME
29 startx \- initialize an X session
30 .SH SYNOPSIS
31 .B startx
32 [ [
33 .I client
34 ]
35 .I options
36 \&\.\|.\|. ] [
37 .B \-\^\-
38 [
39 .I server
40 ] [
41 .I display
42 ]
43 .I options
44 \&.\|.\|. ]
45 .SH DESCRIPTION
46 The \fBstartx\fP script is a front end to
47 .BR xinit (1)
48 that provides a
49 somewhat nicer user interface for running a single session of the X
50 Window System. It is often run with no arguments.
51 .PP
52 Arguments immediately following the
53 .I startx
54 command are used to start a client in the same manner as
55 .BR xinit (1).
56 The special argument
57 .RB '\-\^\-'
58 marks the end of client arguments and the beginning of server options.
59 It may be convenient to specify server options with startx to change them on a
60 per-session basis.
61 Some examples of specifying server arguments follow; consult
62 the manual page for your X server to determine which arguments are legal.
63 .RS
64 .PP
65 startx \-\^\- \-depth 16
66 .PP
67 startx \-\^\- \-dpi 100
68 .PP
69 startx \-\^\- \-layout Multihead
70 .RE
71 .PP
72 Note that in the Debian system, what many people traditionally put in the
73 .I .xinitrc
74 file should go in
75 .I .xsession
76 instead; this permits the same X environment to be presented whether
77 .IR startx ,
78 .IR xdm ,
79 or
80 .I xinit
81 is used to start the X session. All discussion of the
82 .I .xinitrc
83 file in the
84 .IR xinit (1)
85 manual page applies equally well to
86 .IR .xsession.
87 Keep in mind that
88 .I .xinitrc
89 is used only by
90 .IR xinit (1)
91 and completely ignored by
92 .IR xdm (1).
93 .PP
94 To determine the client to run,
95 .B startx
96 first checks the environment variable
97 .I XINITRC
98 for a filename. If that variable is unset, or does not contain a filename,
99 it looks for a file called
100 .I .xinitrc
101 in the user's home directory. If that is not found, it uses
102 the file
103 .I xinitrc
104 in the
105 .I xinit
106 library directory.
107 If command line client options are given, they override this
108 behavior and revert to the
109 .BR xinit (1)
110 behavior.
111 To determine the server to run,
112 .B startx
113 checks the environment variable
114 .I XSERVERRC
115 for a filename. If that variable is unset, or does not contain a filename,
116 it looks for a file called
117 .I .xserverrc
118 in the user's home directory. If that is not found, it uses
119 the file
120 .I xserverrc
121 in the
122 .I xinit
123 library directory.
124 If command line server options are given, they override this
125 behavior and revert to the
126 .BR xinit (1)
127 behavior. Users rarely need to provide a
128 .I .xserverrc
129 file.
130 See the
131 .BR xinit (1)
132 manual page for more details on the arguments.
133 .PP
134 The system-wide
135 .I xinitrc
136 and
137 .I xserverrc
138 files are found in the
139 .I /etc/X11/xinit
140 directory.
141 .SH "ENVIRONMENT VARIABLES"
142 .TP 25
143 DISPLAY
144 This variable gets set to the name of the display to which clients should
145 connect. Note that this gets
146 .IR set ,
147 not read.
148 .TP 25
149 XAUTHORITY
150 This variable, if not already defined, gets set to
151 .IR $(HOME)/.Xauthority .
152 This is to prevent the X server, if not given the
153 .I \-auth
154 argument, from automatically setting up insecure host-based authentication
155 for the local host. See the
156 .BR Xserver (1)
157 and
158 .IR Xsecurity (7)
159 manual pages for more information on X client/server authentication.
160 .TP 25
161 XINITRC
162 This variable should contain the location of an xinitrc file. If unset,
163 .I $(HOME)/.xinitrc
164 or
165 .I /etc/X11/xinit/xinitrc
166 will be used.
167 .TP 25
168 XSERVERRC
169 This variable should contain the location of an xserver file. If unset,
170 .I $(HOME)/.xinitrc
171 or
172 .I /etc/X11/xinit/xserverrc
173 will be used.
174 .SH FILES
175 .TP 25
176 .I $(HOME)/.xinitrc
177 Client to run. Typically a shell script which runs many programs in
178 the background.
179 .TP 25
180 .I $(HOME)/.xserverrc
181 Server to run. The default is
182 .IR X .
183 .TP 25
184 .I /etc/X11/xinit/xinitrc
185 Client to run if the user has no
186 .I .xinitrc
187 file.
188 .TP 25
189 .I /etc/X11/xinit/xserverrc
190 Server to run if the user has no
191 .I .xserverrc
192 file.
193 .SH "SEE ALSO"
194 .BR xinit (1),
195 .BR X (7),
196 .BR Xserver (1),
197 .BR Xorg (1),
198 .BR xorg.conf (5)