From: Andreas "Jimmy" Gredler Date: Sat, 15 Mar 2014 08:19:03 +0000 (-0700) Subject: Drop .sp workaround, fix some typos in manpages and remove duplicated text X-Git-Tag: v0.13.0~5 X-Git-Url: https://git.grml.org/?p=grml-autoconfig.git;a=commitdiff_plain;h=bedd7c2ba3847ed39ab4c923c6e0f9e12873e4f9 Drop .sp workaround, fix some typos in manpages and remove duplicated text Manpage was including the text .5v at the end of some paragraphs. This was caused by an old hack in the Makefile which removed the text .sp, which was accidently added to the end of some paragraphs. (sed -i 's/\.sp//') Looks like this hack is not needed any longer, when disabling it the .5v disappears as well (which might have been the text ".sp 5v") --- diff --git a/doc/Makefile b/doc/Makefile index 45b10e6..802ced6 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -5,8 +5,6 @@ asciidoc -d manpage -b docbook $^ #sed -i 's///g' `echo $^ |sed -e 's/.txt/.xml/'` xsltproc -nonet /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl `echo $^ |sed -e 's/.txt/.xml/'` > /dev/null 2>&1 - # ugly hack to avoid '.sp' at the end of a sentence or paragraph: - sed -i 's/\.sp//' `echo $^ | sed -e 's/.txt//'` gzip -f --best `echo $^ |sed -e 's/.txt//'` MANPAGES = grml-autoconfig.1 grml-autoconfig.8 restore-config.1 save-config.1 diff --git a/doc/grml-autoconfig.1.txt b/doc/grml-autoconfig.1.txt index f741008..0b49815 100644 --- a/doc/grml-autoconfig.1.txt +++ b/doc/grml-autoconfig.1.txt @@ -47,36 +47,6 @@ link:http://wiki.grml.org/doku.php?id=persistency[] for further information. [[current-versions]] include::grml-autoconfig.current.txt[] -Permanently adjust boot parameters -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -As you probably know you can adjust boot parameters on the bootprompt. You want -to set some boot parameters permanently? That's possible via adding a directory -named 'bootparams' to the Grml ISO which has to be located at the root-directory -/bootparams/ (note: the directory is known as /lib/live/mount/medium/bootparams/ on a -_running_ Grml system then). Place a textfile inside the directory containing -the boot parameters which should be appended to default ones (this corresponds -to booting without any special parameters). - - mkdir bootparams - echo lang=de > bootparams/my_bootparams - -Then burn a multisession CD where directory bootparams is located in the root -directory of the CD. - -[NOTE] -Not all boot parameters can be used via /bootparams/. This is a limitation of -the way the kernel and userspace retrieve boot parameters. Boot parameter -regarding the kernel definitely do *NOT* work. Boot parameter related to -grml-autoconfig (the main part of the boot process in Grml running in userspace, -being all the stuff after startup of udev) are expected to work. Boot parameter -related to initrd/initramfs (the part between 'Searching for GRML file' and -startup of udev) are *NOT* covered by /bootparams/ as well yet. - -TIP: the application k3b (not available on the live-CD but available through the -Debian repositories) provides an easy to use interface for doing the -multisession task. - [[X7]] Usage scenarios --------------- @@ -86,7 +56,7 @@ Personal configuration files You are a fan of the editor vim? Great. You probably have your own ~/.vimrc and want to use it on the Grml system. You also don't like the default zsh -configuration and want to use your own ~/.zshrc? How to procede? Copy your +configuration and want to use your own ~/.zshrc? How to proceed? Copy your .vimrc and .zshrc to $HOME of user 'grml'. Place additional files in $HOME/config. Now create a configuration for your files running: @@ -164,31 +134,32 @@ Now boot from your new personalized Grml CD using the debs parameter: Run your own commands on startup ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You know that booting with 'grml services=foobar' executes /etc/init.d/foobar -when booting Grml. But you want to setup a more complex network configuration, -adjust some other stuff and so on on your own? Just write a script named grml.sh -which does the job and use own of the mentioned bootparams. Let's say you have -placed grml.sh on your usb device (usb stick) then use the following commandline -on bootprompt: +You know that booting with 'grml services=foobar' executes +/etc/init.d/foobar when booting Grml. But you want to setup a more +complex network configuration, adjust some other stuff and so on, on +your own? Just write a script named grml.sh which does the job and use +one of the mentioned boot parameters. Let's say you have placed grml.sh +on your usb device (usb stick) then use the following commandline on +bootprompt: grml myconfig=/dev/sda1 Or even better: create a device with label GRMLCFG running (adjust /dev/sdX1 according to your needs): - mkfs.ext3 -L GRMLCFG /dev/sdX1 # warning: this destroys all data from /dev/sdX1 + mkfs.ext3 -L GRMLCFG /dev/sdX1 # warning: this destroys all data on /dev/sdX1 TIP: several filesystems provide the possibility to provide a label. For example FAT provides this through: 'mkfs.vfat -n GRMLCFG /dev/sda1' (attention: this will destroy data on /dev/sda1 of course!). Take a look at the documentation/manpage of the filesystem you want to use. -Now place your configuration archive (see save-config and the other usage -scenarios) and the script grml.sh on the device. Now you can boot your system -without specifying any bootparameters on bootprompt because devices labeled with -GRMLCFG are mounted readonly and used by default. If you did not label your -device you can use the device anyway using 'grml myconfig=/dev/sdX' (adjust -/dev/sdX) on the bootprompt. +Now place your configuration archive (see save-config and the other +usage scenarios) and the script grml.sh on the device. Now you can boot +your system without specifying any boot parameters on bootprompt because +devices labeled with GRMLCFG are mounted readonly and used by default. +If you did not label your device you can use the device anyway using +'grml myconfig=/dev/sdX' (adjust /dev/sdX) on the bootprompt. Debug remote systems ~~~~~~~~~~~~~~~~~~~~ @@ -212,7 +183,7 @@ saveconfig and the boot parameter myconfig. Or you put a grml.iso file on your hard disk (maybe in /boot/grml) or on an USB stick, use grub to boot from there and place debs, configuration scripts or Grml -configuraton archives alongside the .iso. +configuration archives alongside the .iso. Bugs ---- diff --git a/doc/grml-autoconfig.current.txt b/doc/grml-autoconfig.current.txt index 0fd1909..b775a58 100644 --- a/doc/grml-autoconfig.current.txt +++ b/doc/grml-autoconfig.current.txt @@ -18,7 +18,7 @@ GRMLCFG the proper label can be set via the autoconfig boot parameter (autoconfig=SOMELABEL, for example). Without any additional boot parameters, the GCA at DCSDIR/config.tbz is -automatically unpacked and DCSDIR/scrips/grml.sh is automatically executed on +automatically unpacked and DCSDIR/scripts/grml.sh is automatically executed on system startup. The 'noautoconfig' boot parameter disables this automatic behavior. @@ -136,8 +136,8 @@ debnet:: noautoconfig:: Deactivate automounting. By default the scripts try to mount a device with - label 'GRMLCFG'. If you specify the noautoconfig bootparam this automounting - will be deactivated. + label 'GRMLCFG'. If you specify the noautoconfig boot parameter this + automounting will be deactivated. noautoconfig => disables auto mounting of label 'GRMLCFG'