~fai/fai/fai.hardy

« back to all changes in this revision

Viewing changes to man/fai.8

  • Committer: Reinhard Tartler
  • Date: 2008-02-14 09:38:36 UTC
  • mfrom: (1.1.4052 ubuntu)
  • Revision ID: siretart@tauware.de-20080214093836-7h0setrddcbdu62q
Upload of 3.2.1-0ubuntu1 to gutsy

this merge contains all commits up to to release of 3.2.1-0ubuntu1 to
gutsy.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\"                                      Hey, EMACS: -*- nroff -*-
 
2
.TH fai 8 "22 june 2007" "FAI 3.2"
 
3
.\" Please adjust this date whenever revising the manpage.
 
4
.\"
 
5
.\" Some roff macros, for reference:
 
6
.\" .nh        disable hyphenation
 
7
.\" .hy        enable hyphenation
 
8
.\" .ad l      left justify
 
9
.\" .ad b      justify to both left and right margins
 
10
.\" .nf        disable filling
 
11
.\" .fi        enable filling
 
12
.\" .br        insert line break
 
13
.\" .sp <n>    insert n+1 empty lines
 
14
.\" for manpage-specific macros, see man(7)
 
15
.SH NAME
 
16
fai \- fully automatic installation
 
17
.SH SYNOPSIS
 
18
.B fai
 
19
.RI [ options ] " ACTION"
 
20
.br
 
21
.B fai
 
22
.RI [ options ] " dirinstall DIRECTORY"
 
23
.SH DESCRIPTION
 
24
fai starts a fai-action, e.g. an installation or a softupdate.
 
25
If the variable FAI_ACTION is defined, this action will be
 
26
performed. The command line argument will override the value of
 
27
FAI_ACTION. You can also define your own actions which will be
 
28
executed when specified.
 
29
.SH OPTIONS
 
30
.TP
 
31
ACTION is required.
 
32
.TP
 
33
.B \-C CFDIR
 
34
Use CFDIR as configuration directory. Default is /etc/fai.
 
35
.TP
 
36
.BI "\-c|\-\-class " class[,class]
 
37
Define classes.  Multiple classes must be comma separated.  If not
 
38
specified, use the shell environment variable $classes (space
 
39
separated).  The first class has lowest priority.
 
40
.TP
 
41
.B \-h|\-\-help
 
42
Show help, version and summary of options.
 
43
.TP
 
44
.B \-N|\-\-new
 
45
Renew the list of defined classes. By default, FAI uses the list of
 
46
classes which was created during the first installation and skips
 
47
calling fai-class(1). You need to use this option for the first 
 
48
softupdate if the system was not installed with FAI, and you can use
 
49
it in subsequent runs as well.
 
50
.TP
 
51
.B \-u|\--hostname <HOSTNAME>
 
52
Use this hostname instead the output of the hostname command. This is
 
53
useful in conjunction with the dirinstall action, where you most
 
54
probably want to manually define a hostname that should be used for
 
55
defining classes and for the network setup and other stuff. There, you
 
56
most probably don't want the name of the host where you run fai
 
57
dirinstall on be used - because programs in a chroot, or in a
 
58
virtualized OS instance should run on their own name, and install
 
59
their own set of classes.
 
60
.TP
 
61
.B \-v|\-\-verbose
 
62
Create verbose output.
 
63
.SH ACTIONS
 
64
.TP
 
65
.B install
 
66
starts an fully automatic installation:
 
67
.RS
 
68
.IP 1. 3
 
69
setup the fai environment (create ramdisk, get configuration data,...) 
 
70
.IP 2. 3
 
71
define classes and variables
 
72
.IP 3. 3
 
73
partition the local hard disk and create file systems
 
74
.IP 4. 3
 
75
install new software packages
 
76
.IP 5. 3
 
77
call configuration scripts
 
78
.IP 6. 3
 
79
check and save the logfiles
 
80
.RE
 
81
 
 
82
.TP
 
83
.B sysinfo
 
84
starts a system rescue system
 
85
.RS
 
86
.IP 1. 3
 
87
setup the fai environment (create ramdisk, get configuration data,...) 
 
88
.IP 2. 3
 
89
define classes and variables
 
90
.IP 3. 3
 
91
do different types of hardware detection and print hardware info
 
92
.IP 4. 3
 
93
save the logfiles
 
94
.RE
 
95
 
 
96
.TP
 
97
.B softupdate
 
98
starts a softupdate:
 
99
.RS
 
100
.IP 1. 3
 
101
fetch FAI configuration according to /etc/fai/fai.conf 
 
102
.IP 2. 3
 
103
define classes and variables
 
104
.IP 3. 3
 
105
update the installed packages
 
106
.IP 4. 3
 
107
install new software
 
108
.IP 5. 3
 
109
call configuration scripts
 
110
.IP 6. 3
 
111
check and save the logfiles
 
112
.RE
 
113
 
 
114
.TP
 
115
.B dirinstall [DIR]
 
116
Installation into a directory. This is nearly the same as action
 
117
install except for skipping the task that partitions the hard disks and
 
118
creates the file systems. Classes can be defined with option -c, or by
 
119
giving the hostname with -u or --hostname and enabling automatic definition
 
120
by class scripts from hostname with -N. (Without -N class scripts aren't
 
121
executed)
 
122
 
 
123
.SH NOTES
 
124
Running with action "install" on an already running system will almost
 
125
certainly destroy it.
 
126
.SH EXAMPLES
 
127
 
 
128
   fai -v dirinstall /srv/etchroot -cDEFAULT,FAIBASE,LAST
 
129
 
 
130
This command will do an installation into the directory
 
131
/src/etchroot. For defining variables, selecting the software packages
 
132
and calling the customization script the classes DEFAULT, FAIBASE and
 
133
LAST are used.
 
134
 
 
135
.SH SEE ALSO
 
136
.br
 
137
This program is the central part of FAI (Fully Automatic Installation).  See 
 
138
the FAI manual for more information on how to use FAI. 
 
139
The FAI homepage is http://www.informatik.uni-koeln.de/fai.
 
140
 
 
141
.SH AUTHOR
 
142
This manual page was written by Henning Glawe
 
143
<glaweh@physik.fu-berlin.de> and Thomas Lange <lange@informatik.uni-koeln.de>.