.\"                                      Hey, EMACS: -*- nroff -*-
.if \n(zZ=1 .ig zZ
.if \n(zY=1 .ig zY
.TH fai-cd 8 "25 april 2012" "FAI 4"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.de }1
.ds ]X \&\\*(]B\\
.nr )E 0
.if !"\\$1"" .nr )I \\$1n
.}f
.ll \\n(LLu
.in \\n()Ru+\\n(INu+\\n()Iu
.ti \\n(INu
.ie !\\n()Iu+\\n()Ru-\w\\*(]Xu-3p \{\\*(]X
.br\}
.el \\*(]X\h|\\n()Iu+\\n()Ru\c
.}f
..
.\"
.\" File Name macro.  This used to be `.PN', for Path Name,
.\" but Sun doesn't seem to like that very much.
.\"
.de FN
\fI\|\\$1\|\fP
..
.SH NAME
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
.br
.B fai-cd
[\fIOPTION\fR] \-m MIRROR \fI-u DIRECTORY\fR
.br
.B fai-cd
[\fIOPTION\fR] \-B \fIFILE\fR
.br
.SH DESCRIPTION
This command creates a bootable ISO CD-ROM image that performs the
fully automatic installation from CD-ROM without an install server. The
ISO image will be written to FILE. To create the image, the
command needs the NFSROOT, the configuration space and a partial
mirror, which is created by fai-mirror. The command can also copy all
needed data to DIRECTORY on a mounted USB stick.
.SH OPTIONS
.TP
.BI \-B
Create a boot only ISO image which does a network installation. It
does not include the nfsroot, the partitial mirror and the config
space. Unless the option \-g is used, /usr/share/fai/menu.lst will be
used as boot menu configuration.
.TP
.BI \-b
After creating the ISO image burn it by calling wodim(1) (a version of
cdrecord).
.TP
.B \-C CFDIR
Use CFDIR as the configuration directory. Default is /etc/fai. You can
also set the environment variable FAI_ETC_DIR.
.TP
.BI \-f
Force removal of an existing ISO image before creating a new one.
.TP
.BI "\-g " FILE
Use FILE as grub grub.cfg file. The script will look for FILE
in CFDIR. If FILE is located in another directory then a full path
must be specified. If not specified, use /etc/fai/grub.cfg.
.TP
.B \-G GRUBVERSION
Specify which grub version should be used. Either 1 or 2, the default
is 2.
.TP
.BI \-h
Show simple help and version.
.TP
.BI \-H
Do not hide directories. Using this option will consume 220MB more
disk space on your media. By default, some directories like man pages
and locales are hidden and will not be put onto the CD or the USB stick.
.TP
.BI \-k
Keep the temporary filesystem for debugging. The script will sleep for
a long time, before continuing the cleanup of temp files and
mounts. Beware of killing or suspending the script itself, since a lot
of mounts will remain. This is for debugging only!
.TP
.BI "\-m " DIRECTORY
Use DIRECTORY as partial FAI mirror. This option is mandatory.
.TP
.BI \-n
No ISO image. Do not call genisoimage to create the ISO image. This is for
creating the filesystem only. Useful for writing it to a USB stick.
.TP
.BI "\-u " DIRECTORY
Create a bootable USB stick. The USB stick must be mounted on
DIRECTORY before you run fai-cd. Copies all FAI-CD data to DIRECTORY
and try to install grub onto its device. Currently the file system
on the USB stick must be ext2. USUALLY THIS WILL ERASE ALL DATA ON YOUR USB-STICK!

.SH EXAMPLES
.br
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

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
   # umount /media/usbstick

.SH SEE ALSO
.br
This program is part of FAI (Fully Automatic Installation).
The FAI homepage is http://fai-project.org.
.TP
\fBfai-mirror\fP(1)
.PD
.SH FILES
.PD 0
.TP
.FN /etc/fai/fai.conf
The FAI configuration file.
.TP
.FN /etc/fai/grub.cfg
The default grub2 menu configuration file for fai-cd.
.TP
.FN /usr/share/fai/grub.cfg
The default grub2 menu configuration file when using \-B.
.SH AUTHOR
Thomas Lange <lange@informatik.uni-koeln.de>