[Fai-commit] r4038 - trunk/man

[fai-commit at lists.alioth.debian.org]

Author: lange
Date: 2006-09-27 12:28:47 +0000 (Wed, 27 Sep 2006)
New Revision: 4038

Modified:
   trunk/man/fai.8
Log:
add info about dirinst, add example


Modified: trunk/man/fai.8
===================================================================
--- trunk/man/fai.8	2006-09-27 10:04:07 UTC (rev 4037)
+++ trunk/man/fai.8	2006-09-27 12:28:47 UTC (rev 4038)
@@ -1,5 +1,5 @@
 .\"                                      Hey, EMACS: -*- nroff -*-
-.TH fai 8 "11 september 2006" "FAI 3"
+.TH fai 8 "27 september 2006" "FAI 3"
 .\" Please adjust this date whenever revising the manpage.
 .\"
 .\" Some roff macros, for reference:
@@ -17,14 +17,15 @@
 .SH SYNOPSIS
 .B fai
 .RI [ options ] " ACTION"
+.br
+.B fai
+.RI [ options ] " dirinst DIRECTORY"
 .SH DESCRIPTION
-
 fai starts a fai-action, e.g. an installation or a softupdate.
 If the variable FAI_ACTION is defined, this action will be
 performed. The command line argument will override the value of
 FAI_ACTION. You can also define your own actions which will be
 executed when specified.
-
 .SH OPTIONS
 .TP
 ACTION is required.
@@ -49,14 +50,13 @@
 .TP
 .B \-v|\-\-verbose
 Create verbose output.
-
 .SH ACTIONS
 .TP
 .B install
-starts an fully automatic installtion:
+starts an fully automatic installation:
 .RS
 .IP 1. 3
-setup the fai environment (create ramdisk, get configuration date,...) 
+setup the fai environment (create ramdisk, get configuration data,...) 
 .IP 2. 3
 define classes and variables
 .IP 3. 3
@@ -74,7 +74,7 @@
 starts a system rescue system
 .RS
 .IP 1. 3
-setup the fai environment (create ramdisk, get configuration date,...) 
+setup the fai environment (create ramdisk, get configuration data,...) 
 .IP 2. 3
 define classes and variables
 .IP 3. 3
@@ -101,10 +101,24 @@
 check and save the logfiles
 .RE
 
+.TP
+.B dirinst [DIR]
+Installation into a directory. This is nearly the same as action
+install except for skipping the task that partitions the hard disks and
+creates the file systems. Classes should be defined with option -c.
+
 .SH NOTES
 Running with action "install" on an already running system will almost
 certainly destroy it.
+.SH EXAMPLES
 
+   fai -v dirinst /srv/etchroot -cDEFAULT,FAIBASE,LAST
+
+This command will do an installation into the directory
+/src/etchroot. For defining variables, selecting the software packages
+and calling the customization script the classes DEFAULT, FAIBASE and
+LAST are used.
+
 .SH SEE ALSO
 .br
 This program is the central part of FAI (Fully Automatic Installation).  See