Updated zsh completion for grml-x. Thanks, ft!
[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.
37 .TP
38 .B \-help
39 Display help.
40 .TP
41 .B \-hsync <number>
42 Specify horizontal sync frequencies. Use a number like "30-65".
43 .TP
44 .B \-mode <width>x<height>
45 Resolution-mode for xserver.
46 .TP
47 .B \-module <name>
48 Module for xserver.
49 .TP
50 .B \-noddc
51 Do not use ddc probing but use static entries for resolution modes.
52 .TP
53 .B \-nohsnc
54 Do not activate HorizSync-entry in xconfig file.
55 .TP
56 .B \-nostart
57 Do not start X server.
58 .TP
59 .B \-nosynaptics
60 Do not activate a present Synaptics touchpad but use it only with 'normal' touchpad
61 functions.
62 .TP
63 .B \-nosync
64 Do not activate horizontal and vertical sync frequencies. This option is useful
65 on many modern computers using a LCD/TFT display. To avoid problems on very old
66 monitors this option is not the default.
67 .TP
68 .B \-novref
69 Do not activate VertRefresh-entry in xconfig file.
70 .TP
71 .B \-ps2
72 Add an entry for PS/2 mouse in the xconfig file.
73 .TP
74 .B \-usb
75 Add an entry for USB mouse in the xconfig file.
76 .TP
77 .B \-vsync <number>
78 Specify vertical sync frequencies. Use a number like "50-60".
79 .TP
80 .B \-xserver [XFree86|Xorg]
81 Specify Xserver which should be used for creation of xconfig file.
82 For XFree86 the file /etc/X11/XF86Config-4 is written, for Xorg the
83 file /etc/X11/xorg.conf.
84 .SH EXAMPLES
85 .TP 
86 .B grml-x -mode '1280x1024 1024x768' wmi
87 Use resolutions 1280x1024 and 1024x768 and start windowmanager wmi.
88 .TP
89 .B grml-x -module vesa ion3
90 Use vesa-module and start windowmanager ion3.
91 .TP
92 .B grml-x -hsync "30-65" fluxbox
93 Use 30-65kHz for horizontal sync frequency and start windowmanager fluxbox.
94 .TP 
95 .B grml-x -display 8 ratpoison
96 Use display 8 for Xserver and start windowmanager ratpoison.
97 .TP 
98 .B grml-x -nostart -f fluxbox
99 Force writing of config file but do not start X server. Please do not forget to add a window manager as last option because
100 grml-x changes the according exec-statement in $HOME/.xinitrc.
101 .TP
102 .B XOPTS='-depth 16' grml-x fluxbox
103 Set color depth to 16 bit and start windowmanager fluxbox.
104 .SH BUGS
105 .TP
106 Please report any problems to the grml-team! http://grml.org/bugs/
107 .SH AUTHOR
108 This manual page was written by the grml-team. http://grml.org/ (c)Michael Prokop <mika@grml.org>