Release new version 0.7.2
[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 ] [ window-manager ]
11
12 Description
13 -----------
14
15 grml-x creates the configuration file for the X server (X.org) letting you
16 override some options and then starts up X server with the specified window
17 manager.
18
19 Implementation
20 --------------
21
22 grml-x depends on the X server to configure itself. It will generate a very
23 minimal xorg.conf, or, at your option, write some common options to it.
24 If an xorg.conf file already exists, grml-x won't touch the file unless the
25 '--force' option is specified.
26
27 If you specify a window manager, the x-window-manager alias will be updated.
28
29 *******************************************************************************
30 Important! Please do **not** run X or grml-x with root permissions!  When used in grml
31 live-cd mode running grml-x works as normal user as well (thanks to sudo). Just
32 switch to an appropriate console where user grml is logged in (for example on
33 tty5 via pressing Alt-F5).
34 If you use grml-x on systems other than grml in live mode you can invoke
35 it as user root but please use the '--nostart' option to avoid startup
36 X server. This allows you to generate a xorg.conf file on harddisk systems
37 as well as on distributions other than grml/Debian.
38 *******************************************************************************
39
40 [NOTE]
41 Notice that you do not have to use grml-x to start X server if you already have
42 a working X config file (usually the case on harddisk installations).  Just
43 adjust $HOME/.xinitrc to your needs (most common is adjusting the exec line for
44 choosing the according windowmanager) and then run startx to start X server.
45
46 Options
47 -------
48
49 XOPTS='...'::
50         Provide options for startx, see 'man 1 startx'.
51
52 --display <number>::
53         Specify display for use with Xserver.
54
55 --force::
56         Force creation of xorg.conf file. This option is also assumed when another
57         option which needs to be write values to the X config file is provided.
58
59 --help::
60         Display help.
61
62 --hsync <number>::
63         Specify horizontal sync frequencies. Use a number like "30-65".
64
65 --mode <width>x<height>::
66         Set resolution for X server.
67
68 --module <name>::
69         Use <name> as module for X server.
70
71 --nostart::
72         Do not start X server. Useful when you only want to generate
73         xorg.conf.
74
75 --vsync <number>::
76         Specify vertical sync frequencies. Use a number like "50-60".
77
78 [[X7]]
79 Usage examples
80 --------------
81
82 grml-x --mode "1280x1024 1024x768" wm-ng::
83         Use resolutions 1280x1024 and 1024x768 and start windowmanager wm-ng.
84
85 grml-x --module vesa openbox::
86         Use vesa-module and start windowmanager openbox.
87
88 grml-x --hsync "30-65" fluxbox::
89         Use 30-65kHz for horizontal sync frequency and start windowmanager fluxbox.
90
91 grml-x --display 8 ratpoison::
92         Use display 8 for Xserver and start windowmanager ratpoison.
93
94 grml-x --nostart -f fluxbox::
95         Force writing of config file but do not start X server. Please do not forget to
96         add a window manager as last option because grml-x changes the according
97         exec-statement in $HOME/.xinitrc.
98
99 Known problems and limitations
100 ------------------------------
101
102 Sometimes the X server does not find the correct resolution and/or frequency
103 settings for the monitor. Please adjust configuration manually using the --hsync
104 and the --vsync options then. Also check out the <<X7,usage examples section>> 
105 in this manpage and the help output of grml-x running 'grml-x --help'.
106
107 Bugs
108 ----
109
110 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes
111 link:http://grml.org/contact/[to us]!
112
113 Author
114 ------
115
116 This manual page and grml-x itself have been written by Michael Prokop
117 <mika@grml.org> and are licensed under the GPL v2 or any later version.