From e50ca5131ffd1c2655683a81704e3df01982bf5a Mon Sep 17 00:00:00 2001 From: Wojtek Porczyk Date: Mon, 26 Jan 2015 17:17:48 +0100 Subject: [PATCH] doc: move manpages to common directory --- doc/conf.py | 49 +++++++++-------- doc/index.rst | 14 +---- doc/manpages/index.rst | 10 ++++ doc/{qubes-tools => manpages}/qubes-guid.rst | 0 doc/{qubes-tools => manpages}/qubes-prefs.rst | 0 doc/{qvm-tools => manpages}/qvm-add-appvm.rst | 0 .../qvm-add-template.rst | 0 .../qvm-backup-restore.rst | 0 doc/{qvm-tools => manpages}/qvm-backup.rst | 0 doc/{qvm-tools => manpages}/qvm-block.rst | 2 +- .../qvm-clone-template.rst | 3 +- doc/{qvm-tools => manpages}/qvm-clone.rst | 3 +- .../qvm-create-default-dvm.rst | 0 doc/{qvm-tools => manpages}/qvm-create.rst | 3 +- doc/{qvm-tools => manpages}/qvm-firewall.rst | 0 .../qvm-grow-private.rst | 0 doc/{qvm-tools => manpages}/qvm-kill.rst | 0 doc/manpages/qvm-ls.rst | 50 +++++++++++++++++ doc/{qvm-tools => manpages}/qvm-pci.rst | 4 +- doc/{qvm-tools => manpages}/qvm-prefs.rst | 0 doc/{qvm-tools => manpages}/qvm-remove.rst | 2 +- .../qvm-revert-template-changes.rst | 0 doc/{qvm-tools => manpages}/qvm-run.rst | 2 +- doc/{qvm-tools => manpages}/qvm-service.rst | 0 doc/{qvm-tools => manpages}/qvm-shutdown.rst | 2 +- doc/{qvm-tools => manpages}/qvm-start.rst | 2 +- .../qvm-template-commit.rst | 0 doc/qubes-tools/index.rst | 8 --- doc/qvm-tools/index.rst | 8 --- doc/qvm-tools/qvm-ls.rst | 54 ------------------- 30 files changed, 95 insertions(+), 121 deletions(-) create mode 100644 doc/manpages/index.rst rename doc/{qubes-tools => manpages}/qubes-guid.rst (100%) rename doc/{qubes-tools => manpages}/qubes-prefs.rst (100%) rename doc/{qvm-tools => manpages}/qvm-add-appvm.rst (100%) rename doc/{qvm-tools => manpages}/qvm-add-template.rst (100%) rename doc/{qvm-tools => manpages}/qvm-backup-restore.rst (100%) rename doc/{qvm-tools => manpages}/qvm-backup.rst (100%) rename doc/{qvm-tools => manpages}/qvm-block.rst (96%) rename doc/{qvm-tools => manpages}/qvm-clone-template.rst (96%) rename doc/{qvm-tools => manpages}/qvm-clone.rst (96%) rename doc/{qvm-tools => manpages}/qvm-create-default-dvm.rst (100%) rename doc/{qvm-tools => manpages}/qvm-create.rst (99%) rename doc/{qvm-tools => manpages}/qvm-firewall.rst (100%) rename doc/{qvm-tools => manpages}/qvm-grow-private.rst (100%) rename doc/{qvm-tools => manpages}/qvm-kill.rst (100%) create mode 100644 doc/manpages/qvm-ls.rst rename doc/{qvm-tools => manpages}/qvm-pci.rst (96%) rename doc/{qvm-tools => manpages}/qvm-prefs.rst (100%) rename doc/{qvm-tools => manpages}/qvm-remove.rst (97%) rename doc/{qvm-tools => manpages}/qvm-revert-template-changes.rst (100%) rename doc/{qvm-tools => manpages}/qvm-run.rst (98%) rename doc/{qvm-tools => manpages}/qvm-service.rst (100%) rename doc/{qvm-tools => manpages}/qvm-shutdown.rst (97%) rename doc/{qvm-tools => manpages}/qvm-start.rst (97%) rename doc/{qvm-tools => manpages}/qvm-template-commit.rst (100%) delete mode 100644 doc/qubes-tools/index.rst delete mode 100644 doc/qvm-tools/index.rst delete mode 100644 doc/qvm-tools/qvm-ls.rst diff --git a/doc/conf.py b/doc/conf.py index bb05dec8..41a8ab74 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -239,55 +239,54 @@ latex_documents = [ _man_pages_author = [] man_pages = [ - ('qvm-tools/qvm-add-appvm', 'qvm-add-appvm', + ('manpages/qvm-add-appvm', 'qvm-add-appvm', u'Add an already installed appvm to the Qubes DB', _man_pages_author, 1), - ('qvm-tools/qvm-add-template', 'qvm-add-template', + ('manpages/qvm-add-template', 'qvm-add-template', u'Adds an already installed template to the Qubes DB', _man_pages_author, 1), - ('qvm-tools/qvm-backup-restore', 'qvm-backup-restore', + ('manpages/qvm-backup-restore', 'qvm-backup-restore', u'Restores Qubes VMs from backup', _man_pages_author, 1), - ('qvm-tools/qvm-backup', 'qvm-backup', + ('manpages/qvm-backup', 'qvm-backup', u'Create backup of specified VMs', _man_pages_author, 1), - ('qvm-tools/qvm-block', 'qvm-block', + ('manpages/qvm-block', 'qvm-block', u'List/set VM block devices.', _man_pages_author, 1), - ('qvm-tools/qvm-clone-template', 'qvm-clone-template', + ('manpages/qvm-clone-template', 'qvm-clone-template', u'Clones an existing template by copying all its disk files', _man_pages_author, 1), - ('qvm-tools/qvm-clone', 'qvm-clone', + ('manpages/qvm-clone', 'qvm-clone', u'Clones an existing VM by copying all its disk files', _man_pages_author, 1), - ('qvm-tools/qvm-create-default-dvm', 'qvm-create-default-dvm', + ('manpages/qvm-create-default-dvm', 'qvm-create-default-dvm', u'Creates a default disposable VM', _man_pages_author, 1), - ('qvm-tools/qvm-create', 'qvm-create', + ('manpages/qvm-create', 'qvm-create', u'Creates a new VM', _man_pages_author, 1), - ('qvm-tools/qvm-firewall', 'qvm-firewall', + ('manpages/qvm-firewall', 'qvm-firewall', u'Qubes firewall configuration', _man_pages_author, 1), - ('qvm-tools/qvm-grow-private', 'qvm-grow-private', + ('manpages/qvm-grow-private', 'qvm-grow-private', u'Increase private storage capacity of a specified VM', _man_pages_author, 1), - ('qvm-tools/qvm-kill', 'qvm-kill', + ('manpages/qvm-kill', 'qvm-kill', u'Kill the specified VM', _man_pages_author, 1), - ('qvm-tools/qvm-ls', 'qvm-ls', + ('manpages/qvm-ls', 'qvm-ls', u'List VMs and various information about them', _man_pages_author, 1), - ('qvm-tools/qvm-pci', 'qvm-pci', + ('manpages/qvm-pci', 'qvm-pci', u'List/set VM PCI devices', _man_pages_author, 1), - ('qvm-tools/qvm-prefs', 'qvm-prefs', + ('manpages/qvm-prefs', 'qvm-prefs', u'List/set various per-VM properties', _man_pages_author, 1), - ('qvm-tools/qvm-remove', 'qvm-remove', + ('manpages/qvm-remove', 'qvm-remove', u'Remove a VM', _man_pages_author, 1), - ('qvm-tools/qvm-revert-template-changes', 'qvm-revert-template-changes', + ('manpages/qvm-revert-template-changes', 'qvm-revert-template-changes', u'Revert changes to a template', _man_pages_author, 1), - ('qvm-tools/qvm-run', 'qvm-run', + ('manpages/qvm-run', 'qvm-run', u'Run a command on a specified VM', _man_pages_author, 1), - ('qvm-tools/qvm-service', 'qvm-service', + ('manpages/qvm-service', 'qvm-service', u'Manage (Qubes-specific) services started in VM', _man_pages_author, 1), - ('qvm-tools/qvm-shutdown', 'qvm-shutdown', + ('manpages/qvm-shutdown', 'qvm-shutdown', u'Gracefully shut down a VM', _man_pages_author, 1), - ('qvm-tools/qvm-start', 'qvm-start', + ('manpages/qvm-start', 'qvm-start', u'Start a specified VM', _man_pages_author, 1), - ('qvm-tools/qvm-template-commit', 'qvm-template-commit', + ('manpages/qvm-template-commit', 'qvm-template-commit', u'Commit changes to a template', _man_pages_author, 1), - - ('qubes-tools/qubes-guid', 'qubes-guid', + ('manpages/qubes-guid', 'qubes-guid', u'Daemon for Qubes GUI isolation protocol', _man_pages_author, 1), - ('qubes-tools/qubes-prefs', 'qubes-prefs', + ('manpages/qubes-prefs', 'qubes-prefs', u'Display system-wide Qubes settings', _man_pages_author, 1), ] diff --git a/doc/index.rst b/doc/index.rst index cb3de45a..c5d3eb8b 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -10,19 +10,6 @@ This page contains documentation autogenerated from source tree. It includes manpages and API documentation. For primary user documentation, see `https://wiki.qubes-os.org `_. -User documentation ------------------- - -.. toctree:: - :maxdepth: 2 - :glob: - - qvm-tools/index - qubes-tools/index - -Developer documentation ------------------------ - .. toctree:: :maxdepth: 2 @@ -39,6 +26,7 @@ Developer documentation :maxdepth: 1 autoxml + manpages/index Indices and tables ================== diff --git a/doc/manpages/index.rst b/doc/manpages/index.rst new file mode 100644 index 00000000..4162df0e --- /dev/null +++ b/doc/manpages/index.rst @@ -0,0 +1,10 @@ +Command line utilities +====================== + +Those are manual pages provided for command line tools, just formatted in HTML. + +.. toctree:: + :maxdepth: 1 + :glob: + + * diff --git a/doc/qubes-tools/qubes-guid.rst b/doc/manpages/qubes-guid.rst similarity index 100% rename from doc/qubes-tools/qubes-guid.rst rename to doc/manpages/qubes-guid.rst diff --git a/doc/qubes-tools/qubes-prefs.rst b/doc/manpages/qubes-prefs.rst similarity index 100% rename from doc/qubes-tools/qubes-prefs.rst rename to doc/manpages/qubes-prefs.rst diff --git a/doc/qvm-tools/qvm-add-appvm.rst b/doc/manpages/qvm-add-appvm.rst similarity index 100% rename from doc/qvm-tools/qvm-add-appvm.rst rename to doc/manpages/qvm-add-appvm.rst diff --git a/doc/qvm-tools/qvm-add-template.rst b/doc/manpages/qvm-add-template.rst similarity index 100% rename from doc/qvm-tools/qvm-add-template.rst rename to doc/manpages/qvm-add-template.rst diff --git a/doc/qvm-tools/qvm-backup-restore.rst b/doc/manpages/qvm-backup-restore.rst similarity index 100% rename from doc/qvm-tools/qvm-backup-restore.rst rename to doc/manpages/qvm-backup-restore.rst diff --git a/doc/qvm-tools/qvm-backup.rst b/doc/manpages/qvm-backup.rst similarity index 100% rename from doc/qvm-tools/qvm-backup.rst rename to doc/manpages/qvm-backup.rst diff --git a/doc/qvm-tools/qvm-block.rst b/doc/manpages/qvm-block.rst similarity index 96% rename from doc/qvm-tools/qvm-block.rst rename to doc/manpages/qvm-block.rst index b7230b15..143c7846 100644 --- a/doc/qvm-tools/qvm-block.rst +++ b/doc/manpages/qvm-block.rst @@ -21,7 +21,7 @@ Options .. option:: --list, -l - List block devices + List block devices .. option:: --attach, -a diff --git a/doc/qvm-tools/qvm-clone-template.rst b/doc/manpages/qvm-clone-template.rst similarity index 96% rename from doc/qvm-tools/qvm-clone-template.rst rename to doc/manpages/qvm-clone-template.rst index b96dfcbc..2b660389 100644 --- a/doc/qvm-tools/qvm-clone-template.rst +++ b/doc/manpages/qvm-clone-template.rst @@ -16,7 +16,7 @@ Options .. option:: --quiet, -q - Be quiet + Be quiet .. option:: --path=DIR_PATH, -p DIR_PATH @@ -27,4 +27,3 @@ Authors | Joanna Rutkowska | Rafal Wojtczuk | Marek Marczykowski - diff --git a/doc/qvm-tools/qvm-clone.rst b/doc/manpages/qvm-clone.rst similarity index 96% rename from doc/qvm-tools/qvm-clone.rst rename to doc/manpages/qvm-clone.rst index 1dd61554..98cfb5b8 100644 --- a/doc/qvm-tools/qvm-clone.rst +++ b/doc/manpages/qvm-clone.rst @@ -17,7 +17,7 @@ Options .. option:: --quiet, -q - Be quiet + Be quiet .. option:: --path=DIR_PATH, -p DIR_PATH @@ -28,4 +28,3 @@ Authors | Joanna Rutkowska | Rafal Wojtczuk | Marek Marczykowski - diff --git a/doc/qvm-tools/qvm-create-default-dvm.rst b/doc/manpages/qvm-create-default-dvm.rst similarity index 100% rename from doc/qvm-tools/qvm-create-default-dvm.rst rename to doc/manpages/qvm-create-default-dvm.rst diff --git a/doc/qvm-tools/qvm-create.rst b/doc/manpages/qvm-create.rst similarity index 99% rename from doc/qvm-tools/qvm-create.rst rename to doc/manpages/qvm-create.rst index 342302c3..2b09a41e 100644 --- a/doc/qvm-tools/qvm-create.rst +++ b/doc/manpages/qvm-create.rst @@ -72,10 +72,9 @@ Options .. option:: --quiet, -q Be quiet - + Authors ======= | Joanna Rutkowska | Rafal Wojtczuk | Marek Marczykowski - diff --git a/doc/qvm-tools/qvm-firewall.rst b/doc/manpages/qvm-firewall.rst similarity index 100% rename from doc/qvm-tools/qvm-firewall.rst rename to doc/manpages/qvm-firewall.rst diff --git a/doc/qvm-tools/qvm-grow-private.rst b/doc/manpages/qvm-grow-private.rst similarity index 100% rename from doc/qvm-tools/qvm-grow-private.rst rename to doc/manpages/qvm-grow-private.rst diff --git a/doc/qvm-tools/qvm-kill.rst b/doc/manpages/qvm-kill.rst similarity index 100% rename from doc/qvm-tools/qvm-kill.rst rename to doc/manpages/qvm-kill.rst diff --git a/doc/manpages/qvm-ls.rst b/doc/manpages/qvm-ls.rst new file mode 100644 index 00000000..7aefb9ce --- /dev/null +++ b/doc/manpages/qvm-ls.rst @@ -0,0 +1,50 @@ +.. program:: qvm-ls + +:program:`qvm-ls` -- List VMs and various information about them +================================================================ + +Synopsis +-------- + +:command:`qvm-ls` [*options*] + + +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:: --xml=XMLFILE + + Qubes store file + + +Authors +------- +| Joanna Rutkowska +| Rafal Wojtczuk +| Marek Marczykowski +| Wojtek Porczyk + +.. vim: ts=3 sw=3 et diff --git a/doc/qvm-tools/qvm-pci.rst b/doc/manpages/qvm-pci.rst similarity index 96% rename from doc/qvm-tools/qvm-pci.rst rename to doc/manpages/qvm-pci.rst index c72b7205..bfb8f02a 100644 --- a/doc/qvm-tools/qvm-pci.rst +++ b/doc/manpages/qvm-pci.rst @@ -9,7 +9,7 @@ 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 ======= @@ -19,7 +19,7 @@ Options .. option:: --list, -l - List VM PCI devices + List VM PCI devices .. option:: --add, -a diff --git a/doc/qvm-tools/qvm-prefs.rst b/doc/manpages/qvm-prefs.rst similarity index 100% rename from doc/qvm-tools/qvm-prefs.rst rename to doc/manpages/qvm-prefs.rst diff --git a/doc/qvm-tools/qvm-remove.rst b/doc/manpages/qvm-remove.rst similarity index 97% rename from doc/qvm-tools/qvm-remove.rst rename to doc/manpages/qvm-remove.rst index 11ab319b..84647032 100644 --- a/doc/qvm-tools/qvm-remove.rst +++ b/doc/manpages/qvm-remove.rst @@ -17,7 +17,7 @@ Options .. option:: --quiet, -q - Be quiet + Be quiet .. option:: --just-db diff --git a/doc/qvm-tools/qvm-revert-template-changes.rst b/doc/manpages/qvm-revert-template-changes.rst similarity index 100% rename from doc/qvm-tools/qvm-revert-template-changes.rst rename to doc/manpages/qvm-revert-template-changes.rst diff --git a/doc/qvm-tools/qvm-run.rst b/doc/manpages/qvm-run.rst similarity index 98% rename from doc/qvm-tools/qvm-run.rst rename to doc/manpages/qvm-run.rst index 510debd3..958c8cd5 100644 --- a/doc/qvm-tools/qvm-run.rst +++ b/doc/manpages/qvm-run.rst @@ -17,7 +17,7 @@ Options .. option:: --quiet, -q - Be quiet + Be quiet .. option:: --auto, -a diff --git a/doc/qvm-tools/qvm-service.rst b/doc/manpages/qvm-service.rst similarity index 100% rename from doc/qvm-tools/qvm-service.rst rename to doc/manpages/qvm-service.rst diff --git a/doc/qvm-tools/qvm-shutdown.rst b/doc/manpages/qvm-shutdown.rst similarity index 97% rename from doc/qvm-tools/qvm-shutdown.rst rename to doc/manpages/qvm-shutdown.rst index 5ba25506..86cc2523 100644 --- a/doc/qvm-tools/qvm-shutdown.rst +++ b/doc/manpages/qvm-shutdown.rst @@ -17,7 +17,7 @@ Options .. option:: --quiet, -q - Be quiet + Be quiet .. option:: --force diff --git a/doc/qvm-tools/qvm-start.rst b/doc/manpages/qvm-start.rst similarity index 97% rename from doc/qvm-tools/qvm-start.rst rename to doc/manpages/qvm-start.rst index ff68d957..4de56a93 100644 --- a/doc/qvm-tools/qvm-start.rst +++ b/doc/manpages/qvm-start.rst @@ -17,7 +17,7 @@ Options .. option:: --quiet, -q - Be quiet + Be quiet .. option:: --no-guid diff --git a/doc/qvm-tools/qvm-template-commit.rst b/doc/manpages/qvm-template-commit.rst similarity index 100% rename from doc/qvm-tools/qvm-template-commit.rst rename to doc/manpages/qvm-template-commit.rst diff --git a/doc/qubes-tools/index.rst b/doc/qubes-tools/index.rst deleted file mode 100644 index 429b0bfa..00000000 --- a/doc/qubes-tools/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -System-wide tools -================= - -.. toctree:: - :maxdepth: 1 - :glob: - - * diff --git a/doc/qvm-tools/index.rst b/doc/qvm-tools/index.rst deleted file mode 100644 index 6fb256c0..00000000 --- a/doc/qvm-tools/index.rst +++ /dev/null @@ -1,8 +0,0 @@ -VM manipulation tools -===================== - -.. toctree:: - :maxdepth: 1 - :glob: - - * diff --git a/doc/qvm-tools/qvm-ls.rst b/doc/qvm-tools/qvm-ls.rst deleted file mode 100644 index cc722cda..00000000 --- a/doc/qvm-tools/qvm-ls.rst +++ /dev/null @@ -1,54 +0,0 @@ -.. program:: qvm-ls - -================================================================ -:program:`qvm-ls` -- List VMs and various information about them -================================================================ - -Synopsis -======== -:command:`qvm-ls` [*options*] <*vm-name*> - -Options -======= - -.. option:: --help, -h - - Show help message and exit - -.. option:: --network, -n - - Show network addresses assigned to VMs - -.. option:: --cpu, -c - - Show CPU load - -.. option:: --mem, -m - - Show memory usage - -.. option:: --disk, -d - - Show VM disk utilization statistics - -.. option:: --ids, -i - - Show Qubes and Xen id - -.. option:: --kernel, -k - - Show VM kernel options - -.. option:: --last-backup, -b - - Show date of last VM backup - -.. option:: --raw-list - - List only VM names one per line - -Authors -======= -| Joanna Rutkowska -| Rafal Wojtczuk -| Marek Marczykowski