[SoaS] [PATCH 5/5] Document --copy-home --include options

[Frederick Grose]

[Patch 5/5]
Author: Frederick Grose <fgrose at sugarlabs.org>
Date:   Thu Apr 14 11:12:38 2011 -0400

    Document --copy-home and --include options.

diff --git a/docs/livecd-iso-to-disk.pod b/docs/livecd-iso-to-disk.pod
index 7ef0c14..5550fc6 100644
--- a/docs/livecd-iso-to-disk.pod
+++ b/docs/livecd-iso-to-disk.pod
@@ -6,7 +6,7 @@ livecd-iso-to-disk - installs bootable Live images onto
USB/SD storage devices.

 =head1 SYNOPSIS

-B<livecd-iso-to-disk>  [--help] [--noverify] [--format] [--reset-mbr]
[--efi] [--skipcopy] [--force] [--xo] [--xo-no-home] [--timeout <time>]
[--totaltimeout <time>] [--extra-kernel-args <args>] [--multi] [--livedir
<dir>] [--compress] [--skipcompress] [--swap-size-mb <size>]
[--overlay-size-mb <size>] [--home-size-mb <size>] [--delete-home]
[--crypted-home] [--unencrypted-home] <source> <target device>
+B<livecd-iso-to-disk>  [--help] [--noverify] [--format] [--reset-mbr]
[--efi] [--skipcopy] [--force] [--xo] [--xo-no-home] [--timeout <time>]
[--totaltimeout <time>] [--extra-kernel-args <args>] [--multi] [--livedir
<dir>] [--compress] [--skipcompress] [--swap-size-mb <size>]
[--overlay-size-mb <size>] [--home-size-mb <size>] [--delete-home]
[--crypted-home] [--unencrypted-home] [--copy-home] [--include <file s>]
<source> <target device>

 Simplest

@@ -135,6 +135,20 @@ Specifies the default option to encrypt a new
persistent home directory if --hom

 Prevents the default option to encrypt a new persistent home directory.

+=item --copy-home
+
+This option allows one to copy a persistent home folder from one LiveOS
image to the target image.  Changes already made in the source home
directory will be propagated to the new image.
+
+=over 4
+
+WARNING: User-sensitive information, such as password cookies and user and
application data, will be copied to the new image! Scrub this information
before using this option.
+
+=back
+
+item --include <path s>
+
+This option allows one to copy one or more file or directory paths from the
outer source filesystem to the same path on the target.  Multiple paths
should be specified in one string, i.e., --include "path1 path2 ..."
+
 =back

 =head1 CONTRIBUTORS
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.sugarlabs.org/archive/soas/attachments/20110414/e29619b9/attachment.html>