[Fai-commit] r5166 - in trunk: debian man

lange at alioth.debian.org lange at alioth.debian.org
Tue Sep 16 17:02:16 UTC 2008


Author: lange
Date: 2008-09-16 17:02:15 +0000 (Tue, 16 Sep 2008)
New Revision: 5166

Modified:
   trunk/debian/changelog
   trunk/man/fai-class.1
Log:
fai-chboot.8, fai-cd.8, ainsl.1, fai.8, fai-class.8: apply patches
from Colin Tuckley

Modified: trunk/debian/changelog
===================================================================
--- trunk/debian/changelog	2008-09-16 15:03:00 UTC (rev 5165)
+++ trunk/debian/changelog	2008-09-16 17:02:15 UTC (rev 5166)
@@ -1,7 +1,8 @@
 fai (3.2.11) unstable; urgency=low
 
   * control: depend on syslinux-common instead of syslinux (closes: #494417)
-  * fai-chboot.8, fai-cd.8, ainsl.1, fai.8: apply patches from Colin Tuckley
+  * fai-chboot.8, fai-cd.8, ainsl.1, fai.8, fai-class.8: apply patches
+    from Colin Tuckley
   * THANKS: add Colin
   * fai-chboot.8: add example for using templates, add link to pxelinux
     documentation
@@ -13,7 +14,7 @@
   * setup-storage.8: replace mdoc macro version with man macro version,
     reformat examples using tab stops, make groff happy
 
- -- Thomas Lange <lange at debian.org>  Tue, 16 Sep 2008 16:31:45 +0200
+ -- Thomas Lange <lange at debian.org>  Tue, 16 Sep 2008 19:01:42 +0200
 
 fai (3.2.10) unstable; urgency=low
 

Modified: trunk/man/fai-class.1
===================================================================
--- trunk/man/fai-class.1	2008-09-16 15:03:00 UTC (rev 5165)
+++ trunk/man/fai-class.1	2008-09-16 17:02:15 UTC (rev 5166)
@@ -1,7 +1,6 @@
-.\"                                      Hey, EMACS: -*- nroff -*-
-.TH fai-class 1 "24 july 2003" "FAI 2.5"
+.\" Hey, EMACS: -*- nroff -*-
 .\" Please adjust this date whenever revising the manpage.
-.\"
+.\" 
 .\" Some roff macros, for reference:
 .\" .nh        disable hyphenation
 .\" .hy        enable hyphenation
@@ -12,16 +11,16 @@
 .\" .br        insert line break
 .\" .sp <n>    insert n+1 empty lines
 .\" for manpage-specific macros, see man(7)
-.SH NAME
-fai-class \- define classes using files and scripts.
-.SH SYNOPSIS
-.B fai-class
+.TH "fai-class" "1" "15 September 2008" "FAI 2.5" ""
+.SH "NAME"
+fai\-class \- define classes using files and scripts.
+.SH "SYNOPSIS"
+.B fai\-class
 .RI [OPTION] " DIRECTORY CLASSFILE"
-.SH DESCRIPTION
-
-fai-class executes scripts in DIRECTORY to define classes. All classes
-are written to CLASSFILE, each class in a line. Use absolute pathes
-for both arguments. All scripts or executables matching "[0-9][0-9]*"
+.SH "DESCRIPTION"
+fai\-class executes scripts in DIRECTORY to define classes. All classes
+are written to CLASSFILE, each class on a separate line. Use absolute paths
+for both arguments. All scripts or executables matching "[0\-9][0\-9]*"
 are executed in alphabetical order. They can define classes by writing
 the names of the classes to stdout. Classes can be separated by spaces
 or written one on a line. All lines that start with a "#" are comment
@@ -31,74 +30,74 @@
 by setting the variable $newclasses. This is useful for scripts where
 you can't control stdout. Variables that are defined in these scripts
 are available to other scripts in DIRECTORY, but they are not exported
-to the shell that calls fai-class.
+to the shell that calls fai\-class.
 
 All scripts can define additional classes by writing the classes to the
-file $LOGDIR/additional-classes. These classes are defined after all
+file $LOGDIR/additional\-classes. These classes are defined after all
 scripts are executed. This temporary file will be removed
 after use.
 
 The order of the classes is important because it defines the priority
 of the classes from low to high. First, the class DEFAULT is
 defined. Then all scripts are executed to define classes. After that,
-the classes from the file $LOGDIR/additional-classes are added. Then,
+the classes from the file $LOGDIR/additional\-classes are added. Then,
 all classes in the file with the hostname are added. Finally, the
-class with the hostname and LAST is defined.
+class with the hostname and LAST are defined.
 
 It's important that each line in a file containg a class name ends
-with a newline. It the newline is missing in the last line of a file,
+with a newline. If the newline is missing on the last line of a file,
 this class can't be added.
 
 The exit code of every script is written to the file status.log in LOGDIR.
 
-.SH OPTIONS
-.TP
+.SH "OPTIONS"
+.TP 
 .B \-d
 Create debugging output.
-.TP
+.TP 
 .B \-h
 Show help, version and summary of options.
-.TP
+.TP 
 .B \-T
 Test if classes in CLASSFILE are defined multiple times. This should
 never happen. The test is executed after the classes are defined.
-.TP
+.TP 
 .B \-t tmpdir
-The file additional-classes is read from the directory tmpdir. Default
+The file additional\-classes is read from the directory tmpdir. Default
 value is /tmp/fai/.
-.TP
+.TP 
 .B \-v
 Create verbose output.
 
 
-.SH EXAMPLES
-.br
-In FAI, fai-class is used in the following way: 
+.SH "EXAMPLES"
+.br 
+In FAI, fai\-class is used in the following way: 
 
-   # fai-class /fai/class /tmp/fai/FAI_CLASSES
+   # fai\-class /fai/class /tmp/fai/FAI_CLASSES
 
 Then a list of all classes is defined in a shell script using
-following command:
+the following command:
 
     classes=`cat /tmp/fai/FAI_CLASSES`
 
-.SH EXAMPLES FOR SCRIPTS
+.SH "EXAMPLES FOR SCRIPTS"
 .ta 40n
 .sp
-.nf
+.nf 
 
 This is the script 01alias:
 
 #! /bin/sh
 
 catnc() { # cat but no comment lines
-    grep -v "^#" $1
+    grep \-v "^#" $1
 }
 # echo architecture in upper case
-dpkg --print-installation-architecture | tr /a-z/ /A-Z/
-uname -s | tr /a-z/ /A-Z/
+dpkg \-\-print\-installation\-architecture | tr /a\-z/ /A\-Z/
+uname \-s | tr /a\-z/ /A\-Z/
 
-# all hosts named ant?? are using the classes in file anthill
+# all hosts named ant?? use the classes in file anthill
 case $HOSTNAME in
     ant??) catnc anthill ;;
 esac
