contrib: Add libguestfs talk.
[libguestfs.git] / clone / virt-sysprep.pod
index 98270c1..eb56801 100755 (executable)
@@ -155,9 +155,9 @@ Enable tracing of libguestfs API calls.
 
 =head1 OPERATIONS
 
-If the I<--enable> option is I<not> given, then all sysprep operations
-in the list below are enabled, although some are skipped depending on
-the type of guest.
+If the I<--enable> option is I<not> given, then
+I<all sysprep operations are enabled>, although some are skipped
+depending on the type of guest.
 
 Operations can be individually enabled using the I<--enable> option.
 Use a comma-separated list, for example:
@@ -167,6 +167,14 @@ Use a comma-separated list, for example:
 To list the operations supported by the current version of
 virt-sysprep, use I<--list-operations>.
 
+Future versions of virt-sysprep may add more operations.  If you are
+using virt-sysprep and want predictable behaviour, specify only the
+operations that you want to have enabled.
+
+=head2 cron-spool
+
+Remove user at-jobs and cron-jobs.
+
 =head2 dhcp-client-state
 
 Remove DHCP client leases.
@@ -187,6 +195,10 @@ changed to C<localhost.localdomain>.
 
 Remove many log files.
 
+=head2 mail-spool
+
+Remove email from the local mail spool directory.
+
 =head2 net-hwaddr
 
 Remove HWADDR (hard-coded MAC address) configuration.  For Fedora and
@@ -197,7 +209,7 @@ Red Hat Enterprise Linux, this is removed from C<ifcfg-*> files.
 Write some random bytes from the host into the random seed file of
 the guest.
 
-See C</RANDOM SEED> below.
+See L</RANDOM SEED> below.
 
 =head2 rhn-systemid
 
@@ -232,11 +244,19 @@ old MAC address occupies the old name (eg. eth0), this means the fresh
 MAC address is assigned to a new name (eg. eth1) and this is usually
 undesirable.  Erasing the udev persistent net rules avoids this.
 
+=head2 utmp
+
+Remove the utmp file.
+
+This records who is currently logged in on a machine.  In modern Linux
+distros it is stored in a ramdisk and hence not part of the virtual
+machine's disk, but it was stored on disk in older distros.
+
 =head2 yum-uuid
 
 Remove the yum UUID.
 
-yum creates a fresh UUID the next time it runs when it notices that
+Yum creates a fresh UUID the next time it runs when it notices that
 the original UUID has been erased.
 
 =head1 COPYING AND CLONING
@@ -408,12 +428,10 @@ thus is ideal for cloning guests from a template.
 
 =head1 SECURITY
 
-Although virt-sysprep removes some sensitive information from
-the guest, it does not pretend to remove all of it.  You should
-examine the L</OPERATIONS> above, and the implementation of
-the operations in the shell script.
-
-You should also examine the guest afterwards.
+Although virt-sysprep removes some sensitive information from the
+guest, it does not pretend to remove all of it.  You should examine
+the L</OPERATIONS> above, and the implementation of the operations in
+the shell script.  You should also examine the guest afterwards.
 
 Sensitive files are simply removed.  The data they contained may still
 exist on the disk, easily recovered with a hex editor or undelete