Livecd-iso-to-disk

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
 
livecd-iso-to-disk.sh is a bash shell script supplied with livecd-tools, http://git.fedoraproject.org/git/?p=hosted/livecd;a=tree;f=tools;hb=HEAD.
 
livecd-iso-to-disk.sh is a bash shell script supplied with livecd-tools, http://git.fedoraproject.org/git/?p=hosted/livecd;a=tree;f=tools;hb=HEAD.
  
Usage is documented in livecd-iso-to-disk.pod, in http://git.fedoraproject.org/git/?p=hosted/livecd;a=tree;f=docs;hb=HEAD, which was copied here for easy revision and review on 05 April 2010.  The revision history of this page shows the proposed changes to this file.
+
Usage is documented in livecd-iso-to-disk.pod, in http://git.fedoraproject.org/git/?p=hosted/livecd;a=tree;f=docs;hb=HEAD, which was copied here for easy revision and review on 05 April 2010.  The revision history of this page shows the proposed changes to this file.  The accumulated changes are shown below.
  
==livecd-iso-to-disk.pod==
+
==proposed livecd-iso-to-disk.pod==
  
 
=pod
 
=pod

Revision as of 22:07, 5 April 2010

livecd-iso-to-disk.sh is a bash shell script supplied with livecd-tools, http://git.fedoraproject.org/git/?p=hosted/livecd;a=tree;f=tools;hb=HEAD.

Usage is documented in livecd-iso-to-disk.pod, in http://git.fedoraproject.org/git/?p=hosted/livecd;a=tree;f=docs;hb=HEAD, which was copied here for easy revision and review on 05 April 2010. The revision history of this page shows the proposed changes to this file. The accumulated changes are shown below.

proposed livecd-iso-to-disk.pod

=pod

=head1 NAME

livecd-iso-to-disk - installs bootable CD images on a USB storage devices.

=head1 SYNOPSIS

B<livecd-iso-to-disk> [--format] [--reset-mbr] [--efi] [--extra-kernel-args <args>] [--multi] [--livedir <dir>] [--compress] [--skip-compress] [--swap-size-mb <size>] [--xo] [--xo-no-home] [--noverify] [--skipcopy] [--overlay-size-mb <size>] [--copy-overlay] [--delete-home] [--home-size-mb <size>] [--copy-home] [--force] [--crypted-home] [--unencrypted-home] <isopath> <usbstick device>"

=head1 DESCRIPTION

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. The ISO image may even be the currently running live media image. If the operating system supports a persistent overlay to save system changes, a fresh overlay, or a copy of the currently running overlay may be included in the install. This enables one to easily prepare customized live media images for redistribution. (ISO images can be created with B<livecd-creator>.)

B<livecd-iso-to-disk> is not a destructive process; any data you currently have on your USB stick is preserved.

=head1 OPTIONS

=over 4

=item --format

Formats the USB stick and creates an MS-DOS partition table (or GPT partition table if --efi is passed).

=item --reset-mbr

Sets the Master Boot Record(MBR) of the USB storage device to the mbr.bin file from the image's syslinux directory.

=item --efi

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.

=item --extra-kernel-args <args>

Specifies additional kernel arguments, <args>, that will be inserted into the syslinux and EFI boot configurations. Multiple arguments should be specified in one string, such as, --extra-kernel-args "arg1 arg2 ..."

=item --multi

Used when enabling multi image copies to avoid boot configuration of a particular image.

=item --livedir <dir>

Used with multi image copies to select the particular image to boot.

=item --compress (default option to use a compressed squash filesystem)

Installs image on a compressed squash filesystem

=item --skip-compress (default for when option --xo is specified)

Installs the operation system into a ext3 filesystem image file.

=item --xo

Used to prepare an image for the OLPC XO laptop and its encrypted jff filesystem. Do not use the following options with --xo: --overlay-size-mb <size>, home-size-mb <size>, --delete-home, --copy-home, --copy-overlay, --compress

=item --xo-no-home

Used together with the --xo option to prepare an image for an OLPC XO laptop with the home folder on an SD card instead of the internal nand flash.

=item --noverify

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.

=item --skipcopy

Skips the copy of the live image to the USB stick. (Used to repair disk configuration files or while testing the script to avoid repeated and length copy commands.)

=item --overlay-size-mb <size>

This option specifies the creation of a persistent overlay and sets its <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.

=item --copy-overlay

This option allows one to copy a persistent overlay from a running live image to the new installation. Changes already made in the running image will be propagated to the new installation. B<WARNING:> User sensitive information such as password cookies and activity histories will be copied to the new installation! Scrub this information before using this option.

=item --delete-home

Must be explicitly selected when options --home-size-mb <size> or --copy-home are selected and there is an existing persistent home directory on the image.

=item --home-size-mb <size>

Specifies creation of a persistent home directory and sets its size in megabytes. Note that --delete-home must also be selected to replace an existing persistent home with a new, empty one.

=item --copy-home

This option allows one to copy a persistent home folder from a running live image to the new installation. Changes already made in the running image home directory will be propagated to the new installation. B<WARNING:> User sensitive information such as password cookies and activity histories will be copied to the new installation! Scrub this information before using this option.

=item --force

This option allows one to bypass the user confirmation for deletion of an existing home directory on the target device, if one exists.

=item --crypted-home (default, if home-size-mb is specified)

Encrypts a persistent home directory.

=item --unencrypted-home

Disables the encryption of the persistent home directory.

=back

=head1 CONTRIBUTORS

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.

=head1 BUGS

Report bugs to the mailing list C<http://admin.fedoraproject.org/mailman/listinfo/livecd> or directly to Bugzilla C<http://bugzilla.redhat.com/bugzilla/> against the C<Fedora> product, and the C<lived-tools> component.

=head1 COPYRIGHT

Copyright (C) Fedora Project 2008, 2009, 2010 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.

=head1 SEE ALSO

C<livecd-creator(1)>, project website C<http://fedoraproject.org/wiki/FedoraLiveCD>

=cut