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