Updated manpages to match current tool options

2016-08-19 01:51:41 -05:00 · 2016-08-19 01:51:41 -05:00 · b6416dcc4b
commit b6416dcc4b
parent 3606fe64a4
17 changed files with 182 additions and 41 deletions
--- a/doc/qvm-tools/qvm-add-appvm.rst
+++ b/doc/qvm-tools/qvm-add-appvm.rst
@ -22,7 +22,9 @@ OPTIONS
    Specify path to the template directory
 -c CONF_FILE, --conf=CONF_FILE
    Specify the Xen VM .conf file to use(relative to the template dir path)
-
+--force-root
+    Force to run, even with root privileges
+	
 AUTHORS
 =======
 | Joanna Rutkowska <joanna at invisiblethingslab dot com>
--- a/doc/qvm-tools/qvm-backup-restore.rst
+++ b/doc/qvm-tools/qvm-backup-restore.rst
@ -38,6 +38,8 @@ OPTIONS
    Restore from a backup located in a specific AppVM
 -e, --encrypted
    The backup is encrypted
+-p, --passphrase-file
+    Read passphrase from file, or use '-' to read from stdin
 -z, --compressed
    The backup is compressed
 --debug
--- a/doc/qvm-tools/qvm-backup.rst
+++ b/doc/qvm-tools/qvm-backup.rst
@ -18,7 +18,29 @@ OPTIONS
    Show this help message and exit
 -x EXCLUDE_LIST, --exclude=EXCLUDE_LIST
    Exclude the specified VM from backup (might be repeated)
-
+--force-root
+    Force to run with root privileges
+-d, --dest-vm
+    Specify the destination VM to which the backup will be set (implies -e)
+-e, --encrypt
+    Encrypt the backup
+--no-encrypt
+    Skip encryption even if sending the backup to a VM
+-p, --passphrase-file
+    Read passphrase from a file, or use '-' to read from stdin
+-E, --enc-algo
+    Specify a non-default encryption algorithm. For a list of supported algorithms, execute 'openssl list-cipher-algorithms' (implies -e)
+-H, --hmac-algo
+    Specify a non-default HMAC algorithm. For a list of supported algorithms, execute 'openssl list-message-digest-algorithms'
+-z, --compress
+    Compress the backup
+-Z, --compress-filter
+	Specify a non-default compression filter program (default: gzip)
+--tmpdir
+    Specify a temporary directory (if you have at least 1GB free RAM in dom0, use of /tmp is advised) (default: /var/tmp)
+--debug
+    Enable (a lot of) debug output
+	
 AUTHORS
 =======
 | Joanna Rutkowska <joanna at invisiblethingslab dot com>
--- a/doc/qvm-tools/qvm-block.rst
+++ b/doc/qvm-tools/qvm-block.rst
@ -6,7 +6,6 @@ NAME
 ====
 qvm-block - list/set VM PCI devices.

-
 :Date:   2012-04-10

 SYNOPSIS
@ -16,13 +15,14 @@ SYNOPSIS
 | qvm-block -d [options] <device>
 | qvm-block -d [options] <vm-name>

-
 OPTIONS
 =======
 -h, --help
    Show this help message and exit
 -l, --list
    List block devices            
+-A, --attach-file
+    Attach specified file instead of physical device
 -a, --attach
    Attach block device to specified VM
 -d, --detach          
@ -33,6 +33,10 @@ OPTIONS
    Force read-only mode
 --no-auto-detach
    Fail when device already connected to other VM
+--show-system-disks
+    List also system disks
+--force-root
+    Force to run, even with root privileges

 AUTHORS
 =======
