* initial checkin
[grml-x.git] / grml-x.1
1 .TH GRML-X 1
2 .SH NAME
3 grml-x \- create xconfig file and start X window system on grml-system
4 .SH SYNOPSIS
5 .B grml-x
6 .RI "[ OPTIONS ]" " windowmanager_you_want_to_use"
7 .SH DESCRIPTION
8 grml-x creates the configuration file for X server (X.org or XFree86)
9 and starts up X server with specified window manager.
10 .SH IMPLEMENTATION
11 grml-x uses hwinfo for getting hardware related information.
12 It creates the X config file /etc/X11/xorg.conf for X.org or /etc/X11/XF86Config-4 for
13 XFree86 (needs root permissions therefore). If a X config file is present
14 already, grml-x won't touch the file unless the '-force' option or another option
15 which modifies content of the X config file is specified, the old config file gets backed up
16 via adding the extension .old.
17 Afterwards the 'exec' command in ~/.xinitrc gets adjusted to start the provided window manager
18 and then startx is executed. If ~/.xinitrc does not exist a simple default one will be created.
19 Notice that you do not have to use grml-x to start X server if you already have a working
20 X config file. Adjust ~/.xinitrc to your needs and then run startx to start X server.
21 .SH OPTIONS
22 .TP
23 .B XOPTS='...'
24 Provide options for startx, see 'man 1 startx'.
25 .TP
26 .B \-display <number>
27 Specifiy display for use with Xserver.
28 .TP
29 .B \-force
30 Force creation of xconfig file. This option is also assumed when another
31 option which needs to be write values to the X config file is provided. The old
32 X config file (/etc/X11/xorg.conf or /etx/X11/XFree86Config-4) is renamed
33 via adding the extension .old.
34 .TP
35 .B \-genmouse
36 Generate generic entry for mouse using /dev/input/mice and auto protocol. This option
37 is useful in combination with '-nousb -nops2' for example in VMWare.
38 .TP
39 .B \-help
40 Display help.
41 .TP
42 .B \-hsync <number>
43 Specify horizontal sync frequencies. Use a number like "30-65".
44 .TP
45 .B \-mode <width>x<height>
46 Resolution-mode for xserver.
47 .TP
48 .B \-module <name>
49 Module for xserver.
50 .TP
51 .B \-noddc
52 Do not use ddc probing but use static entries for resolution modes.
53 .TP
54 .B \-nohsnc
55 Do not activate HorizSync-entry in xconfig file.
56 .TP
57 .B \-nops2
58 Deactivate entry for PS/2 mouse.
59 .TP
60 .B \-nostart
61 Do not start X server.
62 .TP
63 .B \-nosynaptics
64 Do not activate a present Synaptics touchpad but use it only with 'normal' touchpad
65 functions.
66 .TP
67 .B \-nosync
68 Do not activate horizontal and vertical sync frequencies. This option is useful
69 on many modern computers using a LCD/TFT display. To avoid problems on very old
70 monitors this option is not the default.
71 .TP
72 .B \-nousb
73 Do not set an entry for USB mouse in the xconfig file.
74 .TP
75 .B \-novref
76 Do not activate VertRefresh-entry in xconfig file.
77 .TP
78 .B \-vsync <number>
79 Specify vertical sync frequencies. Use a number like "50-60".
80 .TP
81 .B \-xserver [XFree86|Xorg]
82 Specify Xserver which should be used for creation of xconfig file.
83 For XFree86 the file /etc/X11/XF86Config-4 is written, for Xorg the
84 file /etc/X11/xorg.conf.
85 .SH EXAMPLES
86 .TP 
87 .B grml-x -mode '1280x1024 1024x768' wmi
88 Use resolutions 1280x1024 and 1024x768 and start windowmanager wmi.
89 .TP
90 .B grml-x -module vesa ion3
91 Use vesa-module and start windowmanager ion3.
92 .TP
93 .B grml-x -hsync "30-65" fluxbox
94 Use 30-65kHz for horizontal sync frequency and start windowmanager fluxbox.
95 .TP 
96 .B grml-x -display 8 ratpoison
97 Use display 8 for Xserver and start windowmanager ratpoison.
98 .TP 
99 .B grml-x -nostart -f fluxbox
100 Force writing of config file but do not start X server. Please do not forget to add a window manager as last option because
101 grml-x changes the according exec-statement in $HOME/.xinitrc.
102 .TP
103 .B XOPTS='-depth 16' grml-x fluxbox
104 Set color depth to 16 bit and start windowmanager fluxbox.
105 .SH BUGS
106 .TP
107 Please report any problems to the grml-team! http://grml.org/bugs/
108 .SH AUTHOR
109 This manual page was written by the grml-team. http://grml.org/ (c)Michael Prokop <mika@grml.org>