Move manpages here from separate repo

2013-03-12 16:55:05 +01:00 · 2013-03-12 16:55:05 +01:00 · d9358a91aa
commit d9358a91aa
parent ad2bdf0634
31 changed files with 1086 additions and 1 deletions
--- a/4
+++ b/4
@ -21,8 +21,10 @@ rpms-vm:

 rpms-dom0: rpms-vaio-fixes
 	rpmbuild --define "_rpmdir $(RPMS_DIR)" -bb rpm_spec/core-dom0.spec
+	rpmbuild --define "_rpmdir $(RPMS_DIR)" -bb rpm_spec/core-dom0-doc.spec
 	rpm --addsign \
-		$(RPMS_DIR)/x86_64/qubes-core-dom0-$(VERSION)*.rpm
+		$(RPMS_DIR)/x86_64/qubes-core-dom0-$(VERSION)*.rpm \
+		$(RPMS_DIR)/noarch/qubes-core-dom0-doc-$(VERSION)*rpm

 rpms-vaio-fixes:
 	rpmbuild --define "_rpmdir $(RPMS_DIR)" -bb rpm_spec/core-dom0-vaio-fixes.spec
--- a/doc/.gitignore
+++ b/doc/.gitignore
@ -0,0 +1 @@
+*.gz
--- a/doc/Makefile
+++ b/doc/Makefile
@ -0,0 +1,30 @@
+QVM_DIR=qvm-tools
+QUBES_DIR=qubes-tools
+PANDOC=pandoc -s -f rst -t man
+
+QVM_DOCS=$(patsubst %.rst,%.1.gz,$(wildcard $(QVM_DIR)/*.rst))
+QUBES_DOCS=$(patsubst %.rst,%.1.gz,$(wildcard $(QUBES_DIR)/*.rst))
+
+help:
+	@echo "make rst=example.rst preview	-- generate manpage preview from example.rst"
+	@echo "make manpages			-- generate manpages"
+	@echo "make install			-- generate manpages and copy them to /usr/share/man"
+
+install: manpages
+	mkdir -p $(DESTDIR)/usr/share/man/man1
+	cp $(QVM_DOCS) $(DESTDIR)/usr/share/man/man1/
+	cp $(QUBES_DOCS) $(DESTDIR)/usr/share/man/man1/
+
+%.1: %.rst
+	$(PANDOC) $< > $@
+
+%.1.gz: %.1
+	gzip -f $<
+
+manpages: $(QVM_DOCS) $(QUBES_DOCS) $(VM_DOCS)
+	
+preview:	$(rst)
+	pandoc -s -f rst -t man $(rst) | groff -mandoc -Tlatin1 | less -R
+
+clean:
+	rm -f $(QVM_DOCS) $(QUBES_DOCS) $(VM_DOCS)
--- a/doc/qubes-tools/qubes-dom0-network-via-netvm.rst
+++ b/doc/qubes-tools/qubes-dom0-network-via-netvm.rst
@ -0,0 +1,24 @@
+============================
+qubes-dom0-network-via-netvm
+============================
+
+NAME
+====
+qubes-dom0-network-via-netvm - enables networking in dom0
+
+:Date:   2012-04-13
+
+SYNOPSIS
+========
+| qubes-dom0-network-via-netvm [up|down]
+
+OPTIONS
+=======
+--help
+    Show this help message
+
+AUTHORS
+=======
+| Joanna Rutkowska <joanna at invisiblethingslab dot com>
+| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
+| Marek Marczykowski <marmarek at invisiblethingslab dot com>
--- a/doc/qubes-tools/qubes-dom0-update.rst
+++ b/doc/qubes-tools/qubes-dom0-update.rst
@ -0,0 +1,31 @@
+=================
+qubes-dom0-update
+=================
+
+NAME
+====
+qubes-dom0-update - update software in dom0
+
+:Date:   2012-04-13
+
+SYNOPSIS
+========
+| qubes-dom0-update [--clean] [--check-only] [--gui] [<pkg list>]
+
+OPTIONS
+=======
+--clean
+    Clean yum cache before doing anything
+--check-only
+    Only check for updates (no install)
+--gui
+    Use gpk-update-viewer for update selection
+
+<pkg list>
+    Download (and install if run by root) new packages in dom0 instead of updating
+
+AUTHORS
+=======
+| Joanna Rutkowska <joanna at invisiblethingslab dot com>
+| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
+| Marek Marczykowski <marmarek at invisiblethingslab dot com>
--- a/doc/qubes-tools/qubes-prefs.rst
+++ b/doc/qubes-tools/qubes-prefs.rst
@ -0,0 +1,26 @@
+===========
+qubes-prefs
+===========
+
+NAME
+====
+qubes-prefs - display system-wide Qubes settings, such as:
+
+- clock VM
+- update VM
+- default template
+- default firewallVM
+- default kernel
+- default netVM
+
+:Date:   2012-04-13
+
+SYNOPSIS
+========
+| qubes-prefs
+
+AUTHORS
+=======
+| Joanna Rutkowska <joanna at invisiblethingslab dot com>
+| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
+| Marek Marczykowski <marmarek at invisiblethingslab dot com>
--- a/doc/qubes-tools/qubes_guid.rst
+++ b/doc/qubes-tools/qubes_guid.rst
@ -0,0 +1,32 @@
+==========
+qubes_guid
+==========
+
+NAME
+====
+qubes_guid
+
+:Date:   2012-04-13
+
+SYNOPSIS
+========
+| qubes_guid -d domain_id [-c color] [-l label_index] [-i icon name, no suffix] [-v] [-q]
+
+OPTIONS
+=======
+-v
+    Increase log verbosity
+-q
+    Decrease log verbosity
+
+Log levels:
+    0. only errors
+    1. some basic messages (default)
+    2. debug
+
+
+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-add-appvm.rst
+++ b/doc/qvm-tools/qvm-add-appvm.rst
@ -0,0 +1,30 @@
+=============
+qvm-add-appvm
+=============
+
+NAME
+====
+qvm-add-appvm - add an already installed appvm to the Qubes DB
+
+WARNING: Noramlly you would not need this command, and you would use qvm-create instead!
+
+:Date:   2012-04-10
+
+SYNOPSIS
+========
+| qvm-add-appvm [options] <appvm-name> <vm-template-name>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-p DIR_PATH, --path=DIR_PATH
+    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)
+
+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-add-template.rst
+++ b/doc/qvm-tools/qvm-add-template.rst
@ -0,0 +1,30 @@
+================
+qvm-add-template
+================
+
+NAME
+====
+qvm-add-template - adds an already installed template to the Qubes DB
+
+:Date:   2012-04-10
+
+SYNOPSIS
+========
+| qvm-add-template [options] <vm-template-name>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-p DIR_PATH, --path=DIR_PATH
+    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)
+--rpm
+    Template files have been installed by RPM
+
+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-backup-restore.rst
+++ b/doc/qvm-tools/qvm-backup-restore.rst
@ -0,0 +1,40 @@
+==================
+qvm-backup-restore
+==================
+
+NAME
+====
+qvm-backup-restore - restores Qubes VMs from backup
+
+:Date:   2012-04-10
+
+SYNOPSIS
+========
+| qvm-backup-restore [options] <backup-dir>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+--skip-broken
+    Do not restore VMs that have missing templates or netvms
+--ignore-missing
+    Ignore missing templates or netvms, restore VMs anyway
+--skip-conflicting
+    Do not restore VMs that are already present on the host
+--force-root
+    Force to run, even with root privileges
+--replace-template=REPLACE_TEMPLATE
+    Restore VMs using another template, syntax: old-template-name:new-template-name (might be repeated)
+-x EXCLUDE, --exclude=EXCLUDE
+    Skip restore of specified VM (might be repeated)
+--skip-dom0-home
+    Do not restore dom0 user home dir
+--ignore-username-mismatch
+    Ignore dom0 username mismatch while restoring homedir
+
+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-backup.rst
+++ b/doc/qvm-tools/qvm-backup.rst
@ -0,0 +1,26 @@
+==========
+qvm-backup
+==========
+
+NAME
+====
+qvm-backup
+
+:Date:   2012-04-10
+
+SYNOPSIS
+========
+| qvm-backup [options] <backup-dir-path>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-x EXCLUDE_LIST, --exclude=EXCLUDE_LIST
+    Exclude the specified VM from backup (might be repeated)
+
+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-block.rst
+++ b/doc/qvm-tools/qvm-block.rst
@ -0,0 +1,41 @@
+=========
+qvm-block
+=========
+
+NAME
+====
+qvm-block - list/set VM PCI devices.
+
+
+:Date:   2012-04-10
+
+SYNOPSIS
+========
+| qvm-block -l [options]
+| qvm-block -a [options] <device> <vm-name>
+| 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
+    Attach block device to specified VM
+-d, --detach          
+    Detach block device
+-f FRONTEND, --frontend=FRONTEND
+    Specify device name at destination VM [default: xvdi]
+--ro
+    Force read-only mode
+--no-auto-detach
+    Fail when device already connected to other VM
+
+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
@ -0,0 +1,29 @@
+==================
+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
@ -0,0 +1,29 @@
+=========
+qvm-clone
+=========
+
+NAME
+====
+qvm-clone - clones an existing VM by copying all its disk files
+
+:Date:   2012-04-10
+
+SYNOPSIS
+========
+| qvm-clone [options] <src-name> <new-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-create-default-dvm.rst
+++ b/doc/qvm-tools/qvm-create-default-dvm.rst
@ -0,0 +1,20 @@
+======================
+qvm-create-default-dvm
+======================
+
+NAME
+====
+qvm-create-default-dvm - creates a default disposable VM
+
+:Date:   2012-04-10
+
+SYNOPSIS
+========
+| qvm-create-default-dvm
+
+
+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-create.rst
+++ b/doc/qvm-tools/qvm-create.rst
@ -0,0 +1,45 @@
+==========
+qvm-create
+==========
+
+NAME
+====
+qvm-create - creates a new VM
+
+:Date:   2012-04-10
+
+SYNOPSIS
+========
+| qvm-create [options] <vm-name>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-t TEMPLATE, --template=TEMPLATE
+    Specify the TemplateVM to use
+-l LABEL, --label=LABEL
+    Specify the label to use for the new VM (e.g. red, yellow, green, ...)
+-p, --proxy
+    Create ProxyVM
+-n, --net
+    Create NetVM
+-s, --standalone
+    Create standalone VM - independent of template
+-m MEM, --mem=MEM
+    Initial memory size (in MB)
+-c VCPUS, --vcpus=VCPUS
+    VCPUs count
+-i, --internal
+    Create VM for internal use only (hidden in qubes-manager, no appmenus)
+--force-root
+    Force to run, even with root privileges
+-q, --quiet
+    Be quiet
+           
+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-firewall.rst
+++ b/doc/qvm-tools/qvm-firewall.rst
@ -0,0 +1,46 @@
+============
+qvm-firewall
+============
+
+NAME
+====
+qvm-firewall
+
+:Date:   2012-04-10
+
+SYNOPSIS
+========
+| qvm-firewall [-n] <vm-name> [action] [rule spec]
+
+Rule specification can be one of:
+    1. address|hostname[/netmask] tcp|udp port[-port]
+    2. address|hostname[/netmask] tcp|udp service_name
+    3. address|hostname[/netmask] any
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-l, --list
+    List firewall settings (default action)
+-a, --add
+    Add rule
+-d, --del
+    Remove rule (given by number or by rule spec)
+-P SET_POLICY, --policy=SET_POLICY
+    Set firewall policy (allow/deny)
+-i SET_ICMP, --icmp=SET_ICMP
+    Set ICMP access (allow/deny)
+-D SET_DNS, --dns=SET_DNS
+    Set DNS access (allow/deny)
+-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"
+-n, --numeric
+    Display port numbers instead of services (makes sense only with --list)
+
+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-grow-private.rst
+++ b/doc/qvm-tools/qvm-grow-private.rst
@ -0,0 +1,24 @@
+================
+qvm-grow-private
+================
+
+NAME
+====
+qvm-grow-private - increase private storage capacity of a specified VM
+
+:Date:   2012-04-10
+
+SYNOPSIS
+========
+| qvm-grow-private <vm-name> <size>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+
+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-kill.rst
+++ b/doc/qvm-tools/qvm-kill.rst
@ -0,0 +1,25 @@
+========
+qvm-kill
+========
+
+NAME
+====
+qvm-kill - kills the specified VM
+
+:Date:   2012-04-10
+
+SYNOPSIS
+========
+| qvm-kill [options] <vm-name>
+
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+
+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
@ -0,0 +1,32 @@
+======
+qvm-ls
+======
+
+NAME
+====
+qvm-ls - list VMs and various information about their state
+
+:Date:   2012-04-03
+
+SYNOPSIS
+========
+| qvm-ls [options] <vm-name>
+
+OPTIONS
+=======
+-n, --network
+    Show network addresses assigned to VMs
+-c, --cpu
+    Show CPU load
+-m, --mem
+    Show memory usage
+-d, --disk
+    Show VM disk utilization statistics
+-i, --ids
+    Show Qubes and Xen id
+
+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-pci.rst
+++ b/doc/qvm-tools/qvm-pci.rst
@ -0,0 +1,33 @@
+=======
+qvm-pci
+=======
+
+NAME
+====
+qvm-pci - list/set VM PCI devices
+
+
+:Date:   2012-04-11
+
+SYNOPSIS
+========
+| qvm-pci -l [options] <vm-name>
+| qvm-pci -a [options] <vm-name> <device>
+| qvm-pci -d [options] <vm-name> <device>
+ 
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-l, --list
+    List VM PCI devices    
+-a, --add
+    Add a PCI device to specified VM
+-d, --delete
+    Remove a PCI device from specified VM
+
+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-prefs.rst
+++ b/doc/qvm-tools/qvm-prefs.rst
@ -0,0 +1,108 @@
+=========
+qvm-prefs
+=========
+
+NAME
+====
+qvm-prefs - list/set various per-VM properties
+
+:Date:   2012-04-11
+
+SYNOPSIS
+========
+| qvm-prefs -l [options] <vm-name>
+| qvm-prefs -s [options] <vm-name> <property> [...]
+
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-l, --list
+    List properties of a specified VM
+-s, --set
+    Set properties of a specified VM
+
+PROPERTIES
+==========
+
+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.
+
+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.
+
+    *Notice:* when setting to ``none``, firewall will be set to block all traffic - it will be used by DispVM started from this VM. Setting back to some NetVM will _NOT_ restore previous firewall settings.
+
+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). 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. /dev/sr0). The same syntax can be used in 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 some licencing depending on static MAC address.
+
+default_user
+    Accepted values: username
+
+    Default user used by qvm-run. 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).
+
+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-remove.rst
+++ b/doc/qvm-tools/qvm-remove.rst
@ -0,0 +1,30 @@
+==========
+qvm-remove
+==========
+
+NAME
+====
+qvm-remove - remove a VM
+
+:Date:   2012-04-11
+
+SYNOPSIS
+========
+| qvm-remove [options] <vm-name>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-q, --quiet
+    Be quiet   
+--just-db
+    Remove only from the Qubes Xen DB, do not remove any files
+--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>
--- a/doc/qvm-tools/qvm-revert-template-changes.rst
+++ b/doc/qvm-tools/qvm-revert-template-changes.rst
@ -0,0 +1,26 @@
+===========================
+qvm-revert-template-changes
+===========================
+
+NAME
+====
+qvm-revert-template-changes
+
+:Date:   2012-04-11
+
+SYNOPSIS
+========
+| qvm-revert-template-changes [options] <template-name>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+--force
+    Do not prompt for comfirmation
+
+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-run.rst
+++ b/doc/qvm-tools/qvm-run.rst
@ -0,0 +1,50 @@
+=======
+qvm-run
+=======
+
+NAME
+====
+qvm-run - run a command on a specified VM
+
+:Date:   2012-04-11
+
+SYNOPSIS
+========
+| qvm-run [options] [<vm-name>] [<cmd>]
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-q, --quiet
+    Be quiet           
+-a, --auto
+    Auto start the VM if not running
+-u USER, --user=USER
+    Run command in a VM as a specified user
+--tray
+    Use tray notifications instead of stdout
+--all
+    Run command on all currently running VMs (or all paused, in case of --unpause)
+--exclude=EXCLUDE_LIST
+    When --all is used: exclude this VM name (might be repeated)
+--wait
+    Wait for the VM(s) to shutdown
+--shutdown
+    (deprecated) Do 'xl shutdown' for the VM(s) (can be combined this with --all and --wait)
+--pause
+    Do 'xl pause' for the VM(s) (can be combined this with --all and --wait)
+--unpause
+    Do 'xl unpause' for the VM(s) (can be combined this with --all and --wait)
+-p, --pass-io
+    Pass stdin/stdout/stderr from remote program
+--localcmd=LOCALCMD
+    With --pass-io, pass stdin/stdout/stderr to the given program
+--force
+    Force operation, even if may damage other VMs (eg. shutdown of NetVM)
+
+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-service.rst
+++ b/doc/qvm-tools/qvm-service.rst
@ -0,0 +1,99 @@
+===========
+qvm-service
+===========
+
+NAME
+====
+qvm-service - manage (Qubes-specific) services stared in VM
+
+:Date:   2012-05-30
+
+SYNOPSIS
+========
+| qvm-service [-l] <vmname>
+| qvm-service [-e|-d|-D] <vmname> <service>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-l, --list
+    List services (default action)
+-e, --enable
+    Enable service
+-d, --disable
+    Disable service
+-D, --default
+    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 knowlege 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 defult state), will be recreated with the rule: enabled
+    if VM have no PCI devices assigned, otherwise disabled.
+
+qubes-firewall
+    Default: enabled only in ProxyVM
+
+    Dynamic firewall manager, based on settings in dom0 (qvm-firewall, firewall tab in qubes-manager)
+
+qubes-network
+    Default: enabled only in NetVM and ProxyVM
+
+    Expose network for other VMs. This includes enabling network forwardnig, 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.
+
+network-manager
+    Default: enabled in NetVM
+
+    Enable NetworkManager. Only VM with direct access to network device needs
+    this service. Note that enabling this in a VM which is connected to
+    NetVM/ProxyVM can cause network connectivity problems (namely: loss of IP
+    address and default route).
+
+qubes-yum-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
+    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.
+
+
+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-shutdown.rst
+++ b/doc/qvm-tools/qvm-shutdown.rst
@ -0,0 +1,34 @@
+============
+qvm-shutdown
+============
+
+NAME
+====
+qvm-shutdown
+
+:Date:   2012-04-11
+
+SYNOPSIS
+========
+| qvm-shutdown [options] <vm-name>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-q, --quiet
+    Be quiet           
+--force
+    Force operation, even if may damage other VMs (eg. shutdown of NetVM)
+--wait
+    Wait for the VM(s) to shutdown
+--all
+    Shutdown all running VMs
+--exclude=EXCLUDE_LIST
+    When --all is used: exclude this VM name (might be repeated)
+
+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-start.rst
+++ b/doc/qvm-tools/qvm-start.rst
@ -0,0 +1,34 @@
+=========
+qvm-start
+=========
+
+NAME
+====
+qvm-start - start a specified VM
+
+:Date:   2012-04-11
+
+SYNOPSIS
+========
+| qvm-start [options] <vm-name>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-q, --quiet
+    Be quiet           
+--no-guid
+    Do not start the GUId (ignored)
+--console
+    Attach debugging console to the newly started VM
+--dvm
+    Do actions necessary when preparing DVM image
+--custom-config=CUSTOM_CONFIG
+    Use custom Xen config instead of Qubes-generated one
+
+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-sync-appmenus.rst
+++ b/doc/qvm-tools/qvm-sync-appmenus.rst
@ -0,0 +1,26 @@
+=================
+qvm-sync-appmenus
+=================
+
+NAME
+====
+qvm-sync-appmenus - updates desktop file templates for given StandaloneVM or TemplateVM
+
+:Date:   2012-04-11
+
+SYNOPSIS
+========
+| qvm-sync-appmenus [options] <vm-name>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+-v, --verbose
+    Run in verbose mode 
+ 
+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-template-commit.rst
+++ b/doc/qvm-tools/qvm-template-commit.rst
@ -0,0 +1,24 @@
+===================
+qvm-template-commit
+===================
+
+NAME
+====
+qvm-template-commit
+
+:Date:   2012-04-11
+
+SYNOPSIS
+========
+| qvm-template-commit [options] <vm-name>
+
+OPTIONS
+=======
+-h, --help
+    Show this help message and exit
+
+AUTHORS
+=======
+| Joanna Rutkowska <joanna at invisiblethingslab dot com>
+| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
+| Marek Marczykowski <marmarek at invisiblethingslab dot com>
--- a/rpm_spec/core-dom0-doc.spec
+++ b/rpm_spec/core-dom0-doc.spec
@ -0,0 +1,58 @@
+#
+# The Qubes OS Project, http://www.qubes-os.org
+#
+# Copyright (C) 2010  Joanna Rutkowska <joanna@invisiblethingslab.com>
+# Copyright (C) 2010  Rafal Wojtczuk  <rafal@invisiblethingslab.com>
+# Copyright (C) 2012  Marek Marczykowski <marmarek@invisiblethingslab.com>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+#
+
+%{!?version: %define version %(cat version)}
+
+
+Name:		qubes-core-dom0-doc
+Version:	%{version}
+Release:	1
+Summary:	The Qubes docs for dom0 tools
+
+Group:		Qubes
+Vendor:		Invisible Things Lab
+License:	GPL
+URL:		http://www.qubes-os.org
+BuildRequires: pandoc
+BuildArch: noarch
+Obsoletes:  qubes-doc-dom0 <= 2.0
+
+%define _builddir %(pwd)/doc
+
+%description
+The Qubes docs for dom0 tools
+
+%build
+make manpages
+
+%install
+
+make DESTDIR=$RPM_BUILD_ROOT install
+
+%clean
+rm -rf $RPM_BUILD_ROOT
+
+%files
+%defattr(-,root,root,-)
+%{_mandir}/man1/qvm-*.1*
+%{_mandir}/man1/qubes*.1*