Debian Codegraph @

upstream/fedora-44/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.3" "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 To determine the client to run,
73 .B startx
74 first checks the environment variable
75 .I XINITRC
76 for a filename. If that variable is unset, or does not contain a filename,
77 it looks for a file called
78 .I .xinitrc
79 in the user's home directory. If that is not found, it uses
80 the file
81 .I xinitrc
82 in the
83 .I xinit
84 library directory.
85 If command line client options are given, they override this
86 behavior and revert to the
87 .BR xinit (1)
88 behavior.
89 To determine the server to run,
90 .B startx
91 checks the environment variable
92 .I XSERVERRC
93 for a filename. If that variable is unset, or does not contain a filename,
94 it looks for a file called
95 .I .xserverrc
96 in the user's home directory. If that is not found, it uses
97 the file
98 .I xserverrc
99 in the
100 .I xinit
101 library directory.
102 If command line server options are given, they override this
103 behavior and revert to the
104 .BR xinit (1)
105 behavior. Users rarely need to provide a
106 .I .xserverrc
107 file.
108 See the
109 .BR xinit (1)
110 manual page for more details on the arguments.
111 .PP
112 The system-wide
113 .I xinitrc
114 and
115 .I xserverrc
116 files are found in the
117 .I /etc/X11/xinit
118 directory.
119 .PP
120 The
121 .I .xinitrc
122 is typically a shell script which starts many clients according to the
123 user's preference. When this shell script exits,
124 .B startx
125 kills the server and performs any other session shutdown needed.
126 Most of the clients started by
127 .I .xinitrc
128 should be run in the background. The last client should run in the
129 foreground; when it exits, the session will exit. People often choose
130 a session manager, window manager, or \fIxterm\fP as the ''magic'' client.
131 .SH EXAMPLE
132 .PP
133 Below is a sample \fI\.xinitrc\fP that starts several applications and
134 leaves the window manager running as the ''last'' application. Assuming that
135 the window manager has been configured properly, the user
136 then chooses the ''Exit'' menu item to shut down X.
137 .sp
138 .in +4
139 .nf
140 xrdb \-load $HOME/.Xresources
141 xsetroot \-solid gray &
142 xbiff \-geometry \-430+5 &
143 oclock \-geometry 75x75\-0\-0 &
144 xload \-geometry \-80\-0 &
145 xterm \-geometry +0+60 \-ls &
146 xterm \-geometry +0\-100 &
147 xconsole \-geometry \-0+0 \-fn 5x7 &
148 exec twm
149 .fi
150 .in -4
151 .SH "ENVIRONMENT VARIABLES"
152 .TP 25
153 DISPLAY
154 This variable gets set to the name of the display to which clients should
155 connect. Note that this gets
156 .IR set ,
157 not read.
158 .TP 25
159 XAUTHORITY
160 This variable, if not already defined, gets set to
161 .IR $(HOME)/.Xauthority .
162 This is to prevent the X server, if not given the
163 .I \-auth
164 argument, from automatically setting up insecure host-based authentication
165 for the local host. See the
166 .BR Xserver (1)
167 and
168 .IR Xsecurity (7)
169 manual pages for more information on X client/server authentication.
170 .TP 25
171 XINITRC
172 This variable should contain the location of an xinitrc file. If unset,
173 .I $(HOME)/.xinitrc
174 or
175 .I /etc/X11/xinit/xinitrc
176 will be used.
177 .TP 25
178 XSERVERRC
179 This variable should contain the location of an xserver file. If unset,
180 .I $(HOME)/.xserverrc
181 or
182 .I /etc/X11/xinit/xserverrc
183 will be used.
184 .SH FILES
185 .TP 25
186 .I $(HOME)/.xinitrc
187 Client to run. Typically a shell script which runs many programs in
188 the background.
189 .TP 25
190 .I $(HOME)/.xserverrc
191 Server to run. The default is
192 .IR X .
193 .TP 25
194 .I /etc/X11/xinit/xinitrc
195 Client to run if the user has no
196 .I .xinitrc
197 file.
198 .TP 25
199 .I /etc/X11/xinit/xserverrc
200 Server to run if the user has no
201 .I .xserverrc
202 file.
203 .SH "SEE ALSO"
204 .BR xinit (1),
205 .BR X (7),
206 .BR Xserver (1),
207 .BR Xorg (1),
208 .BR xorg.conf (5)