diff --git a/doc/conf.py b/doc/conf.py index edc91563..f3f5480a 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -241,58 +241,6 @@ latex_documents = [ _man_pages_author = [] man_pages = [ - ('manpages/qvm-add-appvm', 'qvm-add-appvm', - u'Add an already installed appvm to the Qubes DB', _man_pages_author, 1), - ('manpages/qvm-add-template', 'qvm-add-template', - u'Adds an already installed template to the Qubes DB', _man_pages_author, 1), - ('manpages/qvm-backup-restore', 'qvm-backup-restore', - u'Restores Qubes VMs from backup', _man_pages_author, 1), - ('manpages/qvm-backup', 'qvm-backup', - u'Create backup of specified VMs', _man_pages_author, 1), - ('manpages/qvm-block', 'qvm-block', - u'Qubes volume and block device managment', _man_pages_author, 1), - ('manpages/qvm-clone-template', 'qvm-clone-template', - u'Clones an existing template by copying all its disk files', _man_pages_author, 1), - ('manpages/qvm-clone', 'qvm-clone', - u'Clones an existing VM by copying all its disk files', _man_pages_author, 1), - ('manpages/qvm-create-default-dvm', 'qvm-create-default-dvm', - u'Creates a default disposable VM', _man_pages_author, 1), - ('manpages/qvm-create', 'qvm-create', - u'Creates a new VM', _man_pages_author, 1), - ('manpages/qvm-firewall', 'qvm-firewall', - u'Qubes firewall configuration', _man_pages_author, 1), - ('manpages/qvm-grow-private', 'qvm-grow-private', - u'Increase private storage capacity of a specified VM', _man_pages_author, 1), - ('manpages/qvm-kill', 'qvm-kill', - u'Kill the specified VM', _man_pages_author, 1), - ('manpages/qvm-ls', 'qvm-ls', - u'List VMs and various information about them', _man_pages_author, 1), - ('manpages/qvm-pci', 'qvm-pci', - u'List/set VM PCI devices', _man_pages_author, 1), - ('manpages/qvm-pool', 'qvm-pool', - u'Manages Qubes pools and their options', _man_pages_author, 1), - ('manpages/qvm-prefs', 'qvm-prefs', - u'List/set various per-VM properties', _man_pages_author, 1), - ('manpages/qvm-remove', 'qvm-remove', - u'Remove a VM', _man_pages_author, 1), - ('manpages/qvm-revert-template-changes', 'qvm-revert-template-changes', - u'Revert changes to a template', _man_pages_author, 1), - ('manpages/qvm-run', 'qvm-run', - u'Run a command on a specified VM', _man_pages_author, 1), - ('manpages/qvm-service', 'qvm-service', - u'Manage (Qubes-specific) services started in VM', _man_pages_author, 1), - ('manpages/qvm-shutdown', 'qvm-shutdown', - u'Gracefully shut down a VM', _man_pages_author, 1), - ('manpages/qvm-start', 'qvm-start', - u'Start a specified VM', _man_pages_author, 1), - ('manpages/qvm-tags', 'qvm-tags', - u'Manage tags on a qube', _man_pages_author, 1), - ('manpages/qvm-template-commit', 'qvm-template-commit', - u'Commit changes to a template', _man_pages_author, 1), - - ('manpages/qubes-prefs', 'qubes-prefs', - u'Display system-wide Qubes settings', _man_pages_author, 1), - ('manpages/qubesd-query', 'qubesd-query', u'Low-level qubesd interrogation tool', _man_pages_author, 1), ] diff --git a/doc/manpages/qubes-prefs.rst b/doc/manpages/qubes-prefs.rst deleted file mode 100644 index cad5f9c9..00000000 --- a/doc/manpages/qubes-prefs.rst +++ /dev/null @@ -1,69 +0,0 @@ -.. program:: qubes-prefs - -:program:`qubes-prefs` -- List/set various global properties -============================================================ - -Synopsis --------- - -:command:`qubes-prefs` [-h] [--verbose] [--quiet] [--force-root] [--help-properties] [*PROPERTY* [*VALUE*\|--delete]] - -Options -------- - -.. option:: --help, -h - - Show help message and exit. - -.. option:: --help-properties - - List available properties with short descriptions and exit. - -.. option:: --verbose, -v - - Increase verbosity. - -.. option:: --quiet, -q - - Decrease verbosity. - -.. option:: --unset, --default, --delete, -D - - Unset the property. If is has default value, it will be used instead. - -.. option:: --get, -g - - Ignored; for compatibility with older scripts. - -.. option:: --set, -s - - Ignored; for compatibility with older scripts. - - -Common properties -================= - -This list is non-exhaustive. For authoritative listing, see -:option:`--help-properties` and documentation of the source code. - -.. warning:: - - This list is from the core2. It is wrong in many cases, some of them obvious, - some of them not. - -- clock VM -- update VM -- default template -- default firewallVM -- default kernel -- default netVM - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-add-appvm.rst b/doc/manpages/qvm-add-appvm.rst deleted file mode 100644 index 65f54057..00000000 --- a/doc/manpages/qvm-add-appvm.rst +++ /dev/null @@ -1,33 +0,0 @@ -.. program:: qvm-add-appvm - -========================================================================== -:program:`qvm-add-appvm` -- Add an already installed appvm to the Qubes DB -========================================================================== - -.. warning:: - Normally you would not need this command, and you would use qvm-create instead! - -Synopsis -======== -:command:`qvm-add-appvm` [*options*] <*appvm-name*> <*vm-template-name*> - -Options -======= - -.. option:: --help, -h - - Show this help message and exit - -.. option:: --path=DIR_PATH, -p DIR_PATH - - Specify path to the template directory - -.. option:: --conf=CONF_FILE, -c CONF_FILE - - Specify the Xen VM .conf file to use (relative to the template dir path) - -Authors -======= -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/doc/manpages/qvm-add-template.rst b/doc/manpages/qvm-add-template.rst deleted file mode 100644 index 0acc13b5..00000000 --- a/doc/manpages/qvm-add-template.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. program:: qvm-add-template - -================================================================================= -:program:`qvm-add-template` -- Adds an already installed template to the Qubes DB -================================================================================= - -Synopsis -======== -:command:`qvm-add-template` [*options*] <*vm-template-name*> - -Options -======= - -.. option:: --help, -h - - Show this help message and exit - -.. option:: --path=DIR_PATH, -p DIR_PATH - - Specify path to the template directory - -.. option:: --conf=CONF_FILE, -c CONF_FILE - - Specify the Xen VM .conf file to use(relative to the template dir path) - -.. option:: --rpm - - Template files have been installed by RPM - -Authors -======= -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/doc/manpages/qvm-backup-restore.rst b/doc/manpages/qvm-backup-restore.rst deleted file mode 100644 index 9051f373..00000000 --- a/doc/manpages/qvm-backup-restore.rst +++ /dev/null @@ -1,82 +0,0 @@ -.. program:: qvm-backup-restore - -=============================================================== -:program:`qvm-backup-restore` -- Restores Qubes VMs from backup -=============================================================== - -Synopsis -======== -:command:`qvm-backup-restore` [*options*] <*backup-dir*> - -Options -======= - -.. option:: --help, -h - - Show this help message and exit - -.. option:: --verbose, -v - - Increase verbosity - -.. option:: --quiet, -q - - Decrease verbosity - - -.. option:: --verify-only - - Do not restore the data, only verify backup integrity - -.. option:: --skip-broken - - Do not restore VMs that have missing templates or netvms - -.. option:: --ignore-missing - - Ignore missing templates or netvms, restore VMs anyway - -.. option:: --skip-conflicting - - Do not restore VMs that are already present on the host - -.. option:: --rename-conflicting - - Restore VMs that are already present on the host under different names - -.. option:: --force-root - - Force to run, even with root privileges - -.. option:: --replace-template=REPLACE_TEMPLATE - - Restore VMs using another template, syntax: - ``old-template-name:new-template-name`` (might be repeated) - -.. option:: --exclude=EXCLUDE, -x EXCLUDE - - Skip restore of specified VM (might be repeated) - -.. option:: --skip-dom0-home - - Do not restore dom0 user home dir - -.. option:: --ignore-username-mismatch - - Ignore dom0 username mismatch while restoring homedir - -.. option:: --dest-vm=APPVM, -d APPVM - - Restore from a backup located in a specific AppVM - -.. option:: --passphrase-file, -p - - Read passphrase from file, or use '-' to read from stdin - - - -Authors -======= -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/doc/manpages/qvm-backup.rst b/doc/manpages/qvm-backup.rst deleted file mode 100644 index 59a920ef..00000000 --- a/doc/manpages/qvm-backup.rst +++ /dev/null @@ -1,86 +0,0 @@ -.. program:: qvm-backup - -:program:`qvm-backup` -- None -============================= - -Synopsis --------- - -:command:`qvm-backup` skel-manpage.py [-h] [--verbose] [--quiet] [--force-root] [--exclude EXCLUDE_LIST] [--dest-vm *APPVM*] [--encrypt] [--no-encrypt] [--passphrase-file PASS_FILE] [--enc-algo CRYPTO_ALGORITHM] [--hmac-algo HMAC_ALGORITHM] [--compress] [--compress-filter COMPRESS_FILTER] [--tmpdir *TMPDIR*] backup_location [vms [vms ...]] - -Options -------- - -.. option:: --help, -h - - show this help message and exit - -.. option:: --verbose, -v - - increase verbosity - -.. option:: --quiet, -q - - decrease verbosity - -.. option:: --force-root - - force to run as root - -.. option:: --exclude, -x - - Exclude the specified VM from the backup (may be repeated) - -.. option:: --dest-vm, -d - - Specify the destination VM to which the backup will be sent (implies -e) - -.. option:: --encrypt, -e - - Encrypt the backup - -.. option:: --no-encrypt - - Skip encryption even if sending the backup to a VM - -.. option:: --passphrase-file, -p - - Read passphrase from a file, or use '-' to read from stdin - -.. option:: --enc-algo, -E - - Specify a non-default encryption algorithm. For a list of supported algorithms, execute 'openssl list-cipher-algorithms' (implies -e) - -.. option:: --hmac-algo, -H - - Specify a non-default HMAC algorithm. For a list of supported algorithms, execute 'openssl list-message-digest-algorithms' - -.. option:: --compress, -z - - Compress the backup - -.. option:: --compress-filter, -Z - - Specify a non-default compression filter program (default: gzip) - -.. option:: --tmpdir - - Specify a temporary directory (if you have at least 1GB free RAM in dom0, use of /tmp is advised) (default: /var/tmp) - -Arguments ---------- - -The first positional parameter is the backup location (directory path, or -command to pipe backup to). After that you may specify the qubes you'd like to -backup. If not specified, all qubes with `include_in_backups` property set are -included. - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-block.rst b/doc/manpages/qvm-block.rst deleted file mode 100644 index fb340d24..00000000 --- a/doc/manpages/qvm-block.rst +++ /dev/null @@ -1,112 +0,0 @@ -.. program:: qvm-block - -:program:`qvm-block` -- Qubes volume and block device managment -=============================================================== - -Synopsis --------- - -| :command:`qvm-block` *COMMAND* [-h] [--verbose] [--quiet] [options] [arguments] - -Description ------------ - -.. TODO Add description - -Options -------- - -.. option:: --help, -h - - Show help message and exit - -.. option:: --verbose, -v - - Increase verbosity. - -.. option:: --quiet, -q - - Decrease verbosity. - -Commands --------- - -list -^^^^ - -| :command:`qvm-block list` [-h] [--verbose] [--quiet] [-p *POOL_NAME*] [-i] [*VMNAME* [*VMNAME* ...]] - -List block devices. By default the internal devices are hidden. When the -stdout is connected to a TTY `qvm-block list` will print a pretty table by -omitting redundant data. This behaviour is disabled when `--full` option is -passed or stdout is redirected to a pipe or file. - -.. option:: -p, --pool - - list volumes from specified pool - -.. option:: -i, --internal - - list internal devices - -.. option:: --full - - print domain names - -.. option:: --all - - List volumes from all qubes. You can use :option:`--exclude` to limit the - qubes set. Don't forget — internal devices are hidden by default! - -.. option:: --exclude - - Exclude the qube from :option:`--all`. - -aliases: ls, l - -attach -^^^^^^ - -| :command:`qvm-block attach` [-h] [--verbose] [--quiet] [--ro] *VMNAME* *POOL_NAME:VOLUME_ID* - -Attach the volume with *VOLUME_ID* from *POOL_NAME* to the domain *VMNAME* - -.. option:: --ro - - attach device read-only - -aliases: a, at - -detach -^^^^^^ - -| :command:`qvm-block detach` [-h] [--verbose] [--quiet] *VMNAME* *POOL_NAME:VOLUME_ID* - -Detach the volume with *POOL_NAME:VOLUME_ID* from domain *VMNAME* - -aliases: d, dt - -extend -^^^^^^ -| :command:`qvm-block extend` [-h] [--verbose] [--quiet] *POOL_NAME:VOLUME_ID* *NEW_SIZE* - -Extend the volume with *POOL_NAME:VOLUME_ID* TO *NEW_SIZE* - -revert -^^^^^^ - -| :command:`qvm-block revert` [-h] [--verbose] [--quiet] *POOL_NAME:VOLUME_ID* - -Revert a volume to previous revision. - -aliases: rv, r - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Bahtiar `kalkin-` Gadimov - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-clone-template.rst b/doc/manpages/qvm-clone-template.rst deleted file mode 100644 index 2b660389..00000000 --- a/doc/manpages/qvm-clone-template.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. program:: qvm-clone-template - -========================================================================================== -:program:`qvm-clone-template` -- Clones an existing template by copying all its disk files -========================================================================================== - -Synopsis -======== -:command:`qvm-clone-template` [*options*] <*src-template-name*> <*new-template-name*> - -Options -======= -.. option:: --help, -h - - Show this help message and exit - -.. option:: --quiet, -q - - Be quiet - -.. option:: --path=DIR_PATH, -p DIR_PATH - - Specify path to the template directory - -Authors -======= -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/doc/manpages/qvm-clone.rst b/doc/manpages/qvm-clone.rst deleted file mode 100644 index 76ef182b..00000000 --- a/doc/manpages/qvm-clone.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. program:: qvm-clone - -:program:`qvm-clone` -- Clones an existing VM by copying all its disk files -=========================================================================== - -Synopsis --------- -:command:`qvm-clone` [-h] [--verbose] [--quiet] [-p *POOL:VOLUME* | -P POOL] *VMNAME* *NEWVM* - -Options -------- - -.. option:: --help, -h - - Show this help message and exit - -.. option:: -P POOL - - Pool to use for the new domain. All volumes besides snapshots volumes are - imported in to the specified POOL. THIS IS WHAT YOU WANT TO USE NORMALLY. - -.. option:: --pool=POOL:VOLUME, -p POOL:VOLUME - - Specify the pool to use for the specific volume - -.. option:: --quiet, -q - - Be quiet - -.. option:: --verbose, -v - - Increase verbosity - -Authors -------- -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Bahtiar `kalkin-` Gadimov diff --git a/doc/manpages/qvm-create-default-dvm.rst b/doc/manpages/qvm-create-default-dvm.rst deleted file mode 100644 index 3b716074..00000000 --- a/doc/manpages/qvm-create-default-dvm.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. program:: qvm-create-default-dvm - -==================================================================== -:program:`qvm-create-default-dvm` -- Creates a default Disposable VM -==================================================================== - -Synopsis -======== -| :command:`qvm-create-default-dvm` templatename|--default-template|--used-template [script-name|--default-script] - -OPTIONS -======= -templatename - Base DispVM on given template. The command will create AppVM named after - template with "-dvm" suffix. This VM will be used to create DispVM - savefile. If you want to customize DispVM, use this VM - take a look at - https://wiki.qubes-os.org/wiki/UserDoc/DispVMCustomization - ---default-template - Use default template for the DispVM - ---used-template - Use the same template as earlier - ---default-script - Use default script for seeding DispVM home. - -Authors -======= -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/doc/manpages/qvm-create.rst b/doc/manpages/qvm-create.rst deleted file mode 100644 index 69988a8c..00000000 --- a/doc/manpages/qvm-create.rst +++ /dev/null @@ -1,89 +0,0 @@ -.. program:: qvm-create - -:program:`qvm-create` -- create new domain -========================================== - -Synopsis --------- - -:command:`qvm-create` [-h] [--verbose] [--quiet] [--force-root] [--class *CLS*] [--property *NAME*=*VALUE*] [--pool *POOL_NAME:VOLUME_NAME*] [--template *VALUE*] --label *VALUE* [--root-copy-from *FILENAME* | --root-move-from *FILENAME*] *VMNAME* - -Options -------- - -.. option:: --help, -h - - show help message and exit - -.. option:: --verbose, -v - - Increase verbosity. - -.. option:: --quiet, -q - - Decrease verbosity. - -.. option:: --force-root - - Force to run as root. - -.. option:: --class, -C - - The new domain class name (default: **AppVM** for - :py:class:`qubes.vm.appvm.AppVM`). - -.. option:: --prop=NAME=VALUE, --property=NAME=VALUE - - Set domain's property, like "internal", "memory" or "vcpus". Any property may - be set this way, even "qid". - -.. option:: --template=VALUE, -t VALUE - - Specify the TemplateVM to use, when applicable. This is an alias for - ``--property template=VALUE``. - -.. option:: --label=VALUE, -l VALUE - - Specify the label to use for the new domain (e.g. red, yellow, green, ...). - This in an alias for ``--property label=VALUE``. - -.. option:: --root-copy-from=FILENAME, -r FILENAME - - Use provided :file:`root.img` instead of default/empty one (file will be - *copied*). This option is mutually exclusive with :option:`--root-move-from`. - -.. option:: --root-move-from=FILENAME, -R FILENAME - - Use provided :file:`root.img` instead of default/empty one (file will be - *moved*). This option is mutually exclusive with :option:`--root-copy-from`. - -.. option:: -P POOL - - Pool to use for the new domain. All volumes besides snapshots volumes are - imported in to the specified POOL. ~HIS IS WHAT YOU WANT TO USE NORMALLY. - -.. option:: --pool=POOL:VOLUME, -p POOL:VOLUME - - Specify the pool to use for the specific volume - -Options for internal use ------------------------- - -Do not use if you don't know, what you are doing. - -.. option:: --no-root - - Do not create :file:`root.img`. This option is mutually exclusive with - :option:`--root-copy-from` and :option:`--root-move-from`. - - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Wojtek Porczyk -| Bahtiar `kalkin-` Gadimov - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-features.rst b/doc/manpages/qvm-features.rst deleted file mode 100644 index 5f62bd92..00000000 --- a/doc/manpages/qvm-features.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. program:: qvm-features - -:program:`qvm-features` -- manage domain's features -=================================================== - -Synopsis --------- - -:command:`qvm-features` [-h] [--verbose] [--quiet] *VMNAME* [*FEATURE* [*VALUE*]] - -Options -------- - -.. option:: --help, -h - - show this help message and exit - -.. option:: --verbose, -v - - increase verbosity - -.. option:: --quiet, -q - - decrease verbosity - -.. option:: --unset, --default, --delete, -D - - Unset the feature. - -Description ------------ - -This command is used to manually manage the *features* of the domain. The -features are key-value pairs with both key and value being strings. They are -used by extensions to store information about the domain and make policy -decisions based on them. For example, they may indicate that some specific -software package was installed inside the template and the domains based on it -have some specific capability. - -.. warning:: - - The features are normally managed by the extensions themselves and you should - not change them directly. Strange things might happen otherwise. - -Some extensions interpret the values as boolean. In this case, the empty string -means :py:obj:`False` and non-empty string (commonly ``'1'``) means -:py:obj:`True`. An absence of the feature means "default", which is -extension-dependent. - -Authors -------- - -| Joanna Rutkowska -| Marek Marczykowski -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-firewall.rst b/doc/manpages/qvm-firewall.rst deleted file mode 100644 index c0c1c8d3..00000000 --- a/doc/manpages/qvm-firewall.rst +++ /dev/null @@ -1,85 +0,0 @@ -.. program:: qvm-firewall - -:program:`qvm-firewall` -- Manage VM outbound firewall -====================================================== - -Synopsis --------- - -:command:`qvm-firewall` [-h] [--verbose] [--quiet] [--reload] *VMNAME* add *RULE* -:command:`qvm-firewall` [-h] [--verbose] [--quiet] [--reload] *VMNAME* del [--rule-no=*RULE_NUMBER*] [*RULE*] -:command:`qvm-firewall` [-h] [--verbose] [--quiet] [--reload] *VMNAME* list [--raw] -:command:`qvm-firewall` [-h] [--verbose] [--quiet] [--reload] *VMNAME* policy {accept,drop} - -Options -------- - -.. option:: --help, -h - - show help message and exit - -.. option:: --verbose, -v - - increase verbosity - -.. option:: --quiet, -q - - decrease verbosity - -.. option:: --reload, -r - - force reloading rules even when unchanged - -.. option:: --raw - - Print raw rules when listing - - -Actions description -------------------- - -Available actions: - -* add - add specified rule. See `Rule syntax` section below. - -* del - delete specified rule. Can be selected either by rule number using -:option:`--rule-no`, or specifying rule itself. - -* list - list all the rules for a given VM. - -* policy - set default action if no rule matches. - - -Rule syntax ------------ - -A single rule is built from: - - action - either ``drop`` or ``accept`` - - zero or more matches - -Selected action is applied on given packet when all specified matches do match, -further rules are not evaluated. If none of the rules match, default action -(``policy``) is applied. - -Supported matches: - - ``dsthost`` - destination host or network. Can be either IP address in CIDR - notation, or a host name. Both IPv4 and IPv6 are supported by the rule syntax. - - ``proto`` - specific IP protocol. Supported values: ``tcp``, ``udp``, - ``icmp``. - - ``dstports`` - destination port or ports range. Can be either a single port, - or a range separated by ``-``. Valid only together with ``proto=udp`` or - ``proto=tcp``. - - ``icmptype`` - ICMP message type, specified as numeric value. Valid only - together with ``proto=icmp``. - - ``specialtarget`` - predefined target. Currently the only supported value is - ``dns``. This can be combined with other matches to narrow it down. - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-grow-private.rst b/doc/manpages/qvm-grow-private.rst deleted file mode 100644 index 8e4a7663..00000000 --- a/doc/manpages/qvm-grow-private.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. program:: qvm-grow-private - -================================================================================== -:program:`qvm-grow-private` -- Increase private storage capacity of a specified VM -================================================================================== - -Synopsis -======== -:command:`qvm-grow-private` <*vm-name*> <*size*> - -Options -======= - -.. option:: --help, -h - - Show this help message and exit - -Authors -======= -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/doc/manpages/qvm-kill.rst b/doc/manpages/qvm-kill.rst deleted file mode 100644 index 464a79bb..00000000 --- a/doc/manpages/qvm-kill.rst +++ /dev/null @@ -1,44 +0,0 @@ -.. program:: qvm-kill - -:program:`qvm-kill` -- forceful shutdown of a domain -==================================================== - -Synopsis --------- - -:command:`qvm-kill` [-h] [--verbose] [--quiet] [--all] [--exclude *EXCLUDE*] [*VMNAME* [*VMNAME* ...]] - -Options -------- - -.. option:: --all - - Kill all qubes. You can use :option:`--exclude` to limit the - qubes set. dom0 is not killed. - -.. option:: --exclude - - Exclude the qube from :option:`--all`. - -.. option:: --help, -h - - show this help message and exit - -.. option:: --verbose, -v - - increase verbosity - -.. option:: --quiet, -q - - decrease verbosity - - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-ls.rst b/doc/manpages/qvm-ls.rst deleted file mode 100644 index 7b5e2150..00000000 --- a/doc/manpages/qvm-ls.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. program:: qvm-ls - -:program:`qvm-ls` -- List VMs and various information about them -================================================================ - -Synopsis --------- - -:command:`qvm-ls` [-h] [--verbose] [--quiet] [--help-columns] [--help-formats] [--format *FORMAT* | --fields *FIELD*,...] - -Options -------- - -.. option:: --help, -h - - Show help message and exit - -.. option:: --help-columns - - List all available columns with short descriptions and exit. - -.. option:: --help-formats - - List all available formats with their definitions and exit. - -.. option:: --format=FORMAT, -o FORMAT - - Sets format to a list of columns defined by preset. All formats along with - columns which they show can be listed with :option:`--help-formats`. - -.. option:: --fields=FIELD,..., -O FIELD,... - - Sets format to specified set of columns. This gives more control over - :option:`--format`. All columns along with short descriptions can be listed - with :option:`--help-columns`. - -.. option:: --raw-data - - Output data in easy to parse format. Table header is skipped and columns are - separated by `|` character. - -.. option:: --verbose, -v - - Increase verbosity. - -.. option:: --quiet, -q - - Decrease verbosity. - -Authors -------- -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et diff --git a/doc/manpages/qvm-pause.rst b/doc/manpages/qvm-pause.rst deleted file mode 100644 index 861b4a98..00000000 --- a/doc/manpages/qvm-pause.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. program:: qvm-pause - -:program:`qvm-pause` -- pause a domain -====================================== - -Synopsis --------- - -:command:`qvm-pause` [-h] [--verbose] [--quiet] *VMNAME* - -Options -------- - -.. option:: --help, -h - - Show the help message and exit. - -.. option:: --verbose, -v - - Increase verbosity. - -.. option:: --quiet, -q - - Decrease verbosity. - -.. option:: --all - - Pause all the qubes. - -.. option:: --exclude=EXCLUDE - - Exclude the qube from :option:`--all`. - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-pci.rst b/doc/manpages/qvm-pci.rst deleted file mode 100644 index 1d7a437a..00000000 --- a/doc/manpages/qvm-pci.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. program:: qvm-pci - -============================================= -:program:`qvm-pci` -- List/set VM PCI devices -============================================= - -Synopsis -======== -| :command:`qvm-pci` [*options*] -l <*vm-name*> -| :command:`qvm-pci` [*options*] -a <*vm-name*> <*device*> -| :command:`qvm-pci` [*options*] -d <*vm-name*> <*device*> - -Options -======= - -.. option:: --help, -h - - Show this help message and exit - -.. option:: --list, -l - - List VM PCI devices - -.. option:: --add, -a - - Add a PCI device to specified VM - -.. option:: --add-class, -C - - Add all devices of given class: - net - network interfaces - usb - USB controllers - -.. option:: --delete, -d - - Remove a PCI device from specified VM - -Authors -======= -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/doc/manpages/qvm-pool.rst b/doc/manpages/qvm-pool.rst deleted file mode 100644 index 6f905ba4..00000000 --- a/doc/manpages/qvm-pool.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. program:: qvm-pool - -:program:`qvm-pool` -- manage pools -=================================== - -Synopsis --------- -:command:`qvm-pool` [-h] [--verbose] [--quiet] [--help-drivers] [-o options] [-l | -i *NAME* | -a *NAME* *DRIVER* | -r *NAME*] - -Options -------- - -.. option:: --help, -h - - Show this help message and exit - -.. option:: --quiet, -q - - Be quiet - -.. option:: --verbose, -v - - Increase verbosity - -.. option:: --help-drivers - - List all known drivers with their options. The listed driver options can be - used with the ``-o options`` switch. - -.. option:: -o options - - Comma separated list of driver options. See ``--help-drivers`` for a list of - driver options. - -.. option:: --list, -l - - List all pools. - -.. option:: --info NAME, -i NAME - - Show information about a pool - -.. option:: --add NAME DRIVER, -a NAME DRIVER - - Add a pool. For supported drivers and their options see ``--help-drivers``. - Most of the drivers expect some kind of options. - -.. option:: --remove NAME, -r NAME - - Remove a pool. This removes only the information about the pool in - qubes.xml, but does not delete any content. - -Examples --------- - -Create a pool backed by the default `xen` driver. - -:: - - qvm-pool -o dir_path=/mnt/foo -a foo xen - -Authors -------- -| Bahtiar \`kalkin-\` Gadimov diff --git a/doc/manpages/qvm-prefs.rst b/doc/manpages/qvm-prefs.rst deleted file mode 100644 index 4fa210cc..00000000 --- a/doc/manpages/qvm-prefs.rst +++ /dev/null @@ -1,247 +0,0 @@ -.. program:: qvm-prefs - -:program:`qvm-prefs` -- List/set various per-VM properties -========================================================== - -Synopsis --------- - -:command:`qvm-prefs` qvm-prefs [-h] [--verbose] [--quiet] [--force-root] [--help-properties] *VMNAME* [*PROPERTY* [*VALUE* \| --delete \| --default ]] - -Options -------- - -.. option:: --help, -h - - Show help message and exit. - -.. option:: --help-properties - - List available properties with short descriptions and exit. - -.. option:: --verbose, -v - - Increase verbosity. - -.. option:: --quiet, -q - - Decrease verbosity. - -.. option:: --force-root - - Force to run as root. - -.. option:: --unset, --default, --delete, -D - - Unset the property. If is has default value, it will be used instead. - -.. option:: --get, -g - - Ignored; for compatibility with older scripts. - -.. option:: --set, -s - - Ignored; for compatibility with older scripts. - - -Common properties -================= - -This list is non-exhaustive. For authoritative listing, see -:option:`--help-properties` and documentation of the source code. - -.. warning:: - - This list is from the core2. It is wrong in many cases, some of them obvious, - some of them not. - -include_in_backups - Accepted values: ``True``, ``False`` - - Control whenever this VM will be included in backups by default (for now - works only in qubes-manager). You can always manually select or - deselect any VM for backup. - -pcidevs - PCI devices assigned to the VM. Should be edited using qvm-pci tool. - -pci_strictreset - Accepted values: ``True``, ``False`` - - Control whether prevent assigning to VM a device which does not support any - reset method. Generally such devices should not be assigned to any VM, - because there will be no way to reset device state after VM shutdown, so - the device could attack next VM to which it will be assigned. But in some - cases it could make sense - for example when the VM to which it is assigned - is trusted one, or is running all the time. - -pci_e820_host - Accepted values: ``True``, ``False`` - - Give VM with PCI devices a memory map (e820) of the host. This is - required for some devices to properly resolve conflicts in address space. - This option is enabled by default for VMs with PCI devices and have no - effect for VMs without devices. - -label - Accepted values: ``red``, ``orange``, ``yellow``, ``green``, ``gray``, - ``blue``, ``purple``, ``black`` - - Color of VM label (icon, appmenus, windows border). If VM is running, - change will be applied at first VM restart. - -netvm - Accepted values: netvm name, ``default``, ``none`` - - To which NetVM connect. Setting to ``default`` will follow system-global - default NetVM (managed by qubes-prefs). Setting to ``none`` will disable - networking in this VM. - -dispvm_netvm - Accepted values: netvm name, ``default``, ``none`` - - Which NetVM should be used for Disposable VMs started by this one. - ``default`` is to use the same NetVM as the VM itself. - -maxmem - Accepted values: memory size in MB - - Maximum memory size available for this VM. Dynamic memory management (aka - qmemman) will not be able to balloon over this limit. For VMs with - qmemman disabled, this will be overridden by *memory* property (at VM - startup). - -memory - Accepted values: memory size in MB - - Initial memory size for VM. This should be large enough to allow VM startup - - before qmemman starts managing memory for this VM. For VM with qmemman - disabled, this is static memory size. - -kernel - Accepted values: kernel version, ``default``, ``none`` - - Kernel version to use (only for PV VMs). Available kernel versions will be - listed when no value given (there are in /var/lib/qubes/vm-kernels). - Setting to ``default`` will follow system-global default kernel (managed - via qubes-prefs). Setting to ``none`` will use "kernels" subdir in - VM directory - this allows having VM-specific kernel; also this the only - case when /lib/modules is writable from within VM. - -template - Accepted values: TemplateVM name - - TemplateVM on which VM base. It can be changed only when VM isn't running. - -vcpus - Accepted values: no of CPUs - - Number of CPU (cores) available to VM. Some VM types (eg DispVM) will not - work properly with more than one CPU. - -kernelopts - Accepted values: string, ``default`` - - VM kernel parameters (available only for PV VMs). This can be used to - workaround some hardware specific problems (eg for NetVM). Setting to - ``default`` will use some reasonable defaults (currently different for VMs - with PCI devices and without). For VM without PCI devices - ``default`` option means inherit this value from the VM template (if any). - Some helpful options (for debugging purposes): ``earlyprintk=xen``, - ``init=/bin/bash`` - -name - Accepted values: alphanumerical name - - Name of the VM. Can be only changed when VM isn't running. - -drive - Accepted values: [hd:\|cdrom:][backend-vm:]path - - Additional drive for the VM (available only for HVMs). This can be used to - attach installation image. ``path`` can be file or physical device (eg. - :file:`/dev/sr0`). The same syntax can be used in - :option:`qvm-start --drive` - to attach drive only temporarily. - -mac - Accepted values: MAC address, ``auto`` - - Can be used to force specific of virtual ethernet card in the VM. Setting - to ``auto`` will use automatic-generated MAC - based on VM id. Especially - useful when licensing requires a static MAC address. - For template-based HVM ``auto`` mode means to clone template MAC. - -default_user - Accepted values: username - - Default user used by :manpage:`qvm-run(1)`. Note that it make sense only on - non-standard template, as the standard one always have "user" account. - -debug - Accepted values: ``on``, ``off`` - - Enables debug mode for VM. This can be used to turn on/off verbose logging - in many Qubes components at once (gui virtualization, VM kernel, some other - services). - - For template-based HVM, enabling debug mode also disables automatic reset - :file:`root.img` (actually :file:`volatile.img`) before each VM startup, so - changes made to root filesystem stays intact. To force reset - :file:`root.img` when debug mode enabled, either change something in the - template (simple start+stop will do, even touch its :file:`root.img` is - enough), or remove VM's :file:`volatile.img` (check the path with - :manpage:`qvm-prefs(1)`). - -qrexec_installed - Accepted values: ``True``, ``False`` - - This HVM have qrexec agent installed. When VM have qrexec agent installed, - one can use qvm-run to start VM process, VM will benefit from Qubes RPC - services (like file copy, or inter-vm clipboard). This option will be - automatically turned on during Qubes Windows Tools installation, but if you - install qrexec agent in some other OS, you need to turn this option on - manually. - -guiagent_installed - Accepted values: ``True``, ``False`` - - This HVM have gui agent installed. This option disables full screen GUI - virtualization and enables per-window seemless GUI mode. This option will - be automatically turned on during Qubes Windows Tools installation, but if - you install Qubes gui agent in some other OS, you need to turn this option - on manually. You can turn this option off to troubleshoot some early HVM OS - boot problems (enter safe mode etc), but the option will be automatically - enabled at first VM normal startup (and will take effect from the next - startup). - - .. note:: - - when Windows GUI agent is installed in the VM, SVGA device (used to - full screen video) is disabled, so even if you disable this option, you - will not get functional full desktop access (on normal VM startup). Use - some other means for that (VNC, RDP or so). - -autostart - Accepted values: ``True``, ``False`` - - Start the VM during system startup. The default netvm is autostarted - regardless of this setting. - -timezone - Accepted values: ``localtime``, time offset in seconds - - Set emulated HVM clock timezone. Use ``localtime`` (the default) to use the - same time as dom0 have. Note that HVM will get only clock value, not the - timezone itself, so if you use ``localtime`` setting, OS inside of HVM - should also be configured to treat hardware clock as local time (and have - proper timezone set). - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-remove.rst b/doc/manpages/qvm-remove.rst deleted file mode 100644 index ec285780..00000000 --- a/doc/manpages/qvm-remove.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. program:: qvm-remove - -:program:`qvm-remove` -- remove domain -====================================== - -Synopsis --------- -:command:`qvm-remove` [-h] [--verbose] [--quiet] [--force-root] [--all] [--exclude *EXCLUDE*] [--just-db] [*VMNAME* [*VMNAME* ...]] - -Options -------- - -.. option:: --all - - Remove all qubes. You can use :option:`--exclude` to limit the - qubes set. dom0 is not removed - -.. option:: --exclude - - Exclude the qube from :option:`--all`. - -.. option:: --help, -h - - Show this help message and exit - -.. option:: --force-root - - Force to run, even with root privileges - -.. option:: --just-db - - Remove only from the Qubes Xen DB, do not remove any files - -.. option:: --verbose, -v - - increase verbosity - -.. option:: --quiet, -q - - decrease verbosity - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Bahtiar `kalkin-` Gadimov - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-revert-template-changes.rst b/doc/manpages/qvm-revert-template-changes.rst deleted file mode 100644 index f3ff3c6a..00000000 --- a/doc/manpages/qvm-revert-template-changes.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. program:: qvm-revert-template-changes - -====================================================================== -:program:`qvm-revert-template-changes` -- Revert changes to a template -====================================================================== - -Synopsis -======== -:command:`qvm-revert-template-changes` [*options*] <*template-name*> - -Options -======= - -.. option:: --help, -h - - Show this help message and exit - -.. option:: --force - - Do not prompt for confirmation - -Authors -======= -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/doc/manpages/qvm-run.rst b/doc/manpages/qvm-run.rst deleted file mode 100644 index ee56543e..00000000 --- a/doc/manpages/qvm-run.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. program:: qvm-run - -:program:`qvm-run` -- Run a command in a specified VM -===================================================== - -Synopsis --------- - -:command:`qvm-run` [-h] [--verbose] [--quiet] [--all] [--exclude *EXCLUDE*] [--user *USER*] [--autostart] [--pass-io] [--localcmd *COMMAND*] [--gui] [--no-gui] [--colour-output *COLOR*] [--no-color-output] [--filter-escape-chars] [--no-filter-escape-chars] [*VMNAME*] *COMMAND* - -Options -------- - -.. option:: --help, -h - - Show the help message and exit. - -.. option:: --verbose, -v - - Increase verbosity. - -.. option:: --quiet, -q - - Decrease verbosity. - -.. option:: --all - - Run the command on all qubes. You can use :option:`--exclude` to limit the - qubes set. Command is never run on the dom0. - -.. option:: --exclude - - Exclude the qube from :option:`--all`. - -.. option:: --user=USER, -u USER - - Run command in a qube as *USER*. - -.. option:: --auto, --autostart, -a - - Start the qube if it is not running. - -.. option:: --pass-io, -p - - Pass standard input and output to and from the remote program. - -.. option:: --localcmd=COMMAND - - With :option:`--pass-io`, pass standard input and output to and from the - given program. - -.. option:: --gui - - Run the command with GUI forwarding enabled, which is the default. This - switch can be used to counter :option:`--no-gui`. - -.. option:: --no-gui, --nogui - - Run the command without GUI forwarding enabled. Can be switched back with - :option:`--gui`. - -.. option:: --colour-output=COLOUR, --color-output=COLOR - - Mark the qube output with given ANSI colour (ie. "31" for red). The exact - mapping of numbers to colours and styles depends of the particular terminal - emulator. - - Colouring can be disabled with :option:`--no-colour-output`. - -.. option:: --colour-stderr=COLOUR, --color-stderr=COLOR - - Mark the qube stderr with given ANSI colour (ie. "31" for red). The exact - mapping of numbers to colours and styles depends of the particular terminal - emulator. - - Colouring can be disabled with :option:`--no-colour-stderr`. - -.. option:: --no-colour-output, --no-color-output - - Disable colouring the stdout. - -.. option:: --no-colour-stderr, --no-color-stderr - - Disable colouring the stderr. - -.. option:: --filter-escape-chars - - Filter terminal escape sequences (default if output is terminal). - - Terminal control characters are a security issue, which in worst case amount - to arbitrary command execution. In the simplest case this requires two often - found codes: terminal title setting (which puts arbitrary string in the - window title) and title repo reporting (which puts that string on the shell's - standard input. - -.. option:: --no-filter-escape-chars - - Do not filter terminal escape sequences. This is DANGEROUS when output is - a terminal emulator. See :option:`--filter-escape-chars` for explanation. - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-service.rst b/doc/manpages/qvm-service.rst deleted file mode 100644 index e376497b..00000000 --- a/doc/manpages/qvm-service.rst +++ /dev/null @@ -1,156 +0,0 @@ -.. program:: qvm-service - -======================================================================== -:program:`qvm-service` -- Manage (Qubes-specific) services started in VM -======================================================================== - -Synopsis -======== -| :command:`qvm-service` [-l] <*vmname*> -| :command:`qvm-service` [-e|-d|-D] <*vmname*> <*service*> - -Options -======= -.. option:: --help, -h - - Show this help message and exit - -.. option:: --list, -l - - List services (default action) - -.. option:: --enable, -e - - Enable service - -.. option:: --disable, -d - - Disable service - -.. option:: --default, -D - - Reset service to its default state (remove from the list). Default state - means "lets VM choose" and can depend on VM type (NetVM, AppVM etc). - -Supported services -================== - -This list can be incomplete as VM can implement any additional service without -knowledge of qubes-core code. - -meminfo-writer - Default: enabled everywhere excluding NetVM - - This service reports VM memory usage to dom0, which effectively enables - dynamic memory management for the VM. - - .. note:: - - This service is enforced to be set by dom0 code. If you try to - remove it (reset to default state), will be recreated with the rule: enabled - if VM have no PCI devices assigned, otherwise disabled. - -qubes-dvm - Default: disabled - - Used internally when creating DispVM savefile. - -qubes-firewall - Default: enabled only in ProxyVM - - Dynamic firewall manager, based on settings in dom0 (qvm-firewall, firewall tab in qubes-manager). - This service is not supported in netvms. - -qubes-network - Default: enabled only in NetVM and ProxyVM - - Expose network for other VMs. This includes enabling network forwarding, MASQUERADE, DNS redirection and basic firewall. - -qubes-network - Default: enabled only in NetVM and ProxyVM - - Expose network for other VMs. This includes enabling network forwarding, - MASQUERADE, DNS redirection and basic firewall. - -qubes-netwatcher - Default: enabled only in ProxyVM - - Monitor IP change notification from NetVM. When received, reload - qubes-firewall service (to force DNS resolution). - - This service makes sense only with qubes-firewall enabled. - -qubes-update-check - Default: enabled - - Notify dom0 about updates available for this VM. This is shown in - qubes-manager as 'update-pending' flag. - -cups - Default: enabled only in AppVM - - Enable CUPS service. The user can disable cups in VM which do not need - printing to speed up booting. - -crond - Default: disabled - - Enable CRON service. - -network-manager - Default: enabled in NetVM - - Enable NetworkManager. Only VM with direct access to network device needs - this service, but can be useful in ProxyVM to ease VPN setup. - -ntpd - Default: disabled - - Enable NTPD service. By default Qubes calls ntpdate every 6 minutes in - selected VM (aka ClockVM), then propagate the result using qrexec calls. - Enabling ntpd *do not* disable this behaviour. - -qubes-yum-proxy - Deprecated name for qubes-updates-proxy. - -qubes-updates-proxy - Default: enabled in NetVM - - Provide proxy service, which allow access only to yum repos. Filtering is - done based on URLs, so it shouldn't be used as leak control (pretty easy to - bypass), but is enough to prevent some erroneous user actions. - -yum-proxy-setup - Deprecated name for updates-proxy-setup. - -updates-proxy-setup - Default: enabled in AppVM (also in templates) - - Setup yum at startup to use qubes-yum-proxy service. - - .. note:: - - this service is automatically enabled when you allow VM to access yum - proxy (in firewall settings) and disabled when you deny access to yum - proxy. - -disable-default-route - Default: disabled - - Disables the default route for networking. Enabling this service - will prevent the creation of the default route, but the VM will - still be able to reach it's direct neighbors. The functionality - is implemented in /usr/lib/qubes/setup-ip. - -disable-dns-server - Default: disabled - - Enabling this service will result in an empty /etc/resolv.conf. - The functionality is implemented in /usr/lib/qubes/setup-ip. - - -Authors -======= -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/doc/manpages/qvm-shutdown.rst b/doc/manpages/qvm-shutdown.rst deleted file mode 100644 index 8ac86e0f..00000000 --- a/doc/manpages/qvm-shutdown.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. program:: qvm-shutdown - -:program:`qvm-shutdown` -- Gracefully shut down a qube -====================================================== - -.. warning:: - - This page was autogenerated from command-line parser. It shouldn't be 1:1 - conversion, because it would add little value. Please revise it and add - more descriptive help, which normally won't fit in standard ``--help`` - option. - - After rewrite, please remove this admonition. - -Synopsis --------- - -:command:`qvm-shutdown` [-h] [--verbose] [--quiet] [--all] [--exclude *EXCLUDE*] [--force] [--wait] [--timeout *TIMEOUT*] [*VMNAME*] - -Options -------- - -.. option:: --help, -h - - show the help message and exit - -.. option:: --verbose, -v - - increase verbosity - -.. option:: --quiet, -q - - decrease verbosity - -.. option:: --all - - perform the action on all qubes - -.. option:: --exclude=EXCLUDE - - exclude the qube from :option:`--all` - -.. option:: --force - - force operation, even if may damage other VMs (eg. shutdown of network - provider) - -.. option:: --wait - - wait for the VMs to shut down - -.. option:: --timeout - - timeout after which domains are killed when using :option:`--wait` - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-start.rst b/doc/manpages/qvm-start.rst deleted file mode 100644 index 2e0b1311..00000000 --- a/doc/manpages/qvm-start.rst +++ /dev/null @@ -1,80 +0,0 @@ -.. program:: qvm-start - -:program:`qvm-start` -- start a domain -====================================== - -.. warning:: - - This page was autogenerated from command-line parser. It shouldn't be 1:1 - conversion, because it would add little value. Please revise it and add - more descriptive help, which normally won't fit in standard ``--help`` - option. - - After rewrite, please remove this admonition. - -Synopsis --------- - -:command:`qvm-start` skel-manpage.py [-h] [--verbose] [--quiet] [--drive *DRIVE* | --hddisk *IMAGE* | --cdrom *IMAGE* | --install-windows-tools] [--conf-file *FILE*] [--debug] [--preparing-dvm] [--no-start-guid] *VMNAME* - -Options -------- - -.. option:: --help, -h - - Show help message and exit. - -.. option:: --verbose, -v - - Increase verbosity. - -.. option:: --quiet, -q - - Decrease verbosity. - -.. option:: --drive=DRIVE - - Temporarily attach specified drive as CD/DVD or hard disk, which can be - specified with prefix "hd:" or "cdrom:". If not specified, default is cdrom. - -.. option:: --hddisk=IMAGE - - Temporarily attach specified drive as hard disk. - -.. option:: --cdrom=IMAGE - - Temporarily attach specified drive as optical drive. - -.. option:: --install-windows-tools - - Temporarily ttach Windows tools CDROM to the domain. - -.. option:: --conf-file=FILE - - Use custom libvirt config instead of Qubes-generated one. - -.. option:: --debug - - Enable debug mode for this domain (until its shutdown). - -.. option:: --preparing-dvm - - Do actions necessary when preparing DVM image. - -.. option:: --skip-if-running - - Do not fail if the qube is already runnning - -.. option:: --no-start-guid, --no-guid - - Do not start GUI daemon. - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-tags.rst b/doc/manpages/qvm-tags.rst deleted file mode 100644 index 3f23e2ee..00000000 --- a/doc/manpages/qvm-tags.rst +++ /dev/null @@ -1,58 +0,0 @@ -.. program:: qvm-tags - -:program:`qvm-tags` -- manage domain's tags -=========================================== - -.. warning:: - - This page was autogenerated from command-line parser. It shouldn't be 1:1 - conversion, because it would add little value. Please revise it and add - more descriptive help, which normally won't fit in standard ``--help`` - option. - - After rewrite, please remove this admonition. - -Synopsis --------- - -:command:`qvm-tags` [-h] [--verbose] [--quiet] [--query | --set | --unset] *VMNAME* [*TAG*] - -Options -------- - -.. option:: --help, -h - - Show the help message and exit. - -.. option:: --verbose, -v - - Increase verbosity. - -.. option:: --quiet, -q - - Decrease verbosity. - -.. option:: --query - - Query for the tag. Exit with zero (true) if the qube in question has the tag - and with non-zero (false) if it does not. If no tag specified, list all the - tags. - - This is the default mode. - -.. option:: --set, -s - - Set the tag. The tag argument is mandatory. If tag is already set, do - nothing. - -.. option:: --delete, --unset, -D - - Unset the tag. The tag argument is mandatory. If tag is not set, do nothing. - -Authors -------- - -| Joanna Rutkowska -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/manpages/qvm-template-commit.rst b/doc/manpages/qvm-template-commit.rst deleted file mode 100644 index fd554068..00000000 --- a/doc/manpages/qvm-template-commit.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. program:: qvm-template-commit - -============================================================== -:program:`qvm-template-commit` -- Commit changes to a template -============================================================== - -Synopsis -======== -:command:`qvm-template-commit` [*options*] <*vm-name*> - -Options -======= - -.. option:: --help, -h - - Show this help message and exit - -.. option:: --verbose, -v - - Increase verbosity. - -.. option:: --quiet, -q - - Decrease verbosity. - -Authors -======= -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/doc/manpages/qvm-unpause.rst b/doc/manpages/qvm-unpause.rst deleted file mode 100644 index 3705c3b2..00000000 --- a/doc/manpages/qvm-unpause.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. program:: qvm-unpause - -:program:`qvm-unpause` -- unpause a domain -========================================== - -Synopsis --------- - -:command:`qvm-unpause` [-h] [--verbose] [--quiet] *VMNAME* - -Options -------- - -.. option:: --help, -h - - Show the help message and exit. - -.. option:: --verbose, -v - - Increase verbosity. - -.. option:: --quiet, -q - - Decrease verbosity. - -.. option:: --all - - Unause all the qubes. - -.. option:: --exclude=EXCLUDE - - Exclude the qube from :option:`--all`. - -Authors -------- - -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski -| Wojtek Porczyk - -.. vim: ts=3 sw=3 et tw=80 diff --git a/doc/qubes-tools/qvm_ls.rst b/doc/qubes-tools/qvm_ls.rst deleted file mode 100644 index 730c8775..00000000 --- a/doc/qubes-tools/qvm_ls.rst +++ /dev/null @@ -1,8 +0,0 @@ -:py:mod:`qubes.tools.qvm_ls` -- VM listing -========================================== - -.. automodule:: qubes.tools.qvm_ls - :members: - :show-inheritance: - -.. vim: ts=3 sw=3 et diff --git a/doc/qubes-tools/qvm_start.rst b/doc/qubes-tools/qvm_start.rst deleted file mode 100644 index 30d79107..00000000 --- a/doc/qubes-tools/qvm_start.rst +++ /dev/null @@ -1,8 +0,0 @@ -:py:mod:`qubes.tools.qvm_start` -- Start a domain -================================================= - -.. automodule:: qubes.tools.qvm_start - :members: - :show-inheritance: - -.. vim: ts=3 sw=3 et diff --git a/doc/qvm-tools/qvm-check.rst b/doc/qvm-tools/qvm-check.rst deleted file mode 100644 index ac775ec8..00000000 --- a/doc/qvm-tools/qvm-check.rst +++ /dev/null @@ -1,32 +0,0 @@ -========= -qvm-check -========= - -NAME -==== -qvm-check - Specify no state options to check if VM exists - -:Date: 2013-06-23 - -SYNOPSIS -======== -| qvm-check [options] - -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 -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/doc/qvm-tools/qvm-grow-root.rst b/doc/qvm-tools/qvm-grow-root.rst deleted file mode 100644 index 1c733064..00000000 --- a/doc/qvm-tools/qvm-grow-root.rst +++ /dev/null @@ -1,26 +0,0 @@ -============= -qvm-grow-root -============= - -NAME -==== -qvm-grow-root - increase root storage capacity of a specified VM - -:Date: 2014-03-21 - -SYNOPSIS -======== -| qvm-grow-root - -OPTIONS -======= --h, --help - Show this help message and exit ---allow-start - Allow VM to be started to complete the operation - -AUTHORS -======= -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/doc/qvm-tools/qvm-usb.rst b/doc/qvm-tools/qvm-usb.rst deleted file mode 100644 index 50c92d22..00000000 --- a/doc/qvm-tools/qvm-usb.rst +++ /dev/null @@ -1,36 +0,0 @@ -======= -qvm-usb -======= - -NAME -==== -qvm-usb - List/set VM USB devices - -:Date: 2013-03-16 - -SYNOPSIS -======== -| qvm-usb -l [options] -| qvm-usb -a [options] : -| qvm-usb -d [options] : - -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 -| Rafal Wojtczuk -| Marek Marczykowski diff --git a/rpm_spec/core-dom0-doc.spec b/rpm_spec/core-dom0-doc.spec index 2cdd5581..6a7eec65 100644 --- a/rpm_spec/core-dom0-doc.spec +++ b/rpm_spec/core-dom0-doc.spec @@ -58,5 +58,4 @@ rm -rf $RPM_BUILD_ROOT %files %defattr(-,root,root,-) -%{_mandir}/man1/qvm-*.1* %{_mandir}/man1/qubes*.1*