@@ -124,25 +123,25 @@
 
 # add NIS and the NIS domain name if YPDOMAIN is defined
 
-if [ -n "$YPDOMAIN" ];then
-   echo "NIS $YPDOMAIN" | tr /.a-z-/ /_A-Z_/
+if [ \-n "$YPDOMAIN" ];then
+   echo "NIS $YPDOMAIN" | tr /.a\-z\-/ /_A\-Z_/
 else
    echo NONIS
 fi
 .sp
-.fi
-.PP
-.SH NOTES
+.fi 
+.PP 
+.SH "NOTES"
 All class names should be written in uppercase letters (execpt the
-class of the hostname). Do not use a dash, use underscore. Only
+class of the hostname). Do not use a dash, use an underscore. Only
 executable scripts in DIRECTORY are used. CLASSFILE is removed before
 writing to it. Scripts should not directly write to CLASSFILE. LOGDIR
 should not be writable for everybody.
 
-.SH SEE ALSO
-.br
+.SH "SEE ALSO"
+.br 
 This program is part of FAI (Fully Automatic Installation). The FAI
-homepage is http://www.informatik.uni-koeln.de/fai.
+homepage is http://www.informatik.uni\-koeln.de/fai.
 
-.SH AUTHOR
-Written by Thomas Lange <lange at informatik.uni-koeln.de>
+.SH "AUTHOR"
+Written by Thomas Lange <lange at informatik.uni\-koeln.de>




More information about the Fai-commit mailing list