[Fai-commit] r5389 - in trunk: debian man
Michael Tautschnig
mt at alioth.debian.org
Sun May 3 13:55:26 UTC 2009
Author: mt
Date: 2009-05-03 13:55:26 +0000 (Sun, 03 May 2009)
New Revision: 5389
Modified:
trunk/debian/changelog
trunk/man/ainsl.1
trunk/man/fai-cd.8
trunk/man/fai-chboot.8
trunk/man/fai-mirror.1
trunk/man/fai.8
trunk/man/fcopy.8
trunk/man/ftar.8
trunk/man/make-fai-nfsroot.8
trunk/man/setup-storage.8
Log:
a first set of hyphen-used-as-minus-sign bugfixes (committing to trunk with
permission of Thomas)
Modified: trunk/debian/changelog
===================================================================
--- trunk/debian/changelog 2009-05-02 23:20:29 UTC (rev 5388)
+++ trunk/debian/changelog 2009-05-03 13:55:26 UTC (rev 5389)
@@ -1,12 +1,16 @@
fai (3.2.20) unstable; urgency=low
+ [ Thomas Lange ]
* menu.lst: remove year
* fai-cd: add option -B, that creates a boot-only CD (without containing
the nfsroot, the partitial mirror and the config space)
* conf/menu.lst.boot-only: new config file for the boot only CD
* fai-cd.8: add option -B
+
+ [ Michael Tautschnig ]
+ * fixed several hyphen-used-as-minus-sign errors in man pages
- -- Thomas Lange <lange at debian.org> Sun, 03 May 2009 01:12:40 +0200
+ -- Thomas Lange <lange at debian.org> Sun, 03 May 2009 15:54:53 +0200
fai (3.2.19) unstable; urgency=low
Modified: trunk/man/ainsl.1
===================================================================
--- trunk/man/ainsl.1 2009-05-02 23:20:29 UTC (rev 5388)
+++ trunk/man/ainsl.1 2009-05-03 13:55:26 UTC (rev 5389)
@@ -55,12 +55,12 @@
Create verbose output.
.SH EXAMPLES
.br
-ainsl -v /etc/fstab '/dev/fd0 /floppy auto users,noauto 0 0'
+ainsl \-v /etc/fstab '/dev/fd0 /floppy auto users,noauto 0 0'
Append the entry for the floppy device to /etc/fstab, if this line
isn't already inlcuded.
-ainsl -s /etc/exports '/srv/www @linuxhosts(async,rw) backup(async,ro)'
+ainsl \-s /etc/exports '/srv/www @linuxhosts(async,rw) backup(async,ro)'
Add exports entry without exactly matching spaces.
Modified: trunk/man/fai-cd.8
===================================================================
--- trunk/man/fai-cd.8 2009-05-02 23:20:29 UTC (rev 5388)
+++ trunk/man/fai-cd.8 2009-05-03 13:55:26 UTC (rev 5389)
@@ -38,10 +38,10 @@
fai-cd \- make a bootable CD-ROM or USB stick that performs an FAI
.SH SYNOPSIS
.B fai-cd
-[\fIOPTION\fR] -m MIRROR \fIFILE\fR
+[\fIOPTION\fR] \-m MIRROR \fIFILE\fR
.br
.B fai-cd
-[\fIOPTION\fR] -m MIRROR \fI-u DIRECTORY\fR
+[\fIOPTION\fR] \-m MIRROR \fI-u DIRECTORY\fR
.br
.B fai-cd
[\fIOPTION\fR] -B \fIFILE\fR
@@ -101,12 +101,12 @@
After you've created a mirror with fai-mirror in /media/mirror, you
can create a CD using:
- # fai-cd -m /media/mirror fai-cd.iso
+ # fai-cd \-m /media/mirror fai-cd.iso
If you want to create a bootable USB stick, create an ext2 file system
on your stick, mount it to /media/usbstick and call
- # fai-cd -m /media/mirror -u /media/usbstick
+ # fai-cd \-m /media/mirror \-u /media/usbstick
# umount /media/usbstick
.SH SEE ALSO
Modified: trunk/man/fai-chboot.8
===================================================================
--- trunk/man/fai-chboot.8 2009-05-02 23:20:29 UTC (rev 5388)
+++ trunk/man/fai-chboot.8 2009-05-03 13:55:26 UTC (rev 5389)
@@ -15,22 +15,22 @@
[OPTION]... KERNELNAME HOST...
.br
.B fai-chboot
--l[e|d|t|o|g] [PATTERN]
+\-l[e|d|t|o|g] [PATTERN]
.br
.B fai-chboot
--e HOST...
+\-e HOST...
.br
.B fai-chboot
--d HOST...
+\-d HOST...
.br
.B fai-chboot
--c HOST|TEMPLATE HOST|TEMPLATE...
+\-c HOST|TEMPLATE HOST|TEMPLATE...
.br
.B fai-chboot
--i [OPTION]... HOST...
+\-i [OPTION]... HOST...
.br
.B fai-chboot
--I [OPTION]... HOST...
+\-I [OPTION]... HOST...
.SH DESCRIPTION
This command creates the configuration files for network booting using
pxelinux and DHCP.
@@ -45,7 +45,7 @@
.SH OPTIONS
.TP
.BI \-B
-Set default values for FAI_FLAGS. This is the same as -f
+Set default values for FAI_FLAGS. This is the same as \-f
verbose,sshd,reboot
.TP
.B \-c
@@ -120,33 +120,33 @@
Use SUFFIX to determine which kernel and initrd to use.
.TP
.BI \-S
-Same as -i but also sets FAI_ACTION=sysinfo.
+Same as \-i but also sets FAI_ACTION=sysinfo.
.TP
.B \-v
Create verbose output.
.SH EXAMPLES
.TP
-fai-chboot -l
+fai-chboot \-l
List the configuration for all hosts.
.TP
-fai-chboot -iFv atom02 atom03 dom kueppers
+fai-chboot \-iFv atom02 atom03 dom kueppers
The hosts atom02, atom03, dom and kueppers will boot the FAI install
kernel. FAI_ACTION will not be set unless specified with option
--k or -I. You can also use the script class/LAST.var on the install server
+\-k or \-I. You can also use the script class/LAST.var on the install server
to set FAI_ACTION.
.TP
-fai-chboot -FSv atom02
+fai-chboot \-FSv atom02
The host atom02 will boot the FAI install kernel but with FAI_ACTION sysinfo.
.TP
-fai-chboot -IBv atom02
+fai-chboot \-IBv atom02
The host atom02 will be installed. ATTENTION! All data on the local
hard disks are lost in most cases, because we want to install a new
system. After the installation the host automatically reboots.
.TP
-fai-chboot -v atom-localboot atom03
+fai-chboot \-v atom-localboot atom03
Next time atom03 will boot the kernel atom-localboot.
.TP
-fai-chboot -vS -s2.6.18-4-amd64 faiserver
+fai-chboot \-vS \-s2.6.18-4-amd64 faiserver
Booting kernel vmlinuz-2.6.18-4-amd64
append initrd=initrd.img-2.6.18-4-amd64 ip=dhcp
@@ -159,11 +159,11 @@
memtest86+ and copy the executable memtest86+.bin to /srv/tftp/fai
without the .bin suffix.
.TP
-fai-chboot -o default
+fai-chboot \-o default
All hosts, that do not have a PXE configuration for their IP-address
will do a localboot, i.e. booting from local disk.
.TP
-fai-chboot -vc lenny64 james007
+fai-chboot \-vc lenny64 james007
This command will tell the host james007 to use the template called lenny64.
Beforehand, you have to manually create the template
and save it to /srv/tftp/fai/pxelinux.cfg/lenny64.tmpl.
Modified: trunk/man/fai-mirror.1
===================================================================
--- trunk/man/fai-mirror.1 2009-05-02 23:20:29 UTC (rev 5388)
+++ trunk/man/fai-mirror.1 2009-05-03 13:55:26 UTC (rev 5389)
@@ -62,7 +62,7 @@
.TP
.BI "\-c " CLASS[,CLASS]
Use only this list of classes for building the mirror. Can't be used
-in conjunction with -x.
+in conjunction with \-x.
.TP
.BI \-h
Show simple help and version.
@@ -79,12 +79,12 @@
.SH EXAMPLES
.br
- # fai-mirror -v /files/scratch/mirror
+ # fai-mirror \-v /files/scratch/mirror
Creates a partial mirror in the directory /files/scratch/mirror
using all classes.
- # fai-mirror -v -cDEFAULT,DEMO /debmirror
+ # fai-mirror \-v \-cDEFAULT,DEMO /debmirror
Creates a partial mirror containing all packages used in the classes
DEFAULT and DEMO.
Modified: trunk/man/fai.8
===================================================================
--- trunk/man/fai.8 2009-05-02 23:20:29 UTC (rev 5388)
+++ trunk/man/fai.8 2009-05-03 13:55:26 UTC (rev 5389)
@@ -115,9 +115,9 @@
.B dirinstall [DIR]
Installation into a directory. This is nearly the same action as
install except for skipping the task that partitions the hard disks and
-creates the file systems. Classes can be defined with option -c, or by
-giving the hostname with -u or --hostname and enabling automatic definition
-by class scripts from hostname with -N. (Without -N class scripts aren't
+creates the file systems. Classes can be defined with option \-c, or by
+giving the hostname with \-u or \-\-hostname and enabling automatic definition
+by class scripts from hostname with \-N. (Without \-N class scripts aren't
executed)
.SH NOTES
@@ -125,7 +125,7 @@
certainly destroy it.
.SH EXAMPLES
- fai -v dirinstall /srv/etchroot -cDEFAULT,FAIBASE,LAST
+ fai \-v dirinstall /srv/etchroot \-cDEFAULT,FAIBASE,LAST
This command will do an installation into the directory
/src/etchroot. For defining variables, selecting the software packages
Modified: trunk/man/fcopy.8
===================================================================
--- trunk/man/fcopy.8 2009-05-02 23:20:29 UTC (rev 5388)
+++ trunk/man/fcopy.8 2009-05-03 13:55:26 UTC (rev 5389)
@@ -31,7 +31,7 @@
file, a log message is printed to standard output.
.SH OPTIONS
.TP
-Options -c, -s, -t and a SOURCE are required. Usually -c, -s and -t
+Options \-c, \-s, \-t and a SOURCE are required. Usually \-c, \-s and \-t
are set via variables in FAI.
.TP
.B \-B
@@ -80,7 +80,7 @@
SOURCE CLASS COMMENT
.br
where COMMENT gives some information about why the file has been
-preserved (especially useful in combination with -P). If not specified and
+preserved (especially useful in combination with \-P). If not specified and
$LOGDIR is set, use $LOGDIR/fcopy.log.
.TP
.BI "\-m " user,group,mode
@@ -88,17 +88,17 @@
group numeric id or name). If not specified, use file file-modes or data of source file.
.TP
.BI "\-M "
-Use default values for user, group and mode. This is equal to -m root,root,0644
+Use default values for user, group and mode. This is equal to \-m root,root,0644
.TP
.BI "\-n "
-Print the commands, but do not execute them. This is like --dry-run in
+Print the commands, but do not execute them. This is like \-\-dry-run in
other programs. You can enable it for all calls of fcopy by setting
the environment variable $FCOPY_DRYRUN.
.TP
.BI "\-P " plog,changes
Don't compare files literally, but use information from files \fIplog\fR and \fIchanges\fR:
A file is overwritten when either another class applies (\fIplog\fR is a
-log generated with -L in the previous run, so it now contains the necessary
+log generated with \-L in the previous run, so it now contains the necessary
information) or the version of SOURCE for the used class has changed
(\fIchanges\fR is checked for the appearance of the version itself, the
file-modes and the postinst of the particular SOURCE)
@@ -161,7 +161,7 @@
xserver configuration except file-modes,
which holds the file creation data. The command
- # fcopy -s /files -t /target /etc/X11/XF86Config
+ # fcopy \-s /files \-t /target /etc/X11/XF86Config
copies one of these files from the directory /files/etc/X11/XF86Config to
the file /target/etc/XF86Config. For all defined classes, fcopy looks if a
@@ -188,7 +188,7 @@
will be used, since hostname should always be the last class.
User, group and permissions for the files can be defined in several
-ways. Option -m has the highest priority and will be used for all
+ways. Option \-m has the highest priority and will be used for all
files, if specified. The file file-modes in the source directory can
contain one line for each class. The space separated parameters are:
@@ -197,7 +197,7 @@
where owner and group can be specified by numeric id or by name. The
file permissions are defined by mode, which must be octal. If class is
missing, the data is used for all other classes, for which no data is
-defined. If neither -m or file-modes data is available, the user,
+defined. If neither \-m or file-modes data is available, the user,
group and mode of the source file will be used for the target file.
Missing subdirectories for the target file are created with mode
Modified: trunk/man/ftar.8
===================================================================
--- trunk/man/ftar.8 2009-05-02 23:20:29 UTC (rev 5388)
+++ trunk/man/ftar.8 2009-05-03 13:55:26 UTC (rev 5389)
@@ -31,7 +31,7 @@
extracted tar file, a log message is printed to standard output.
.SH OPTIONS
.TP
-Options -c, -s, -t (or their analog variables) and a SOURCE are required.
+Options \-c, \-s, \-t (or their analog variables) and a SOURCE are required.
.TP
.BI \-1
Use only one archive file matching a class name.
@@ -73,15 +73,15 @@
Each file is a compressed archive. If only class DATALESS is defined,
the following command
- # ftar -s /files -t /target /usr/local
+ # ftar \-s /files \-t /target /usr/local
is equal to
- # tar -C /target/usr/local -zxf /files/usr/local/DATALESS.tar.gz
+ # tar \-C /target/usr/local \-zxf /files/usr/local/DATALESS.tar.gz
If additionally class ant01 is defined, the following command is also executed
- # tar -C /target/usr/local -jxf /files/usr/local/ant01.tar.bz2
+ # tar \-C /target/usr/local \-jxf /files/usr/local/ant01.tar.bz2
If only one archive should be extracted, the class with highest
priority is used.
Modified: trunk/man/make-fai-nfsroot.8
===================================================================
--- trunk/man/make-fai-nfsroot.8 2009-05-02 23:20:29 UTC (rev 5388)
+++ trunk/man/make-fai-nfsroot.8 2009-05-03 13:55:26 UTC (rev 5389)
@@ -42,7 +42,7 @@
also set the environment variable FAI_ETC_DIR.
.TP
.B \-f config_file
-Not supported any more. Use option -C instead.
+Not supported any more. Use option \-C instead.
.TP
.B \-K
Remove all kernels from NFSROOT. This is the same as calling aptitude
@@ -83,7 +83,7 @@
does and how your use of the recovery option can be impacted by fiddling
around with the stamp files.
-You can call make-fai-nfsroot with the '-r' option to attempt a recovery of
+You can call make-fai-nfsroot with the '\-r' option to attempt a recovery of
a previous run. As tasks are completed, stamp files are generated in
/var/run/fai/make-fai-nfsroot. As each task is called in recovery mode, the
stamp file is checked. If it exists, the task is skipped. This will save
Modified: trunk/man/setup-storage.8
===================================================================
--- trunk/man/setup-storage.8 2009-05-02 23:20:29 UTC (rev 5388)
+++ trunk/man/setup-storage.8 2009-05-03 13:55:26 UTC (rev 5389)
@@ -172,7 +172,7 @@
.br
/* when creating the fstab, the key used for defining the device
.br
- may be the device (/dev/xxx), a label given using -L, or the uuid
+ may be the device (/dev/xxx), a label given using \-L, or the uuid
.br
*/
.br
@@ -194,7 +194,7 @@
.br
/* when creating the fstab the key used for defining the device
.br
- may be the device (/dev/xxx), a label given using -L, or the uuid
+ may be the device (/dev/xxx), a label given using \-L, or the uuid
.br
*/
.br
@@ -232,7 +232,7 @@
.br
/* when creating the fstab the key used for defining the device
.br
- may be the device (/dev/xxx), a label given using -L, or the uuid
+ may be the device (/dev/xxx), a label given using \-L, or the uuid
.br
*/
.br
@@ -357,7 +357,7 @@
primary /boot 20-100 ext3 rw
primary swap 1000 swap sw
-primary / 12000 ext3 rw createopts="-b 2048"
+primary / 12000 ext3 rw createopts="\-b 2048"
logical /tmp 1000 ext3 rw,nosuid
logical /usr 5000 ext3 rw
logical /var 10%- ext3 rw
@@ -375,7 +375,7 @@
/dev/hda2 will be a swap space of 1000 MB
.IP \(bu
/dev/hda3 should be formatted using ext3 filesystem; when calling mkfs.ext3
-the option "-b 2048" is appended.
+the option "\-b 2048" is appended.
.IP \(bu
Create the logical partition /dev/hda5
.IP \(bu
More information about the Fai-commit
mailing list