Manual page with centralised documentation.
[virt-p2v.git] / virt-p2v
index edf637e..98febf1 100755 (executable)
--- a/virt-p2v
+++ b/virt-p2v
@@ -70,62 +70,21 @@ let defaults = {
    *)
   greeting = true;
 
-  (* Remote host and port.  Set to 'Some "host"' and 'Some "port"',
-   * else ask the user.
+  (* These are now documented in the man page virt-p2v(1).
+   * 'None' means ask the user.
+   * After changing them, run './virt-p2v --test' to check syntax.
    *)
   remote_host = None;
   remote_port = None;
-
-  (* Remote directory.  Set to 'Some "path"' to set up a
-   * directory path, else ask the user.
-   *)
   remote_directory = None;
-
-  (* Remote username for ssh.  Set to 'Some "username"', or None to
-   * ask the user.
-   *)
   remote_username = None;
-
-  (* List of devices to send.  Set to 'Some ["sda"; "sdb"]' for
-   * example to select /dev/sda and /dev/sdb.
-   *)
   devices_to_send = None;
-
-  (* The root filesystem containing /etc/fstab.  Set to
-   * 'Some (Part ("sda", "3"))' or 'Some (LV ("VolGroup00", "LogVol00"))'
-   * for example, else ask user.
-   *)
   root_filesystem = None;
-
-  (* Network configuration: Set to 'Some Auto' (try to set it up
-   * automatically, or 'Some Shell' (give the user a shell).
-   *)
   network = None;
-
-  (* Hypervisor: Set to 'Some Xen', 'Some QEMU' or 'Some KVM'. *)
   hypervisor = None;
-
-  (* Architecture: Set to 'Some X86_64' (or another architecture).
-   * If set to 'Some UnknownArch' then we try to autodetect the
-   * right architecture.
-   *)
   architecture = None;
-
-  (* Memory: Set to 'Some nn' with nn in megabytes.  If set to 'Some 0'
-   * then we use same amount of RAM as installed in the physical machine.
-   *)
   memory = None;
-
-  (* Virtual CPUs: Set to 'Some nn' where nn is the number of virtual CPUs.
-   * If set to 'Some 0' then we use the same as physical CPUs in the
-   * physical machine.
-   *)
   vcpus = None;
-
-  (* MAC address: Set to 'Some "aa:bb:cc:dd:ee:ff"' where the string is
-   * the MAC address of the emulated network card.  Set to 'Some ""' to
-   * choose a random MAC address.
-   *)
   mac_address = None;
 }
 (* END OF CUSTOM virt-p2v SCRIPT SECTION.                               *)