doc: move manpages to common directory

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),
 ]
 

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 <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
 ==================

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:
+
+   *

doc/qvm-tools/qvm-block.rst → doc/manpages/qvm-block.rst

@@ -21,7 +21,7 @@ Options
 
 .. option:: --list, -l
 
-    List block devices            
+    List block devices
 
 .. option:: --attach, -a
 

doc/qvm-tools/qvm-clone-template.rst → 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 <joanna at invisiblethingslab dot com>
 | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
 | Marek Marczykowski <marmarek at invisiblethingslab dot com>
-

doc/qvm-tools/qvm-clone.rst → 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 <joanna at invisiblethingslab dot com>
 | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
 | Marek Marczykowski <marmarek at invisiblethingslab dot com>
-

doc/qvm-tools/qvm-create.rst → doc/manpages/qvm-create.rst

@@ -72,10 +72,9 @@ Options
 .. option:: --quiet, -q
 
     Be quiet
-           
+
 Authors
 =======
 | Joanna Rutkowska <joanna at invisiblethingslab dot com>
 | Rafal Wojtczuk <rafal at invisiblethingslab dot com>
 | Marek Marczykowski <marmarek at invisiblethingslab dot com>
-

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 <joanna at invisiblethingslab dot com>
+| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
+| Marek Marczykowski <marmarek at invisiblethingslab dot com>
+| Wojtek Porczyk <woju at invisiblethingslab dot com>
+
+.. vim: ts=3 sw=3 et

doc/qvm-tools/qvm-pci.rst → 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
 

doc/qvm-tools/qvm-remove.rst → doc/manpages/qvm-remove.rst

@@ -17,7 +17,7 @@ Options
 
 .. option:: --quiet, -q
 
-    Be quiet   
+    Be quiet
 
 .. option:: --just-db
 

doc/qvm-tools/qvm-run.rst → doc/manpages/qvm-run.rst

@@ -17,7 +17,7 @@ Options
 
 .. option:: --quiet, -q
 
-    Be quiet           
+    Be quiet
 
 .. option:: --auto, -a
 

doc/qvm-tools/qvm-shutdown.rst → doc/manpages/qvm-shutdown.rst

@@ -17,7 +17,7 @@ Options
 
 .. option:: --quiet, -q
 
-    Be quiet           
+    Be quiet
 
 .. option:: --force
 

doc/qvm-tools/qvm-start.rst → doc/manpages/qvm-start.rst

@@ -17,7 +17,7 @@ Options
 
 .. option:: --quiet, -q
 
-    Be quiet           
+    Be quiet
 
 .. option:: --no-guid
 

doc/qubes-tools/index.rst

@@ -1,8 +0,0 @@
-System-wide tools
-=================
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   *

doc/qvm-tools/index.rst

@@ -1,8 +0,0 @@
-VM manipulation tools
-=====================
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   *

doc/qvm-tools/qvm-ls.rst

@@ -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 <joanna at invisiblethingslab dot com>
-| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
-| Marek Marczykowski <marmarek at invisiblethingslab dot com>