--- a/doc/qvm-tools/qvm-check.rst
+++ b/doc/qvm-tools/qvm-check.rst
@ -0,0 +1,32 @@
+=========
+qvm-check
+=========
+
+NAME
+====
+qvm-check - Specify no state options to check if VM exists
+
+:Date:   2013-06-23
+
+SYNOPSIS
+========
+| qvm-check [options] <vm-name>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-q, --quiet
+    Be quiet
+--running
+    Determine if VM is running
+--paused
+    Determine if VM is paused
+--template
+    Determine if VM is a template
+	
+AUTHORS
+=======
+| Joanna Rutkowska <joanna at invisiblethingslab dot com>
+| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
+| Marek Marczykowski <marmarek at invisiblethingslab dot com>
--- a/doc/qvm-tools/qvm-clone-template.rst
+++ b/doc/qvm-tools/qvm-clone-template.rst
@ -1,29 +0,0 @@
-==================
-qvm-clone-template
-==================
-
-NAME
-====
-qvm-clone-template - clones an existing template by copying all its disk files
-
-:Date:   2012-04-10
-
-SYNOPSIS
-========
-| qvm-clone-template [options] <src-template-name> <new-template-name>
-
-OPTIONS
-=======
-h, --help
-    Show this help message and exit
-q, --quiet
-    Be quiet           
-p DIR_PATH, --path=DIR_PATH
-    Specify path to the template directory
-
-AUTHORS
-=======
-| Joanna Rutkowska <joanna at invisiblethingslab dot com>
-| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
-| Marek Marczykowski <marmarek at invisiblethingslab dot com>
-
--- a/doc/qvm-tools/qvm-clone.rst
+++ b/doc/qvm-tools/qvm-clone.rst
@ -20,7 +20,11 @@ OPTIONS
    Be quiet           
 -p DIR_PATH, --path=DIR_PATH
    Specify path to the template directory
-
+--force-root
+    Force to run, even with root privileges
+-P, --pool
+    Specify in to which storage pool to clone
+	
 AUTHORS
 =======
 | Joanna Rutkowska <joanna at invisiblethingslab dot com>
--- a/doc/qvm-tools/qvm-firewall.rst
+++ b/doc/qvm-tools/qvm-firewall.rst
@ -36,9 +36,13 @@ OPTIONS
 -Y SET_YUM_PROXY, --yum-proxy=SET_YUM_PROXY
    Set access to Qubes yum proxy (allow/deny).
    *Note:* if set to "deny", access will be rejected even if policy set to "allow"
+-r, --reload
+    Reload firewall (implied by any change action)
 -n, --numeric
    Display port numbers instead of services (makes sense only with --list)
-
+--force-root
+    Force to run, even with root privileges
+	
 AUTHORS
 =======
 | Joanna Rutkowska <joanna at invisiblethingslab dot com>
--- a/doc/qvm-tools/qvm-grow-root.rst
+++ b/doc/qvm-tools/qvm-grow-root.rst
@ -0,0 +1,26 @@
+=============
+qvm-grow-root
+=============
+
+NAME
+====
+qvm-grow-root - increase root storage capacity of a specified VM
+
+:Date:   2014-03-21
+
+SYNOPSIS
+========
+| qvm-grow-root <vm-name> <size>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+--allow-start
+    Allow VM to be started to complete the operation
+	
+AUTHORS
+=======
+| Joanna Rutkowska <joanna at invisiblethingslab dot com>
+| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
+| Marek Marczykowski <marmarek at invisiblethingslab dot com>
--- a/doc/qvm-tools/qvm-ls.rst
+++ b/doc/qvm-tools/qvm-ls.rst
@ -32,6 +32,8 @@ OPTIONS
    Show date of last VM backup
 --raw-list
    List only VM names one per line
+--raw-data
+    Display specify data of specified VMs. Intended for bash-parsing.

 AUTHORS
 =======
--- a/doc/qvm-tools/qvm-pci.rst
+++ b/doc/qvm-tools/qvm-pci.rst
@ -29,7 +29,9 @@ OPTIONS
        usb - USB controllers
 -d, --delete
    Remove a PCI device from specified VM
-
+--offline-mode
+    Offline mode
+	
 AUTHORS
 =======
 | Joanna Rutkowska <joanna at invisiblethingslab dot com>
--- a/doc/qvm-tools/qvm-prefs.rst
+++ b/doc/qvm-tools/qvm-prefs.rst
@ -25,7 +25,11 @@ OPTIONS
    Get a single property of a specified VM
 -s, --set
    Set properties of a specified VM
