package: fai-server
severity: wishlist
version: 3.2
tags: patch

Hi,

the fai-cd manpage could need some improvements, to better indicate that 
fai-cd, despite it's name, can also be used to create fai-usbsticks.

Attached is a patch (against current svn), with some improvements.

I haven't added an example section, as I'm not really familar with manpage 
source code :-) But two examples, one for cd and one for usbsticks, would 
rock! (As -u really wants -n...)


regards,
        Holger


Index: fai-cd.8
===================================================================
--- fai-cd.8	(Revision 4563)
+++ fai-cd.8	(Arbeitskopie)
@@ -1,7 +1,7 @@
 .\"                                      Hey, EMACS: -*- nroff -*-
 .if \n(zZ=1 .ig zZ
 .if \n(zY=1 .ig zY
-.TH fai-cd 8 "5 august 2007" "FAI 3.2"
+.TH fai-cd 8 "12 september 2007" "FAI 3.2.1"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -35,7 +35,7 @@
 \fI\|\\$1\|\fP
 ..
 .SH NAME
-fai-cd \- make a bootable CD-ROM that performs the FAI
+fai-cd \- make a bootable CD-ROM or USB stick that performs the FAI
 .SH SYNOPSIS
 .B fai-cd
 .RI [OPTION]...\ -m\ DIRECTORY\ FILENAME
@@ -52,7 +52,7 @@
 After creating the ISO image burn it by calling cdrecord(1).
 .TP
 .BI \-f
-Force removal of an existin ISO image before creating a new one.
+Force removal of an existing ISO image before creating a new one.
 .TP
 .BI "\-g " FILE
 Use FILE as grub menu.lst file. If not specified, use /etc/fai/menu.lst.
@@ -76,7 +76,8 @@
 .BI "\-u " DIRECTORY
 Copy all FAI-CD data to DIRECTORY and try to install grub onto its
 device. Do not create an ISO image. This can be used to create a
-bootable USB stick.
+bootable USB stick. The USB stick needs to be mounted to DIRECTORY before
+you run fai-cd.
 .SH SEE ALSO
 .br
 This program is part of FAI (Fully Automatic Installation).

Attachment: pgpAYNn6bUAa5.pgp
Description: PGP signature

Reply via email to