Clarify that we no longer support i586 but require i686+
[grml.org.git] / online-docs / grml-x.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
4 <head>\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
6 <meta name="generator" content="AsciiDoc 8.2.2" />\r
7 <style type="text/css">\r
8 /* Debug borders */\r
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
10 /*\r
11   border: 1px solid red;\r
12 */\r
13 }\r
14 \r
15 body {\r
16   margin: 1em 5% 1em 5%;\r
17 }\r
18 \r
19 a {\r
20   color: blue;\r
21   text-decoration: underline;\r
22 }\r
23 a:visited {\r
24   color: fuchsia;\r
25 }\r
26 \r
27 em {\r
28   font-style: italic;\r
29 }\r
30 \r
31 strong {\r
32   font-weight: bold;\r
33 }\r
34 \r
35 tt {\r
36   color: navy;\r
37 }\r
38 \r
39 h1, h2, h3, h4, h5, h6 {\r
40   color: #527bbd;\r
41   font-family: sans-serif;\r
42   margin-top: 1.2em;\r
43   margin-bottom: 0.5em;\r
44   line-height: 1.3;\r
45 }\r
46 \r
47 h1 {\r
48   border-bottom: 2px solid silver;\r
49 }\r
50 h2 {\r
51   border-bottom: 2px solid silver;\r
52   padding-top: 0.5em;\r
53 }\r
54 \r
55 div.sectionbody {\r
56   font-family: serif;\r
57   margin-left: 0;\r
58 }\r
59 \r
60 hr {\r
61   border: 1px solid silver;\r
62 }\r
63 \r
64 p {\r
65   margin-top: 0.5em;\r
66   margin-bottom: 0.5em;\r
67 }\r
68 \r
69 pre {\r
70   padding: 0;\r
71   margin: 0;\r
72 }\r
73 \r
74 span#author {\r
75   color: #527bbd;\r
76   font-family: sans-serif;\r
77   font-weight: bold;\r
78   font-size: 1.1em;\r
79 }\r
80 span#email {\r
81 }\r
82 span#revision {\r
83   font-family: sans-serif;\r
84 }\r
85 \r
86 div#footer {\r
87   font-family: sans-serif;\r
88   font-size: small;\r
89   border-top: 2px solid silver;\r
90   padding-top: 0.5em;\r
91   margin-top: 4.0em;\r
92 }\r
93 div#footer-text {\r
94   float: left;\r
95   padding-bottom: 0.5em;\r
96 }\r
97 div#footer-badges {\r
98   float: right;\r
99   padding-bottom: 0.5em;\r
100 }\r
101 \r
102 div#preamble,\r
103 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
104 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
105 div.admonitionblock {\r
106   margin-right: 10%;\r
107   margin-top: 1.5em;\r
108   margin-bottom: 1.5em;\r
109 }\r
110 div.admonitionblock {\r
111   margin-top: 2.5em;\r
112   margin-bottom: 2.5em;\r
113 }\r
114 \r
115 div.content { /* Block element content. */\r
116   padding: 0;\r
117 }\r
118 \r
119 /* Block element titles. */\r
120 div.title, caption.title {\r
121   font-family: sans-serif;\r
122   font-weight: bold;\r
123   text-align: left;\r
124   margin-top: 1.0em;\r
125   margin-bottom: 0.5em;\r
126 }\r
127 div.title + * {\r
128   margin-top: 0;\r
129 }\r
130 \r
131 td div.title:first-child {\r
132   margin-top: 0.0em;\r
133 }\r
134 div.content div.title:first-child {\r
135   margin-top: 0.0em;\r
136 }\r
137 div.content + div.title {\r
138   margin-top: 0.0em;\r
139 }\r
140 \r
141 div.sidebarblock > div.content {\r
142   background: #ffffee;\r
143   border: 1px solid silver;\r
144   padding: 0.5em;\r
145 }\r
146 \r
147 div.listingblock {\r
148   margin-right: 0%;\r
149 }\r
150 div.listingblock > div.content {\r
151   border: 1px solid silver;\r
152   background: #f4f4f4;\r
153   padding: 0.5em;\r
154 }\r
155 \r
156 div.quoteblock > div.content {\r
157   padding-left: 2.0em;\r
158 }\r
159 \r
160 div.attribution {\r
161   text-align: right;\r
162 }\r
163 div.verseblock + div.attribution {\r
164   text-align: left;\r
165 }\r
166 \r
167 div.admonitionblock .icon {\r
168   vertical-align: top;\r
169   font-size: 1.1em;\r
170   font-weight: bold;\r
171   text-decoration: underline;\r
172   color: #527bbd;\r
173   padding-right: 0.5em;\r
174 }\r
175 div.admonitionblock td.content {\r
176   padding-left: 0.5em;\r
177   border-left: 2px solid silver;\r
178 }\r
179 \r
180 div.exampleblock > div.content {\r
181   border-left: 2px solid silver;\r
182   padding: 0.5em;\r
183 }\r
184 \r
185 div.verseblock div.content {\r
186   white-space: pre;\r
187 }\r
188 \r
189 div.imageblock div.content { padding-left: 0; }\r
190 div.imageblock img { border: 1px solid silver; }\r
191 span.image img { border-style: none; }\r
192 \r
193 dl {\r
194   margin-top: 0.8em;\r
195   margin-bottom: 0.8em;\r
196 }\r
197 dt {\r
198   margin-top: 0.5em;\r
199   margin-bottom: 0;\r
200   font-style: italic;\r
201 }\r
202 dd > *:first-child {\r
203   margin-top: 0;\r
204 }\r
205 \r
206 ul, ol {\r
207     list-style-position: outside;\r
208 }\r
209 ol.olist2 {\r
210   list-style-type: lower-alpha;\r
211 }\r
212 \r
213 div.tableblock > table {\r
214   border: 3px solid #527bbd;\r
215 }\r
216 thead {\r
217   font-family: sans-serif;\r
218   font-weight: bold;\r
219 }\r
220 tfoot {\r
221   font-weight: bold;\r
222 }\r
223 \r
224 div.hlist {\r
225   margin-top: 0.8em;\r
226   margin-bottom: 0.8em;\r
227 }\r
228 div.hlist td {\r
229   padding-bottom: 5px;\r
230 }\r
231 td.hlist1 {\r
232   vertical-align: top;\r
233   font-style: italic;\r
234   padding-right: 0.8em;\r
235 }\r
236 td.hlist2 {\r
237   vertical-align: top;\r
238 }\r
239 \r
240 @media print {\r
241   div#footer-badges { display: none; }\r
242 }\r
243 \r
244 div#toctitle {\r
245   color: #527bbd;\r
246   font-family: sans-serif;\r
247   font-size: 1.1em;\r
248   font-weight: bold;\r
249   margin-top: 1.0em;\r
250   margin-bottom: 0.1em;\r
251 }\r
252 \r
253 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {\r
254   margin-top: 0;\r
255   margin-bottom: 0;\r
256 }\r
257 div.toclevel2 {\r
258   margin-left: 2em;\r
259   font-size: 0.9em;\r
260 }\r
261 div.toclevel3 {\r
262   margin-left: 4em;\r
263   font-size: 0.9em;\r
264 }\r
265 div.toclevel4 {\r
266   margin-left: 6em;\r
267   font-size: 0.9em;\r
268 }\r
269 /* Workarounds for IE6's broken and incomplete CSS2. */\r
270 \r
271 div.sidebar-content {\r
272   background: #ffffee;\r
273   border: 1px solid silver;\r
274   padding: 0.5em;\r
275 }\r
276 div.sidebar-title, div.image-title {\r
277   font-family: sans-serif;\r
278   font-weight: bold;\r
279   margin-top: 0.0em;\r
280   margin-bottom: 0.5em;\r
281 }\r
282 \r
283 div.listingblock div.content {\r
284   border: 1px solid silver;\r
285   background: #f4f4f4;\r
286   padding: 0.5em;\r
287 }\r
288 \r
289 div.quoteblock-content {\r
290   padding-left: 2.0em;\r
291 }\r
292 \r
293 div.exampleblock-content {\r
294   border-left: 2px solid silver;\r
295   padding-left: 0.5em;\r
296 }\r
297 \r
298 /* IE6 sets dynamically generated links as visited. */\r
299 div#toc a:visited { color: blue; }\r
300 </style>\r
301 <title>grml-x(1)</title>\r
302 </head>\r
303 <body>\r
304 <div id="header">\r
305 <h1>grml-x(1)</h1>\r
306 </div>\r
307 <h2>Name</h2>\r
308 <div class="sectionbody">\r
309 <p>grml-x - create xorg.conf file and start X window system on grml-system</p>\r
310 </div>\r
311 <h2>Synopsis</h2>\r
312 <div class="sectionbody">\r
313 <p>grml-x [ options ] $windowmanager_you_want_to_use</p>\r
314 </div>\r
315 <h2>Description</h2>\r
316 <div class="sectionbody">\r
317 <p>grml-x creates the configuration file for the X server (X.org) providing\r
318 hardware detection and then starts up X server with the specified window\r
319 manager.</p>\r
320 </div>\r
321 <h2>Implementation</h2>\r
322 <div class="sectionbody">\r
323 <p>grml-x uses hwinfo for collection hardware related information for further\r
324 processing. It creates the X configuration file /etc/X11/xorg.conf for the X\r
325 server (X.org) and needs root permissions therefore. If a X\r
326 config file is present already, grml-x won't touch the file unless the <em>-force</em>\r
327 option or another option which modifies content of the X config file is\r
328 specified. The old config file gets backed up via adding the extension .old\r
329 (available as /etc/X11/xorg.conf.old therefore).</p>\r
330 <p>Afterwards the <em>exec</em> command in $HOME/.xinitrc gets adjusted to start the provided\r
331 window manager and then startx is executed. If $HOME/.xinitrc does not exist a\r
332 simple default one will be created.</p>\r
333 <div class="sidebarblock">\r
334 <div class="sidebar-content">\r
335 <p>Important! Please do <strong>not</strong> run X or grml-x with root permissions!  When used in grml\r
336 live-cd mode running grml-x works as normal user as well (thanks to sudo). Just\r
337 switch to an appropriate console where user grml is logged in (for example on\r
338 tty5 via pressing Alt-F5).\r
339 If you use grml-x on systems other than grml in live mode you can invoke\r
340 it as user root but please use the <em>-nostart</em> option to avoid startup\r
341 X server. This allows you to generate a xorg.conf file on harddisk systems\r
342 as well as on distributions other than grml/Debian.</p>\r
343 </div></div>\r
344 <div class="admonitionblock">\r
345 <table><tr>\r
346 <td class="icon">\r
347 <div class="title">Note</div>\r
348 </td>\r
349 <td class="content">Notice that you do not have to use grml-x to start X server if you already have\r
350 a working X config file (usually the case on harddisk installations).  Just\r
351 adjust $HOME/.xinitrc to your needs (most common is adjusting the exec line for\r
352 choosing the according windowmanager) and then run startx to start X server.</td>\r
353 </tr></table>\r
354 </div>\r
355 </div>\r
356 <h2>Options</h2>\r
357 <div class="sectionbody">\r
358 <dl>\r
359 <dt>\r
360 XOPTS=<em>&#8230;</em>\r
361 </dt>\r
362 <dd>\r
363 <p>\r
364         Provide options for startx, see <em>man 1 startx</em>.\r
365 </p>\r
366 </dd>\r
367 <dt>\r
368 -composite\r
369 </dt>\r
370 <dd>\r
371 <p>\r
372         Enable composite extension within /etc/X11/xorg.conf. Disabled by default.\r
373 </p>\r
374 </dd>\r
375 <dt>\r
376 -display &lt;number&gt;\r
377 </dt>\r
378 <dd>\r
379 <p>\r
380         Specify display for use with Xserver.\r
381 </p>\r
382 </dd>\r
383 <dt>\r
384 -force\r
385 </dt>\r
386 <dd>\r
387 <p>\r
388         Force creation of xorg.conf file. This option is also assumed when another\r
389         option which needs to be write values to the X config file is provided. The old\r
390         X config file (/etc/X11/xorg.conf or /etx/X11/XFree86Config-4) is renamed\r
391         via adding the extension .old.\r
392 </p>\r
393 </dd>\r
394 <dt>\r
395 -genmouse\r
396 </dt>\r
397 <dd>\r
398 <p>\r
399         Generate generic entry for mouse using /dev/input/mice and auto protocol.\r
400 </p>\r
401 </dd>\r
402 <dt>\r
403 -help\r
404 </dt>\r
405 <dd>\r
406 <p>\r
407         Display help.\r
408 </p>\r
409 </dd>\r
410 <dt>\r
411 -hsync &lt;number&gt;\r
412 </dt>\r
413 <dd>\r
414 <p>\r
415         Specify horizontal sync frequencies. Use a number like "30-65".\r
416 </p>\r
417 </dd>\r
418 <dt>\r
419 -mode &lt;width&gt;x&lt;height&gt;\r
420 </dt>\r
421 <dd>\r
422 <p>\r
423         Set resolution for X server.\r
424 </p>\r
425 </dd>\r
426 <dt>\r
427 -module &lt;name&gt;\r
428 </dt>\r
429 <dd>\r
430 <p>\r
431         Use &lt;name&gt; as module for X server.\r
432 </p>\r
433 </dd>\r
434 <dt>\r
435 -noddc\r
436 </dt>\r
437 <dd>\r
438 <p>\r
439         Do not use ddc probing but use static entries for resolution modes.\r
440 </p>\r
441 </dd>\r
442 <dt>\r
443 -nohsync\r
444 </dt>\r
445 <dd>\r
446 <p>\r
447         Do not activate HorizSync-entry in xorg.conf file.\r
448 </p>\r
449 </dd>\r
450 <dt>\r
451 -nostart\r
452 </dt>\r
453 <dd>\r
454 <p>\r
455         Do not start X server (useful when you want to generate new xorg.conf\r
456         only. Do not forget to use -force option as well if xorg.conf exists\r
457         already.)\r
458 </p>\r
459 </dd>\r
460 <dt>\r
461 -nosynaptics\r
462 </dt>\r
463 <dd>\r
464 <p>\r
465         Do not activate a present Synaptics touchpad but use it only with <em>normal</em> touchpad\r
466         functions.\r
467 </p>\r
468 </dd>\r
469 <dt>\r
470 -nosync\r
471 </dt>\r
472 <dd>\r
473 <p>\r
474         Do not activate horizontal and vertical sync frequencies. This option is useful\r
475         on many modern computers using a LCD/TFT display. To avoid problems on very old\r
476         monitors this option is not the default.\r
477 </p>\r
478 </dd>\r
479 <dt>\r
480 -novref\r
481 </dt>\r
482 <dd>\r
483 <p>\r
484         Do not activate VertRefresh-entry in xorg.conf file.\r
485 </p>\r
486 </dd>\r
487 <dt>\r
488 -ps2\r
489 </dt>\r
490 <dd>\r
491 <p>\r
492         Add an entry for PS/2 mouse in the xorg.conf file.\r
493 </p>\r
494 </dd>\r
495 <dt>\r
496 -usb\r
497 </dt>\r
498 <dd>\r
499 <p>\r
500         Add an entry for U  mouse in the xorg.conf file.\r
501 </p>\r
502 </dd>\r
503 <dt>\r
504 -vsync &lt;number&gt;\r
505 </dt>\r
506 <dd>\r
507 <p>\r
508         Specify vertical sync frequencies. Use a number like "50-60".\r
509 </p>\r
510 </dd>\r
511 <dt>\r
512 -xinerama\r
513 </dt>\r
514 <dd>\r
515 <p>\r
516         Enable Xinerama support - disabled by default. Xinerama is an X server extension\r
517         that allows multiple physical screens to behave as a single screen. With\r
518         traditional multi-head in X11, windows cannot span or cross physical screens.\r
519         Please notice that some window managers are not Xinerama-aware, and so some\r
520         operations like window placement and resizing might not behave in an ideal way.\r
521         This is an issue that needs to be dealt with in the individual window managers\r
522         and not within grml-x or X server.\r
523 </p>\r
524 </dd>\r
525 </dl>\r
526 </div>\r
527 <h2><a id="X7"></a>Usage examples</h2>\r
528 <div class="sectionbody">\r
529 <dl>\r
530 <dt>\r
531 grml-x -mode <em>1280x1024 1024x768</em> wmi\r
532 </dt>\r
533 <dd>\r
534 <p>\r
535         Use resolutions 1280x1024 and 1024x768 and start windowmanager wmi.\r
536 </p>\r
537 </dd>\r
538 <dt>\r
539 grml-x -module vesa openbox\r
540 </dt>\r
541 <dd>\r
542 <p>\r
543         Use vesa-module and start windowmanager openbox.\r
544 </p>\r
545 </dd>\r
546 <dt>\r
547 grml-x -hsync "30-65" fluxbox\r
548 </dt>\r
549 <dd>\r
550 <p>\r
551         Use 30-65kHz for horizontal sync frequency and start windowmanager fluxbox.\r
552 </p>\r
553 </dd>\r
554 <dt>\r
555 grml-x -display 8 ratpoison\r
556 </dt>\r
557 <dd>\r
558 <p>\r
559         Use display 8 for Xserver and start windowmanager ratpoison.\r
560 </p>\r
561 </dd>\r
562 <dt>\r
563 grml-x -xinerama -composite openbox\r
564 </dt>\r
565 <dd>\r
566 <p>\r
567         Enable Xinerama setup and composite extension and start windowmanager openbox.\r
568 </p>\r
569 </dd>\r
570 <dt>\r
571 grml-x -nostart -f fluxbox\r
572 </dt>\r
573 <dd>\r
574 <p>\r
575         Force writing of config file but do not start X server. Please do not forget to\r
576         add a window manager as last option because grml-x changes the according\r
577         exec-statement in $HOME/.xinitrc.\r
578 </p>\r
579 </dd>\r
580 <dt>\r
581 XOPTS='-depth 16' grml-x fluxbox\r
582 </dt>\r
583 <dd>\r
584 <p>\r
585         Set color depth to 16 bit and start windowmanager fluxbox.\r
586 </p>\r
587 </dd>\r
588 </dl>\r
589 </div>\r
590 <h2>Known problems and limitations</h2>\r
591 <div class="sectionbody">\r
592 <p>Sometimes the X server does not find the correct resolution and/or frequency\r
593 settings for the monitor. Please adjust configuration manually using the -hsync\r
594 and the -vsync options then. Also check out the <a href="#X7">usage examples section</a> in\r
595 this manpage and the help output of grml-x running <em>grml-x -help</em>.</p>\r
596 <p>The support for the Xinerama extension is brand new within grml-x and has not\r
597 been tested on many boxes but only on systems using the intel driver of current\r
598 X server. Please provide feedback!</p>\r
599 </div>\r
600 <h2>Bugs</h2>\r
601 <div class="sectionbody">\r
602 <p>Please report feedback, <a href="http://grml.org/bugs/">bugreports</a> and wishes\r
603 <a href="http://grml.org/contact/">to us</a>!</p>\r
604 </div>\r
605 <h2>Author</h2>\r
606 <div class="sectionbody">\r
607 <p>This manual page and grml-x itself have been written by Michael Prokop\r
608 &lt;mika@grml.org&gt; and are licensed under the GPL v2 or any later version.</p>\r
609 </div>\r
610 <div id="footer">\r
611 <div id="footer-text">\r
612 Last updated 07-Dec-2007 04:31:39 CEST\r
613 </div>\r
614 </div>\r
615 </body>\r
616 </html>\r