Add support for timeout and totaltimeout to livecd-iso-to-disk (#531566)
[livecd.git] / docs / livecd-iso-to-disk.pod
blob1ccab66a96ed625b51b52ff27f17b684c1cdd61a
1 =pod
3 =head1 NAME
5 livecd-iso-to-disk - installs bootable CD images on a USB storage devices.
7 =head1 SYNOPSIS
9 B<livecd-iso-to-disk> [--format] [--reset-mbr] [--noverify] [--efi] [--overlay-size-mb <size>] [\-\-home\-size\-mb <size>] [\-\-unencrypted\-home] [\-\-skipcopy]  <path-to-iso> <usb storage device>
11 =head1 DESCRIPTION
13 B<livecd-iso-to-disk> installs a live CD or DVD image(ISO image) onto a USB storage device. The USB storage device can then boot the installed operating system on systems which support booting via USB. B<livecd-iso-to-disk> requires an ISO image and a USB storage device. ISO images can be created with B<livecd-creator>.
15 B<livecd-iso-to-disk> is not a destructive process; any data you currently have on your USB stick is preserved.
17 =head1 OPTIONS
19 =over 4
21 =item --format
23 Formats the USB stick and creates an MS-DOS partition table (or GPT partition table if --efi is passed).
25 =item --reset-mbr
27 Sets the Master Boot Record(MBR) of the USB storage device to the mbr.bin file from the image's syslinux directory.
29 =item --noverify
31 Disables the image validation process which occurs before the image is installed. When this option is enabled the image is not verified before installation on the USB storage device.
33 =item --overlay-size-mb
35 This option sets the overlay size in megabytes. The overlay is additional storage available to the live operating system if the operating system supports it. The USB storage device must have enough free space for the image and the overlay.
37 =item --home-size-mb
39 Sets the home directory size in megabytes.
41 =item --unencrypted-home
43 Disables the encryption of the home directory.
45 =item --skipcopy
47 Skips the copy of the live image to the USB stick and disables the --forma, --home-size-mb, and --swap-size-mb options. The --overlay-size-mb option is changed to only reinitialize the existing overlay area, to recreate it from scratch.
49 The intended use of this option is to speed up testing of the boot configuration of live images.
51 =item --efi
53 Create a GPT partition table when --format is passed, and install an hybrid EFI/MBR bootloader on the disk. This is necessary for most Intel Macs.
55 =item --timeout
57 Modify the bootloader's timeout value. This overrides the value set during iso creation. Units are 1/10s
59 =item --totaltimeout
61 Add a totaltimeout to the bootloader config. This is used to force and automatic boot. This cannot be canceled by the user. Units are 1/10s
63 =back
65 =head1 CONTRIBUTORS
67 David Zeuthen, Jeremy Katz, Douglas McClendon, Chris Curran and other contributors. See the AUTHORS file in the source distribution for the complete list of credits.
69 =head1 BUGS
71 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<lived-tools> component.
73 =head1 COPYRIGHT
75 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.
77 =head1 SEE ALSO
79 C<livecd-creator(1)>, project website C<http://fedoraproject.org/wiki/FedoraLiveCD>
81 =cut