-
+--force-root
+    Force to run, even with root privileges
+--offline-mode
+    Offline mode
+	
 PROPERTIES
 ==========

--- a/doc/qvm-tools/qvm-run.rst
+++ b/doc/qvm-tools/qvm-run.rst
@ -40,6 +40,20 @@ OPTIONS
    Pass stdin/stdout/stderr from remote program
 --localcmd=LOCALCMD
    With --pass-io, pass stdin/stdout/stderr to the given program
+--nogui
+    Run command without gui
+--filter-escape-chars
+    Filter terminal escape sequences (default if output is terminal)
+--no-filter-escape-chars
+    Do not filter terminal escape sequences - overrides --filter-escape-chars, DANGEROUS when output is terminal
+--no-color-output
+    Disable marking VM output with red color
+--no-color-stderr
+    Disable marking VM stderr with red color
+--color-output
+    Force marking VM output with given ANSI style (use 31 for red)
+--color-stderr
+    Force marking VM stderr with given ANSI style (use 31 for red)
 --force
    Force operation, even if may damage other VMs (eg. shutdown of NetVM)

--- a/doc/qvm-tools/qvm-shutdown.rst
+++ b/doc/qvm-tools/qvm-shutdown.rst
@ -22,6 +22,8 @@ OPTIONS
    Force operation, even if may damage other VMs (eg. shutdown of NetVM)
 --wait
    Wait for the VM(s) to shutdown
+--wait-time
+    Timeout after which VM will be killed when --wait is used
 --all
    Shutdown all running VMs
 --exclude=EXCLUDE_LIST
--- a/doc/qvm-tools/qvm-start.rst
+++ b/doc/qvm-tools/qvm-start.rst
@ -18,15 +18,27 @@ OPTIONS
    Show this help message and exit
 -q, --quiet
    Be quiet           
+--tray
+    Use tray notifications instead of stdout
 --no-guid
    Do not start the GUId (ignored)
--console
-    Attach debugging console to the newly started VM
+--drive
+    Temporarily attach specified drive as CD/DVD or hard disk (can be specified with prefix 'hd' or 'cdrom:', default is cdrom)
+--hddisk
+    Temporarily attach specified drive as hard disk
+--cdrom
+    Temporarily attach specified drive as CD/DVD
+--install-windows-tools
+    Attach Windows tools CDROM to the VM
 --dvm
    Do actions necessary when preparing DVM image
 --custom-config=CUSTOM_CONFIG
    Use custom Xen config instead of Qubes-generated one
-
+--skip-if-running
+    Do no fail if the VM is already running
+--debug
+    Enable debug mode for this VM (until its shutdown)
+	
 AUTHORS
 =======
 | Joanna Rutkowska <joanna at invisiblethingslab dot com>
--- a/doc/qvm-tools/qvm-template-commit.rst
+++ b/doc/qvm-tools/qvm-template-commit.rst
@ -16,7 +16,9 @@ OPTIONS
 =======
 -h, --help
    Show this help message and exit
-
+--offline-mode
+    Offline mode
+	
 AUTHORS
 =======
 | Joanna Rutkowska <joanna at invisiblethingslab dot com>
--- a/doc/qvm-tools/qvm-usb.rst
+++ b/doc/qvm-tools/qvm-usb.rst
@ -0,0 +1,36 @@
+=======
+qvm-usb
+=======
+
+NAME
+====
+qvm-usb - List/set VM USB devices
+
+:Date:   2013-03-16
+
+SYNOPSIS
+========
+| qvm-usb -l [options]
+| qvm-usb -a [options] <vm-name> <device-vm-name>:<device>
+| qvm-usb -d [options] <device-vm-name>:<device>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-l, -list
+    List devices
+-a, --attach
+    Attach specified device to specified VM
+-d, --detach
+    Detach specified device
+--no-auto-detach
+    Fail when device already connected to other VM
+--force-root
+    Force to run, even with root privileges
+
+AUTHORS
+=======
+| Joanna Rutkowska <joanna at invisiblethingslab dot com>
+| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
+| Marek Marczykowski <marmarek at invisiblethingslab dot com>