docs/livecd-creator.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 livecd-creator - creates live CD or DVD images.
   6
   7 =head1 SYNOPSIS
   8
   9 B<livecd-creator> [OPTIONS]
  10
  11 =head1 DESCRIPTION
  12
  13 B<livecd-creator> creates live CD or DVD images(ISO images) from kickstart files. Kickstart files contain information about packages and configuration settings which are used to build the image.
  14
  15 =head1 OPTIONS
  16
  17 =over 4
  18
  19 =item -h, --help
  20
  21 Shows the help message and exits.
  22
  23 =back
  24
  25 =head1 IMAGE OPTIONS
  26
  27 These options define the created image.
  28
  29 =over 4
  30
  31 =item -c KSCFG, --config=KSCFG
  32
  33 Path to kickstart configuration file.
  34
  35 =item -b BASE_ON, --base-on=BASE_ON
  36
  37 Add packages to an existing live CD iso9660 image.
  38
  39 =item -f FS_LABEL, --fslabel=FS_LABEL
  40
  41 Defines the file system label. The default is based on the configuration name.
  42
  43 =item --compression-type=COMPRESSOR
  44
  45 Specify a compressor recognized by mksquashfs.
  46 xz is the default and works with 2.6.38 and later kernels.
  47 gzip works with all kernels.
  48 lzo works with 2.6.36 and later kernels.
  49 lzma will only work with custom kernels.
  50 Set to 'None' to force reading the compressor used in BASE_ON.
  51 If gzip is used, the -comp option is not passed to mksquashfs to allow the use of older versions of mksquashfs.
  52
  53 =item --releasever=VER
  54
  55 Set the value to substitute for $releasever in kickstart repo urls
  56
  57 =back
  58
  59 =head1 SYSTEM DIRECTORY OPTIONS
  60
  61 These options define directories used on your system for creating the live image.
  62
  63 =over 4
  64
  65 =item -t TMPDIR, --tmpdir=TMPDIR
  66
  67 defines the temporary directory to use. The default directory is /var/tmp.
  68
  69 =item --cache=CACHEDIR
  70
  71 Defines the cache directory to use (default: private cache).
  72
  73 =back
  74
  75 =head1 EXAMPLES
  76
  77 Barebones LiveCD
  78
  79 livecd-creator \
  80 --config=/usr/share/livecd-tools/livecd-fedora-minimal.ks
  81
  82 Fedora Desktop Live CD
  83
  84 livecd-creator \
  85 --config=/usr/share/livecd-tools/livecd-fedora-desktop.ks \
  86 --fslabel=Fedora9-LiveCD-foo
  87
  88 =head1 REPO EXTENSIONS
  89
  90 livecd-creator provides for some extensions to the repo commands similar
  91 to what yum supports. The strings $arch, $basearch and $releasever
  92 are replaced with the system arch, basearch and release version respectively.
  93 When no --releasever is passed it defaults to the current system's version.
  94 The allows the use of repo commands such as the following:
  95
  96 repo --name=fedora --mirrorlist=http://mirrors.fedoraproject.org/mirrorlist?repo=fedora-$releasever&arch=$basearch
  97
  98 Note that in a chroot environment (like koji) the rpmdb is not available,
  99 so either don't use $releasever in that case, or pass --releasever=VER
 100
 101 =head1 CONTRIBUTORS
 102
 103 David Zeuthen, Jeremy Katz, Douglas McClendon and a team of many other contributors. See the AUTHORS file in the source distribution for the complete list of credits.
 104
 105 =head1 BUGS
 106
 107 Report bugs to the mailing list C<http://www.redhat.com/mailman/listinfo/fedora-livecd-list> or directly to Bugzilla C<http://bugzilla.redhat.com/bugzilla/> against the C<Fedora> product, and the C<livecd-tools> component.
 108
 109 =head1 COPYRIGHT
 110
 111 Copyright (C) Fedora Project 2008,2009, and various contributors. This is free software. You may redistribute copies of it under the terms of the GNU General Public License C<http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.
 112
 113 =head1 SEE ALSO
 114
 115 C<livecd-iso-to-disk(1)>, project website C<http://fedoraproject.org/wiki/FedoraLiveCD>
 116
 117 =cut