c2e981bea2828991776b22095715c7e424696bdd
[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 \-composite
27 Enable composite extension within /etc/X11/xorg.conf. Disabled by default.
28 .TP
29 .B \-display <number>
30 Specifiy display for use with Xserver.
31 .TP
32 .B \-force
33 Force creation of xconfig file. This option is also assumed when another
34 option which needs to be write values to the X config file is provided. The old
35 X config file (/etc/X11/xorg.conf or /etx/X11/XFree86Config-4) is renamed
36 via adding the extension .old.
37 .TP
38 .B \-genmouse
39 Generate generic entry for mouse using /dev/input/mice and auto protocol.
40 .TP
41 .B \-help
42 Display help.
43 .TP
44 .B \-hsync <number>
45 Specify horizontal sync frequencies. Use a number like "30-65".
46 .TP
47 .B \-mode <width>x<height>
48 Resolution-mode for xserver.
49 .TP
50 .B \-module <name>
51 Module for xserver.
52 .TP
53 .B \-noddc
54 Do not use ddc probing but use static entries for resolution modes.
55 .TP
56 .B \-nohsnc
57 Do not activate HorizSync-entry in xconfig file.
58 .TP
59 .B \-nostart
60 Do not start X server.
61 .TP
62 .B \-nosynaptics
63 Do not activate a present Synaptics touchpad but use it only with 'normal' touchpad
64 functions.
65 .TP
66 .B \-nosync
67 Do not activate horizontal and vertical sync frequencies. This option is useful
68 on many modern computers using a LCD/TFT display. To avoid problems on very old
69 monitors this option is not the default.
70 .TP
71 .B \-novref
72 Do not activate VertRefresh-entry in xconfig file.
73 .TP
74 .B \-ps2
75 Add an entry for PS/2 mouse in the xconfig file.
76 .TP
77 .B \-usb
78 Add an entry for USB mouse in the xconfig file.
79 .TP
80 .B \-vsync <number>
81 Specify vertical sync frequencies. Use a number like "50-60".
82 .TP
83 .B \-xinerama
84 Enable Xinerama support - disabled by default. Xinerama is an X server extension
85 that allows multiple physical screens to behave as a single screen. With traditional
86 multi-head in X11, windows cannot span or cross physical screens.
87
88 Please notice that some window managers are not Xinerama-aware, and so some operations
89 like window placement and resizing might not behave in an ideal way. This is an issue
90 that needs to be dealt with in the individual window managers and not within grml-x
91 or X server.
92 .TP
93 .B \-xserver [XFree86|Xorg]
94 Specify Xserver which should be used for creation of xconfig file.
95 For XFree86 the file /etc/X11/XF86Config-4 is written, for Xorg the
96 file /etc/X11/xorg.conf.
97 .SH USAGE EXAMPLES
98 .TP
99 .B grml-x -mode '1280x1024 1024x768' wmi
100 Use resolutions 1280x1024 and 1024x768 and start windowmanager wmi.
101 .TP
102 .B grml-x -module vesa openbox
103 Use vesa-module and start windowmanager openbox.
104 .TP
105 .B grml-x -hsync "30-65" fluxbox
106 Use 30-65kHz for horizontal sync frequency and start windowmanager fluxbox.
107 .TP
108 .B grml-x -display 8 ratpoison
109 Use display 8 for Xserver and start windowmanager ratpoison.
110 .TP
111 .B grml-x -xinerama -composite openbox
112 Enable Xinerama setup and composite extension and start windowmanager openbox.
113 .TP
114 .B grml-x -nostart -f fluxbox
115 Force writing of config file but do not start X server. Please do not forget to add a window manager as last option because
116 grml-x changes the according exec-statement in $HOME/.xinitrc.
117 .TP
118 .B XOPTS='-depth 16' grml-x fluxbox
119 Set color depth to 16 bit and start windowmanager fluxbox.
120 .SH KNOWN PROBLEMS
121 .TP
122 Sometimes the X server does not find the correct resolution and/or frequency settings for the monitor. Please adjust configuration manually using the -hsync and the -vsync options then. Also check out the usage examples section in this manpage and the help output of grml-x running 'grml-x -help'.
123 .TP
124 The support for the Xinerama extension is brand new within grml-x and has not been tested on many boxes but only on systems using the intel driver of current X server. Please provide feedback!
125 .SH BUGS
126 .TP
127 Please report any problems to the grml-team! http://grml.org/bugs/
128 .SH AUTHOR
129 This manual page was written by the grml-team. http://grml.org/ (c)Michael Prokop <mika@grml.org>