Update debian/rules (binary-arch/-indep)
[grml-x.git] / grml-x.txt
1 grml-x(1)
2 =========
3
4 Name
5 ----
6 grml-x - create xorg.conf file and start X window system on grml-system
7
8 Synopsis
9 --------
10 grml-x [ options ] $windowmanager_you_want_to_use
11
12 Description
13 -----------
14
15 grml-x creates the configuration file for the X server (X.org) providing
16 hardware detection and then starts up X server with the specified window
17 manager.
18
19 Implementation
20 --------------
21
22 grml-x uses hwinfo for collection hardware related information for further
23 processing. It creates the X configuration file /etc/X11/xorg.conf for the X
24 server (X.org) and needs root permissions therefore. If a X
25 config file is present already, grml-x won't touch the file unless the '-force'
26 option or another option which modifies content of the X config file is
27 specified. The old config file gets backed up via adding the extension .old
28 (available as /etc/X11/xorg.conf.old therefore).
29
30 Afterwards the 'exec' command in $HOME/.xinitrc gets adjusted to start the provided
31 window manager and then startx is executed. If $HOME/.xinitrc does not exist a
32 simple default one will be created.
33
34 *******************************************************************************
35 Important! Please do **not** run X or grml-x with root permissions!  When used in grml
36 live-cd mode running grml-x works as normal user as well (thanks to sudo). Just
37 switch to an appropriate console where user grml is logged in (for example on
38 tty5 via pressing Alt-F5).
39 If you use grml-x on systems other than grml in live mode you can invoke
40 it as user root but please use the '-nostart' option to avoid startup
41 X server. This allows you to generate a xorg.conf file on harddisk systems
42 as well as on distributions other than grml/Debian.
43 *******************************************************************************
44
45 [NOTE]
46 Notice that you do not have to use grml-x to start X server if you already have
47 a working X config file (usually the case on harddisk installations).  Just
48 adjust $HOME/.xinitrc to your needs (most common is adjusting the exec line for
49 choosing the according windowmanager) and then run startx to start X server.
50
51 Options
52 -------
53
54 XOPTS='...'::
55         Provide options for startx, see 'man 1 startx'.
56
57 -composite::
58         Enable composite extension within /etc/X11/xorg.conf. Disabled by default.
59
60 -display <number>::
61         Specify display for use with Xserver.
62
63 -force::
64         Force creation of xorg.conf file. This option is also assumed when another
65         option which needs to be write values to the X config file is provided. The old
66         X config file (/etc/X11/xorg.conf or /etx/X11/XFree86Config-4) is renamed
67         via adding the extension .old.
68
69 -genmouse::
70         Generate generic entry for mouse using /dev/input/mice and auto protocol.
71
72 -help::
73         Display help.
74
75 -hsync <number>::
76         Specify horizontal sync frequencies. Use a number like "30-65".
77
78 -mode <width>x<height>::
79         Set resolution for X server.
80
81 -module <name>::
82         Use <name> as module for X server.
83
84 -noddc::
85         Do not use ddc probing but use static entries for resolution modes.
86
87 -nohsync::
88         Do not activate HorizSync-entry in xorg.conf file.
89
90 -nostart::
91         Do not start X server (useful when you want to generate new xorg.conf
92         only. Do not forget to use -force option as well if xorg.conf exists
93         already.)
94
95 -nosynaptics::
96         Do not activate a present Synaptics touchpad but use it only with 'normal' touchpad
97         functions.
98
99 -nosync::
100         Do not activate horizontal and vertical sync frequencies. This option is useful
101         on many modern computers using a LCD/TFT display. To avoid problems on very old
102         monitors this option is not the default.
103
104 -novref::
105         Do not activate VertRefresh-entry in xorg.conf file.
106
107 -ps2::
108         Add an entry for PS/2 mouse in the xorg.conf file.
109
110 -usb::
111         Add an entry for U  mouse in the xorg.conf file.
112
113 -vsync <number>::
114         Specify vertical sync frequencies. Use a number like "50-60".
115
116 -xinerama::
117         Enable Xinerama support - disabled by default. Xinerama is an X server extension
118         that allows multiple physical screens to behave as a single screen. With
119         traditional multi-head in X11, windows cannot span or cross physical screens.
120         Please notice that some window managers are not Xinerama-aware, and so some
121         operations like window placement and resizing might not behave in an ideal way.
122         This is an issue that needs to be dealt with in the individual window managers
123         and not within grml-x or X server.
124
125 [[X7]]
126 Usage examples
127 --------------
128
129 grml-x -mode '1280x1024 1024x768' wmi::
130         Use resolutions 1280x1024 and 1024x768 and start windowmanager wmi.
131
132 grml-x -module vesa openbox::
133         Use vesa-module and start windowmanager openbox.
134
135 grml-x -hsync "30-65" fluxbox::
136         Use 30-65kHz for horizontal sync frequency and start windowmanager fluxbox.
137
138 grml-x -display 8 ratpoison::
139         Use display 8 for Xserver and start windowmanager ratpoison.
140
141 grml-x -xinerama -composite openbox::
142         Enable Xinerama setup and composite extension and start windowmanager openbox.
143
144 grml-x -nostart -f fluxbox::
145         Force writing of config file but do not start X server. Please do not forget to
146         add a window manager as last option because grml-x changes the according
147         exec-statement in $HOME/.xinitrc.
148
149 XOPTS=\'-depth 16\' grml-x fluxbox::
150         Set color depth to 16 bit and start windowmanager fluxbox.
151
152 Known problems and limitations
153 ------------------------------
154
155 Sometimes the X server does not find the correct resolution and/or frequency
156 settings for the monitor. Please adjust configuration manually using the -hsync
157 and the -vsync options then. Also check out the <<X7,usage examples section>> in
158 this manpage and the help output of grml-x running 'grml-x -help'.
159
160 The support for the Xinerama extension is brand new within grml-x and has not
161 been tested on many boxes but only on systems using the intel driver of current
162 X server. Please provide feedback!
163
164 Bugs
165 ----
166
167 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes
168 link:http://grml.org/contact/[to us]!
169
170 Author
171 ------
172
173 This manual page and grml-x itself have been written by Michael Prokop
174 <mika@grml.org> and are licensed under the GPL v2 or any later version.