From 189e9e570a1d6bc8664b66506caabffad9774a9a Mon Sep 17 00:00:00 2001 From: Michael Prokop Date: Thu, 12 Jul 2007 02:05:57 +0200 Subject: [PATCH] Switch from manually written nroff manpage to asciidoc instead --- Makefile | 28 ++++++++++ debian/changelog | 6 ++- debian/control | 4 +- grml-x.1 | 129 ---------------------------------------------- grml-x.txt | 154 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 189 insertions(+), 132 deletions(-) create mode 100644 Makefile delete mode 100644 grml-x.1 create mode 100644 grml-x.txt diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..8cd1e53 --- /dev/null +++ b/Makefile @@ -0,0 +1,28 @@ +all: doc + +doc: doc_man doc_html + +doc_html: html-stamp + +html-stamp: grml-x.txt + asciidoc -b xhtml11 grml-x.txt + touch html-stamp + +doc_man: man-stamp + +man-stamp: grml-x.txt + asciidoc -d manpage -b docbook grml-x.txt + sed -i 's///' grml-x.xml + xsltproc /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl grml-x.xml + # ugly hack to avoid duplicate empty lines in manpage + # notice: docbook-xsl 1.71.0.dfsg.1-1 is broken! make sure you use 1.68.1.dfsg.1-0.2! + cp grml-x.1 grml-x.1.tmp + uniq grml-x.1.tmp > grml-x.1 + rm grml-x.1.tmp + touch man-stamp + +online: + scp grml-x.html grml:/var/www/grml/grml-x/index.html + +clean: + rm -rf grml-x.html grml-x.xml grml-x.1 html-stamp man-stamp diff --git a/debian/changelog b/debian/changelog index 0137aeb..4ae2888 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,10 +1,14 @@ grml-x (0.3.28) unstable; urgency=low * Initial support for Xinemera setup using -xinerama option. - [Testing: issue241] + Added 'bc' to Depends. [Testing: issue241] * Support activating composite extension on cmdline using the -composite option. (By default it's deactivated.) * Remove some blank lines in generated xorg.conf. + * Switch from manually written nroff manpage to asciidoc + instead. Adjusted Build-Depends therefore (asciidoc, xsltproc, + docbook-xsl). The manual page is available online as well now: + http://grml.org/grml-x/ -- Michael Prokop Thu, 12 Jul 2007 01:20:52 +0200 diff --git a/debian/control b/debian/control index 0ee0bfd..866e0d6 100644 --- a/debian/control +++ b/debian/control @@ -2,12 +2,12 @@ Source: grml-x Section: grml Priority: optional Maintainer: Michael Prokop -Build-Depends: debhelper (>= 4.0.0) +Build-Depends: debhelper (>= 4.0.0), asciidoc, xsltproc, docbook-xsl Standards-Version: 3.7.2 Package: grml-x Architecture: all -Depends: ${shlibs:Depends}, ${misc:Depends}, xserver-xorg | xserver, hwinfo, grml-etc (>= 0.5-20), grml-etc-core (>= 0.2.46), zsh, pciutils, sudo, xbase-clients, grml-shlib +Depends: ${shlibs:Depends}, ${misc:Depends}, xserver-xorg | xserver, hwinfo, grml-etc (>= 0.5-20), grml-etc-core (>= 0.2.46), zsh, pciutils, sudo, xbase-clients, grml-shlib, bc Recommends: fluxbox | x-window-manager, xterm | x-terminal-emulator, xfonts-base, xserver-xorg-input-vmmouse, xcursor-themes Suggests: xfonts-100dpi, xfonts-75dpi, fonts-ttf-west-european, xfonts-base-transcoded Conflicts: grml-scripts (<= 0.4-4) diff --git a/grml-x.1 b/grml-x.1 deleted file mode 100644 index c2e981b..0000000 --- a/grml-x.1 +++ /dev/null @@ -1,129 +0,0 @@ -.TH GRML-X 1 -.SH NAME -grml-x \- create xconfig file and start X window system on grml-system -.SH SYNOPSIS -.B grml-x -.RI "[ OPTIONS ]" " windowmanager_you_want_to_use" -.SH DESCRIPTION -grml-x creates the configuration file for X server (X.org or XFree86) -and starts up X server with specified window manager. -.SH IMPLEMENTATION -grml-x uses hwinfo for getting hardware related information. -It creates the X config file /etc/X11/xorg.conf for X.org or /etc/X11/XF86Config-4 for -XFree86 (needs root permissions therefore). If a X config file is present -already, grml-x won't touch the file unless the '-force' option or another option -which modifies content of the X config file is specified, the old config file gets backed up -via adding the extension .old. -Afterwards the 'exec' command in ~/.xinitrc gets adjusted to start the provided window manager -and then startx is executed. If ~/.xinitrc does not exist a simple default one will be created. -Notice that you do not have to use grml-x to start X server if you already have a working -X config file. Adjust ~/.xinitrc to your needs and then run startx to start X server. -.SH OPTIONS -.TP -.B XOPTS='...' -Provide options for startx, see 'man 1 startx'. -.TP -.B \-composite -Enable composite extension within /etc/X11/xorg.conf. Disabled by default. -.TP -.B \-display -Specifiy display for use with Xserver. -.TP -.B \-force -Force creation of xconfig file. This option is also assumed when another -option which needs to be write values to the X config file is provided. The old -X config file (/etc/X11/xorg.conf or /etx/X11/XFree86Config-4) is renamed -via adding the extension .old. -.TP -.B \-genmouse -Generate generic entry for mouse using /dev/input/mice and auto protocol. -.TP -.B \-help -Display help. -.TP -.B \-hsync -Specify horizontal sync frequencies. Use a number like "30-65". -.TP -.B \-mode x -Resolution-mode for xserver. -.TP -.B \-module -Module for xserver. -.TP -.B \-noddc -Do not use ddc probing but use static entries for resolution modes. -.TP -.B \-nohsnc -Do not activate HorizSync-entry in xconfig file. -.TP -.B \-nostart -Do not start X server. -.TP -.B \-nosynaptics -Do not activate a present Synaptics touchpad but use it only with 'normal' touchpad -functions. -.TP -.B \-nosync -Do not activate horizontal and vertical sync frequencies. This option is useful -on many modern computers using a LCD/TFT display. To avoid problems on very old -monitors this option is not the default. -.TP -.B \-novref -Do not activate VertRefresh-entry in xconfig file. -.TP -.B \-ps2 -Add an entry for PS/2 mouse in the xconfig file. -.TP -.B \-usb -Add an entry for USB mouse in the xconfig file. -.TP -.B \-vsync -Specify vertical sync frequencies. Use a number like "50-60". -.TP -.B \-xinerama -Enable Xinerama support - disabled by default. Xinerama is an X server extension -that allows multiple physical screens to behave as a single screen. With traditional -multi-head in X11, windows cannot span or cross physical screens. - -Please notice that some window managers are not Xinerama-aware, and so some operations -like window placement and resizing might not behave in an ideal way. This is an issue -that needs to be dealt with in the individual window managers and not within grml-x -or X server. -.TP -.B \-xserver [XFree86|Xorg] -Specify Xserver which should be used for creation of xconfig file. -For XFree86 the file /etc/X11/XF86Config-4 is written, for Xorg the -file /etc/X11/xorg.conf. -.SH USAGE EXAMPLES -.TP -.B grml-x -mode '1280x1024 1024x768' wmi -Use resolutions 1280x1024 and 1024x768 and start windowmanager wmi. -.TP -.B grml-x -module vesa openbox -Use vesa-module and start windowmanager openbox. -.TP -.B grml-x -hsync "30-65" fluxbox -Use 30-65kHz for horizontal sync frequency and start windowmanager fluxbox. -.TP -.B grml-x -display 8 ratpoison -Use display 8 for Xserver and start windowmanager ratpoison. -.TP -.B grml-x -xinerama -composite openbox -Enable Xinerama setup and composite extension and start windowmanager openbox. -.TP -.B grml-x -nostart -f fluxbox -Force writing of config file but do not start X server. Please do not forget to add a window manager as last option because -grml-x changes the according exec-statement in $HOME/.xinitrc. -.TP -.B XOPTS='-depth 16' grml-x fluxbox -Set color depth to 16 bit and start windowmanager fluxbox. -.SH KNOWN PROBLEMS -.TP -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'. -.TP -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! -.SH BUGS -.TP -Please report any problems to the grml-team! http://grml.org/bugs/ -.SH AUTHOR -This manual page was written by the grml-team. http://grml.org/ (c)Michael Prokop diff --git a/grml-x.txt b/grml-x.txt new file mode 100644 index 0000000..6778cee --- /dev/null +++ b/grml-x.txt @@ -0,0 +1,154 @@ +grml-x(1) +========= + +Name +---- +grml-x - create xorg.conf file and start X window system on grml-system + +Synopsis +-------- +grml-x [ OPTIONS ] $windowmanager_you_want_to_use + +Description +----------- + +grml-x creates the configuration file for the X server (X.org) +and starts up X server with specified window manager. + +Implementation +-------------- + +grml-x uses hwinfo for getting hardware related information. It creates the X config file /etc/X11/xorg.conf for X.org or /etc/X11/XF86Config-4 for XFree86 +(needs root permissions therefore). If a X config file is present already, grml-x won't touch the file unless the '-force' option or another option which modifies +content of the X config file is specified, the old config file gets backed up via adding the extension .old. + +Afterwards the 'exec' command in ~/.xinitrc gets adjusted to start the provided window manager and then startx is executed. If ~/.xinitrc does not exist a simple +default one will be created. Notice that you do not have to use grml-x to start X server if you already have a working X config file. Adjust ~/.xinitrc to your +needs and then run startx to start X server. + +Options +------- + +XOPTS='...':: + Provide options for startx, see 'man 1 startx'. + +-composite:: + Enable composite extension within /etc/X11/xorg.conf. Disabled by default. + +-display :: + Specify display for use with Xserver. + +-force:: + Force creation of xorg.conf file. This option is also assumed when another + option which needs to be write values to the X config file is provided. The old + X config file (/etc/X11/xorg.conf or /etx/X11/XFree86Config-4) is renamed + via adding the extension .old. + +-genmouse:: + Generate generic entry for mouse using /dev/input/mice and auto protocol. + +-help:: + Display help. + +-hsync :: + Specify horizontal sync frequencies. Use a number like "30-65". + +-mode x:: + Set resolution for X server. + +-module :: + Use as module for X server. + +-noddc: + Do not use ddc probing but use static entries for resolution modes. + +-nohsync:: + Do not activate HorizSync-entry in xorg.conf file. + +-nostart:: + Do not start X server (useful when you want to generate new xorg.conf + only. Do not forget to use -force option as well if xorg.conf exists + already.) + +-nosynaptics:: + Do not activate a present Synaptics touchpad but use it only with 'normal' touchpad + functions. + +-nosync:: + Do not activate horizontal and vertical sync frequencies. This option is useful + on many modern computers using a LCD/TFT display. To avoid problems on very old + monitors this option is not the default. + +-novref:: + Do not activate VertRefresh-entry in xorg.conf file. + +-ps2:: + Add an entry for PS/2 mouse in the xorg.conf file. + +-usb:: + Add an entry for U mouse in the xorg.conf file. + +-vsync :: + Specify vertical sync frequencies. Use a number like "50-60". + +-xinerama:: + Enable Xinerama support - disabled by default. Xinerama is an X server extension + that allows multiple physical screens to behave as a single screen. With + traditional multi-head in X11, windows cannot span or cross physical screens. + Please notice that some window managers are not Xinerama-aware, and so some + operations like window placement and resizing might not behave in an ideal way. + This is an issue that needs to be dealt with in the individual window managers + and not within grml-x or X server. + +[[X7]] +Usage examples +-------------- + +grml-x -mode '1280x1024 1024x768' wmi:: + Use resolutions 1280x1024 and 1024x768 and start windowmanager wmi. + +grml-x -module vesa openbox:: + Use vesa-module and start windowmanager openbox. + +grml-x -hsync "30-65" fluxbox:: + Use 30-65kHz for horizontal sync frequency and start windowmanager fluxbox. + +grml-x -display 8 ratpoison:: + Use display 8 for Xserver and start windowmanager ratpoison. + +grml-x -xinerama -composite openbox:: + Enable Xinerama setup and composite extension and start windowmanager openbox. + +grml-x -nostart -f fluxbox:: + Force writing of config file but do not start X server. Please do not forget to + add a window manager as last option because grml-x changes the according + exec-statement in $HOME/.xinitrc. + +XOPTS=\'-depth 16\' grml-x fluxbox:: + Set color depth to 16 bit and start windowmanager fluxbox. + +Known problems and limitations +------------------------------ + +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 <> in +this manpage and the help output of grml-x running 'grml-x -help'. + +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! + +Bugs +---- + +Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes +link:http://grml.org/contact/[to us]! + +Author +------ + +grml-x and this manual page have been written by Michael Prokop +and are licensed under the GPL v2 or any later version. + +# vim: ft=asciidoc expandtab -- 2.1.4