cff712416ee149de1eb98b18c9e3fcc776b006e5
[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) 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. The old
58         X config file (/etc/X11/xorg.conf or /etx/X11/XFree86Config-4) is renamed
59         via adding the extension .old.
60
61 --help::
62         Display help.
63
64 --hsync <number>::
65         Specify horizontal sync frequencies. Use a number like "30-65".
66
67 --mode <width>x<height>::
68         Set resolution for X server.
69
70 --module <name>::
71         Use <name> as module for X server.
72
73 --nostart::
74         Do not start X server (useful when you want to generate new xorg.conf
75         only. Do not forget to use -force option as well if xorg.conf exists
76         already.)
77 --vsync <number>::
78         Specify vertical sync frequencies. Use a number like "50-60".
79
80 [[X7]]
81 Usage examples
82 --------------
83
84 grml-x --mode "1280x1024 1024x768" wm-ng::
85         Use resolutions 1280x1024 and 1024x768 and start windowmanager wm-ng.
86
87 grml-x --module vesa openbox::
88         Use vesa-module and start windowmanager openbox.
89
90 grml-x --hsync "30-65" fluxbox::
91         Use 30-65kHz for horizontal sync frequency and start windowmanager fluxbox.
92
93 grml-x --display 8 ratpoison::
94         Use display 8 for Xserver and start windowmanager ratpoison.
95
96 grml-x --nostart -f fluxbox::
97         Force writing of config file but do not start X server. Please do not forget to
98         add a window manager as last option because grml-x changes the according
99         exec-statement in $HOME/.xinitrc.
100
101 Known problems and limitations
102 ------------------------------
103
104 Sometimes the X server does not find the correct resolution and/or frequency
105 settings for the monitor. Please adjust configuration manually using the --hsync
106 and the --vsync options then. Also check out the <<X7,usage examples section>> 
107 in this manpage and the help output of grml-x running 'grml-x --help'.
108
109 Bugs
110 ----
111
112 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes
113 link:http://grml.org/contact/[to us]!
114
115 Author
116 ------
117
118 This manual page and grml-x itself have been written by Michael Prokop
119 <mika@grml.org> and are licensed under the GPL v2 or any later version.