Qubes/core-admin
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

doc: swallow manpages into sphinx

Browse Source
This commit is contained in:
Wojtek Porczyk 2014-11-21 12:30:23 +01:00
parent 96bff66546
commit 2c1cacc0ac
47 changed files with 805 additions and 595 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

184
doc/Makefile
View File

@ -1,30 +1,164 @@
QVM_DIR=qvm-tools # Makefile for Sphinx documentation
QUBES_DIR=qubes-tools #
PANDOC=pandoc -s -f rst -t man
QVM_DOCS=$(patsubst %.rst,%.1.gz,$(wildcard $(QVM_DIR)/*.rst)) # You can set these variables from the command line.
QUBES_DOCS=$(patsubst %.rst,%.1.gz,$(wildcard $(QUBES_DIR)/*.rst)) SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help: help:
@echo "make rst=example.rst preview -- generate manpage preview from example.rst" @echo "Please use \`make <target>' where <target> is one of"
@echo "make manpages -- generate manpages" @echo " html to make standalone HTML files"
@echo "make install -- generate manpages and copy them to /usr/share/man" @echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
install: manpages @echo " pickle to make pickle files"
mkdir -p $(DESTDIR)/usr/share/man/man1 @echo " json to make JSON files"
cp $(QVM_DOCS) $(DESTDIR)/usr/share/man/man1/ @echo " htmlhelp to make HTML files and a HTML help project"
cp $(QUBES_DOCS) $(DESTDIR)/usr/share/man/man1/ @echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
%.1: %.rst @echo " epub to make an epub"
$(PANDOC) $< > $@ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
%.1.gz: %.1 @echo " text to make text files"
gzip -f $< @echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
manpages: $(QVM_DOCS) $(QUBES_DOCS) $(VM_DOCS) @echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
preview: $(rst) @echo " changes to make an overview of all changed/added/deprecated items"
pandoc -s -f rst -t man $(rst) | groff -mandoc -Tlatin1 | less -R @echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo
@echo " install to generate manpages and copy them to \$$(DESTDIR)/usr/share/man"
clean: clean:
rm -f $(QVM_DOCS) $(QUBES_DOCS) $(VM_DOCS) -rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/core-admin.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/core-admin.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/core-admin"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/core-admin"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
for file in $(BUILDDIR)/man/*.[12345678]; do \
gzip -f $$file; \
done
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
.PHONY: install
install: man
mkdir -p $(DESTDIR)/usr/share/man/man1
cp $(BUILDDIR)/man/* $(DESTDIR)/usr/share/man/man1/

153
doc/apidoc/Makefile
View File

@ -1,153 +0,0 @@
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/core-admin.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/core-admin.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/core-admin"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/core-admin"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

61
doc/apidoc/conf.py → doc/conf.py
View File

@ -19,7 +19,7 @@ import time
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here. # documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../../')) sys.path.insert(0, os.path.abspath('../'))
# -- General configuration ----------------------------------------------------- # -- General configuration -----------------------------------------------------
@ -51,7 +51,7 @@ copyright = u'2010-{}, Invisible Things Lab'.format(time.strftime('%Y'))
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = open('../../version').read() version = open('../version').read().strip()
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = subprocess.check_output(['git', 'describe', '--long', '--dirty']).strip() release = subprocess.check_output(['git', 'describe', '--long', '--dirty']).strip()
@ -219,9 +219,62 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
# authors should be empty and authors should be specified in each man page,
# because html builder will omit them
_man_pages_author = []
man_pages = [ man_pages = [
('index', 'core-admin', u'core-admin Documentation', ('qvm-tools/qvm-add-appvm', 'qvm-add-appvm',
[u'Invisible Things Lab'], 1) u'Add an already installed appvm to the Qubes DB', _man_pages_author, 1),
('qvm-tools/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',
u'Restores Qubes VMs from backup', _man_pages_author, 1),
('qvm-tools/qvm-backup', 'qvm-backup',
u'Create backup of specified VMs', _man_pages_author, 1),
('qvm-tools/qvm-block', 'qvm-block',
u'List/set VM block devices.', _man_pages_author, 1),
('qvm-tools/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',
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',
u'Creates a default disposable VM', _man_pages_author, 1),
('qvm-tools/qvm-create', 'qvm-create',
u'Creates a new VM', _man_pages_author, 1),
('qvm-tools/qvm-firewall', 'qvm-firewall',
u'Qubes firewall configuration', _man_pages_author, 1),
('qvm-tools/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',
u'Kill the specified VM', _man_pages_author, 1),
('qvm-tools/qvm-ls', 'qvm-ls',
u'List VMs and various information about them', _man_pages_author, 1),
('qvm-tools/qvm-pci', 'qvm-pci',
u'List/set VM PCI devices', _man_pages_author, 1),
('qvm-tools/qvm-prefs', 'qvm-prefs',
u'List/set various per-VM properties', _man_pages_author, 1),
('qvm-tools/qvm-remove', 'qvm-remove',
u'Remove a VM', _man_pages_author, 1),
('qvm-tools/qvm-revert-template-changes', 'qvm-revert-template-changes',
u'Revert changes to a template', _man_pages_author, 1),
('qvm-tools/qvm-run', 'qvm-run',
u'Run a command on a specified VM', _man_pages_author, 1),
('qvm-tools/qvm-service', 'qvm-service',
u'Manage (Qubes-specific) services started in VM', _man_pages_author, 1),
('qvm-tools/qvm-shutdown', 'qvm-shutdown',
u'Gracefully shut down a VM', _man_pages_author, 1),
('qvm-tools/qvm-start', 'qvm-start',
u'Start a specified VM', _man_pages_author, 1),
('qvm-tools/qvm-template-commit', 'qvm-template-commit',
u'Commit changes to a template', _man_pages_author, 1),
('qubes-tools/qubes-guid', 'qubes-guid',
u'Daemon for Qubes GUI isolation protocol', _man_pages_author, 1),
('qubes-tools/qubes-prefs', 'qubes-prefs',
u'Display system-wide Qubes settings', _man_pages_author, 1),
] ]
# If true, show URL addresses after external links. # If true, show URL addresses after external links.

17
doc/apidoc/index.rst → doc/index.rst
View File

@ -6,7 +6,22 @@
Welcome to core-admin's documentation! Welcome to core-admin's documentation!
====================================== ======================================
Contents: 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:: .. toctree::
:maxdepth: 2 :maxdepth: 2

0
doc/apidoc/qubes-dochelpers.rst → doc/qubes-dochelpers.rst
View File

0
doc/apidoc/qubes-events.rst → doc/qubes-events.rst
View File

0
doc/apidoc/qubes-ext.rst → doc/qubes-ext.rst
View File

0
doc/apidoc/qubes-log.rst → doc/qubes-log.rst
View File

0
doc/apidoc/qubes-plugins.rst → doc/qubes-plugins.rst
View File

8
doc/qubes-tools/index.rst Normal file
View File

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

26
doc/qubes-tools/qubes_guid.rst → doc/qubes-tools/qubes-guid.rst
View File

@ -1,22 +1,22 @@
========== .. program:: qubes-guid
qubes_guid
==========
NAME ================================================================
==== :program:`qubes-guid` -- Daemon for Qubes GUI isolation protocol
qubes_guid ================================================================
:Date: 2012-04-13 Synopsis
SYNOPSIS
======== ========
| qubes_guid -d domain_id [-c color] [-l label_index] [-i icon name, no suffix] [-v] [-q] | qubes-guid -d domain_id [-c color] [-l label_index] [-i icon name, no suffix] [-v] [-q]
OPTIONS Options
======= =======
-v
.. option:: -v
Increase log verbosity Increase log verbosity
-q
.. option:: -q
Decrease log verbosity Decrease log verbosity
Log levels: Log levels:

16
doc/qubes-tools/qubes-prefs.rst
View File

@ -1,10 +1,8 @@
=========== .. program:: qubes-prefs
qubes-prefs
===========
NAME ============================================================
==== :program:`qubes-prefs` -- Display system-wide Qubes settings
qubes-prefs - display system-wide Qubes settings, such as: ============================================================
- clock VM - clock VM
- update VM - update VM
@ -13,13 +11,11 @@ qubes-prefs - display system-wide Qubes settings, such as:
- default kernel - default kernel
- default netVM - default netVM
:Date: 2012-04-13 Synopsis
SYNOPSIS
======== ========
| qubes-prefs | qubes-prefs
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

0
doc/apidoc/qubes-vm/adminvm.rst → doc/qubes-vm/adminvm.rst
View File

0
doc/apidoc/qubes-vm/appvm.rst → doc/qubes-vm/appvm.rst
View File

0
doc/apidoc/qubes-vm/dispvm.rst → doc/qubes-vm/dispvm.rst
View File

0
doc/apidoc/qubes-vm/hvm.rst → doc/qubes-vm/hvm.rst
View File

0
doc/apidoc/qubes-vm/index.rst → doc/qubes-vm/index.rst
View File

0
doc/apidoc/qubes-vm/netvm.rst → doc/qubes-vm/netvm.rst
View File

0
doc/apidoc/qubes-vm/proxyvm.rst → doc/qubes-vm/proxyvm.rst
View File

0
doc/apidoc/qubes-vm/qubesvm.rst → doc/qubes-vm/qubesvm.rst
View File

0
doc/apidoc/qubes-vm/templatehvm.rst → doc/qubes-vm/templatehvm.rst
View File

0
doc/apidoc/qubes-vm/templatevm.rst → doc/qubes-vm/templatevm.rst
View File

0
doc/apidoc/qubes.rst → doc/qubes.rst
View File

8
doc/qvm-tools/index.rst Normal file
View File

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

33
doc/qvm-tools/qvm-add-appvm.rst
View File

@ -1,29 +1,32 @@
============= .. program:: qvm-add-appvm
qvm-add-appvm
=============
NAME ==========================================================================
==== :program:`qvm-add-appvm` -- Add an already installed appvm to the Qubes DB
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! .. warning::
Normally you would not need this command, and you would use qvm-create instead!
:Date: 2012-04-10 Synopsis
SYNOPSIS
======== ========
| qvm-add-appvm [options] <appvm-name> <vm-template-name> | qvm-add-appvm [options] <appvm-name> <vm-template-name>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
-p DIR_PATH, --path=DIR_PATH
.. option:: --path=DIR_PATH, -p DIR_PATH
Specify path to the template directory Specify path to the template directory
-c CONF_FILE, --conf=CONF_FILE
.. option:: --conf=CONF_FILE, -c CONF_FILE
Specify the Xen VM .conf file to use (relative to the template dir path) Specify the Xen VM .conf file to use (relative to the template dir path)
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

34
doc/qvm-tools/qvm-add-template.rst
View File

@ -1,29 +1,33 @@
================ .. program:: qvm-add-template
qvm-add-template
================
NAME =================================================================================
==== :program:`qvm-add-template` -- Adds an already installed template to the Qubes DB
qvm-add-template - adds an already installed template to the Qubes DB =================================================================================
:Date: 2012-04-10 Synopsis
SYNOPSIS
======== ========
| qvm-add-template [options] <vm-template-name> | qvm-add-template [options] <vm-template-name>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
-p DIR_PATH, --path=DIR_PATH
.. option:: --path=DIR_PATH, -p DIR_PATH
Specify path to the template directory Specify path to the template directory
-c CONF_FILE, --conf=CONF_FILE
.. option:: --conf=CONF_FILE, -c CONF_FILE
Specify the Xen VM .conf file to use(relative to the template dir path) Specify the Xen VM .conf file to use(relative to the template dir path)
--rpm
.. option:: --rpm
Template files have been installed by RPM Template files have been installed by RPM
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

57
doc/qvm-tools/qvm-backup-restore.rst
View File

@ -1,39 +1,54 @@
================== .. program:: qvm-backup-restore
qvm-backup-restore
==================
NAME ===============================================================
==== :program:`qvm-backup-restore` -- Restores Qubes VMs from backup
qvm-backup-restore - restores Qubes VMs from backup ===============================================================
:Date: 2012-04-10 Synopsis
SYNOPSIS
======== ========
| qvm-backup-restore [options] <backup-dir> | qvm-backup-restore [options] <backup-dir>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
--skip-broken
.. option:: --skip-broken
Do not restore VMs that have missing templates or netvms Do not restore VMs that have missing templates or netvms
--ignore-missing
.. option:: --ignore-missing
Ignore missing templates or netvms, restore VMs anyway Ignore missing templates or netvms, restore VMs anyway
--skip-conflicting
.. option:: --skip-conflicting
Do not restore VMs that are already present on the host Do not restore VMs that are already present on the host
--force-root
.. option:: --force-root
Force to run, even with root privileges 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) .. option:: --replace-template=REPLACE_TEMPLATE
-x EXCLUDE, --exclude=EXCLUDE
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) Skip restore of specified VM (might be repeated)
--skip-dom0-home
.. option:: --skip-dom0-home
Do not restore dom0 user home dir Do not restore dom0 user home dir
--ignore-username-mismatch
.. option:: --ignore-username-mismatch
Ignore dom0 username mismatch while restoring homedir Ignore dom0 username mismatch while restoring homedir
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

26
doc/qvm-tools/qvm-backup.rst
View File

@ -1,25 +1,25 @@
========== .. program:: qvm-backup
qvm-backup
==========
NAME =======================================================
==== :program:`qvm-backup` -- Create backup of specified VMs
qvm-backup =======================================================
:Date: 2012-04-10 Synopsis
SYNOPSIS
======== ========
| qvm-backup [options] <backup-dir-path> | qvm-backup [options] <backup-dir-path>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
-x EXCLUDE_LIST, --exclude=EXCLUDE_LIST
.. option:: --exclude=EXCLUDE_LIST, -x EXCLUDE_LIST
Exclude the specified VM from backup (might be repeated) Exclude the specified VM from backup (might be repeated)
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

47
doc/qvm-tools/qvm-block.rst
View File

@ -1,15 +1,10 @@
========= .. program:: qvm-block
qvm-block
=========
NAME ===============================================
==== :program:`qvm-block` -- List/set VM PCI devices
qvm-block - list/set VM PCI devices. ===============================================
Synopsis
:Date: 2012-04-10
SYNOPSIS
======== ========
| qvm-block -l [options] | qvm-block -l [options]
| qvm-block -a [options] <device> <vm-name> | qvm-block -a [options] <device> <vm-name>
@ -17,24 +12,38 @@ SYNOPSIS
| qvm-block -d [options] <vm-name> | qvm-block -d [options] <vm-name>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
-l, --list
.. option:: --list, -l
List block devices List block devices
-a, --attach
.. option:: --attach, -a
Attach block device to specified VM Attach block device to specified VM
-d, --detach
.. option:: --detach, -d
Detach block device Detach block device
-f FRONTEND, --frontend=FRONTEND
.. option:: --frontend=FRONTEND, -f FRONTEND
Specify device name at destination VM [default: xvdi] Specify device name at destination VM [default: xvdi]
--ro
.. option:: --ro
Force read-only mode Force read-only mode
--no-auto-detach
.. option:: --no-auto-detach
Fail when device already connected to other VM Fail when device already connected to other VM
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

29
doc/qvm-tools/qvm-clone-template.rst
View File

@ -1,27 +1,28 @@
================== .. program:: qvm-clone-template
qvm-clone-template
==================
NAME ==========================================================================================
==== :program:`qvm-clone-template` -- Clones an existing template by copying all its disk files
qvm-clone-template - clones an existing template by copying all its disk files ==========================================================================================
:Date: 2012-04-10 Synopsis
SYNOPSIS
======== ========
| qvm-clone-template [options] <src-template-name> <new-template-name> | qvm-clone-template [options] <src-template-name> <new-template-name>
OPTIONS Options
======= =======
-h, --help .. option:: --help, -h
Show this help message and exit Show this help message and exit
-q, --quiet
.. option:: --quiet, -q
Be quiet Be quiet
-p DIR_PATH, --path=DIR_PATH
.. option:: --path=DIR_PATH, -p DIR_PATH
Specify path to the template directory Specify path to the template directory
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

30
doc/qvm-tools/qvm-clone.rst
View File

@ -1,27 +1,29 @@
========= .. program:: qvm-clone
qvm-clone
=========
NAME ===========================================================================
==== :program:`qvm-clone` -- Clones an existing VM by copying all its disk files
qvm-clone - clones an existing VM by copying all its disk files ===========================================================================
:Date: 2012-04-10 Synopsis
SYNOPSIS
======== ========
| qvm-clone [options] <src-name> <new-name> | qvm-clone [options] <src-name> <new-name>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
-q, --quiet
.. option:: --quiet, -q
Be quiet Be quiet
-p DIR_PATH, --path=DIR_PATH
.. option:: --path=DIR_PATH, -p DIR_PATH
Specify path to the template directory Specify path to the template directory
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

17
doc/qvm-tools/qvm-create-default-dvm.rst
View File

@ -1,14 +1,10 @@
====================== .. program:: qvm-create-default-dvm
qvm-create-default-dvm
======================
NAME ====================================================================
==== :program:`qvm-create-default-dvm` -- Creates a default Disposable VM
qvm-create-default-dvm - creates a default disposable VM ====================================================================
:Date: 2012-04-10 Synopsis
SYNOPSIS
======== ========
| qvm-create-default-dvm templatename|--default-template|--used-template [script-name|--default-script] | qvm-create-default-dvm templatename|--default-template|--used-template [script-name|--default-script]
@ -29,8 +25,7 @@ templatename
--default-script --default-script
Use default script for seeding DispVM home. Use default script for seeding DispVM home.
Authors
AUTHORS
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

86
doc/qvm-tools/qvm-create.rst
View File

@ -1,53 +1,79 @@
========== .. program:: qvm-create
qvm-create
==========
NAME =========================================
==== :program:`qvm-create` -- Creates a new VM
qvm-create - creates a new VM =========================================
:Date: 2012-04-10 Synopsis
SYNOPSIS
======== ========
| qvm-create [options] <vm-name> | qvm-create [options] <vm-name>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
-t TEMPLATE, --template=TEMPLATE
.. option:: --template=TEMPLATE, -t TEMPLATE
Specify the TemplateVM to use Specify the TemplateVM to use
-l LABEL, --label=LABEL
.. option:: --label=LABEL, -l LABEL
Specify the label to use for the new VM (e.g. red, yellow, green, ...) Specify the label to use for the new VM (e.g. red, yellow, green, ...)
-p, --proxy
.. option:: --proxy, -p
Create ProxyVM Create ProxyVM
-n, --net
.. option:: --net, -n
Create NetVM Create NetVM
-H, --hvm
Create HVM (standalone, unless --template option used) .. option:: --hvm, -H
--hvm-template
Create HVM (standalone, unless :option:`--template` option used)
.. option:: --hvm-template
Create HVM template Create HVM template
-R ROOT_MOVE, --root-move-from=ROOT_MOVE
.. option:: --root-move-from=ROOT_MOVE, -R ROOT_MOVE
Use provided root.img instead of default/empty one Use provided root.img instead of default/empty one
(file will be MOVED) (file will be *moved*)
-r ROOT_COPY, --root-copy-from=ROOT_COPY
.. option:: --root-copy-from=ROOT_COPY, -r ROOT_COPY
Use provided root.img instead of default/empty one Use provided root.img instead of default/empty one
(file will be COPIED) (file will be *copied*)
-s, --standalone
Create standalone VM - independent of template .. option:: --standalone, -s
-m MEM, --mem=MEM
Create standalone VM --- independent of template
.. option:: --mem=MEM, -m MEM
Initial memory size (in MB) Initial memory size (in MB)
-c VCPUS, --vcpus=VCPUS
.. option:: --vcpus=VCPUS, -c VCPUS
VCPUs count VCPUs count
-i, --internal
.. option:: --internal, -i
Create VM for internal use only (hidden in qubes-manager, no appmenus) Create VM for internal use only (hidden in qubes-manager, no appmenus)
--force-root
.. option:: --force-root
Force to run, even with root privileges Force to run, even with root privileges
-q, --quiet
.. option:: --quiet, -q
Be quiet Be quiet
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

76
doc/qvm-tools/qvm-firewall.rst
View File

@ -1,14 +1,10 @@
============ .. program:: qvm-firewall
qvm-firewall
============
NAME =======================================================
==== :program:`qvm-firewall` -- Qubes firewall configuration
qvm-firewall =======================================================
:Date: 2012-04-10 Synopsis
SYNOPSIS
======== ========
| qvm-firewall [-n] <vm-name> [action] [rule spec] | qvm-firewall [-n] <vm-name> [action] [rule spec]
@ -17,29 +13,49 @@ Rule specification can be one of:
2. address|hostname[/netmask] tcp|udp service_name 2. address|hostname[/netmask] tcp|udp service_name
3. address|hostname[/netmask] any 3. address|hostname[/netmask] any
OPTIONS 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 .. option:: --help, -h
Show this help message and exit
.. option:: --list, -l
List firewall settings (default action)
.. option:: --add, -a
Add rule
.. option:: --del, -d
Remove rule (given by number or by rule spec)
.. option:: --policy=SET_POLICY, -P SET_POLICY
Set firewall policy (allow/deny)
.. option:: --icmp=SET_ICMP, -i SET_ICMP
Set ICMP access (allow/deny)
.. option:: --dns=SET_DNS, -D SET_DNS
Set DNS access (allow/deny)
.. option:: --yum-proxy=SET_YUM_PROXY, -Y 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"
.. option:: --numeric, -n
Display port numbers instead of services (makes sense only with :option:`--list`)
Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

22
doc/qvm-tools/qvm-grow-private.rst
View File

@ -1,23 +1,21 @@
================ .. program:: qvm-grow-private
qvm-grow-private
================
NAME ==================================================================================
==== :program:`qvm-grow-private` -- Increase private storage capacity of a specified VM
qvm-grow-private - increase private storage capacity of a specified VM ==================================================================================
:Date: 2012-04-10 Synopsis
SYNOPSIS
======== ========
| qvm-grow-private <vm-name> <size> | qvm-grow-private <vm-name> <size>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

22
doc/qvm-tools/qvm-kill.rst
View File

@ -1,24 +1,22 @@
======== .. program:: qvm-kill
qvm-kill
========
NAME ============================================
==== :program:`qvm-kill` -- Kill the specified VM
qvm-kill - kills the specified VM ============================================
:Date: 2012-04-10 Synopsis
SYNOPSIS
======== ========
| qvm-kill [options] <vm-name> | qvm-kill [options] <vm-name>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

54
doc/qvm-tools/qvm-ls.rst
View File

@ -1,39 +1,53 @@
====== .. program:: qvm-ls
qvm-ls
======
NAME ================================================================
==== :program:`qvm-ls` -- List VMs and various information about them
qvm-ls - list VMs and various information about their state ================================================================
:Date: 2012-04-03 Synopsis
SYNOPSIS
======== ========
| qvm-ls [options] <vm-name> | qvm-ls [options] <vm-name>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show help message and exit Show help message and exit
-n, --network
.. option:: --network, -n
Show network addresses assigned to VMs Show network addresses assigned to VMs
-c, --cpu
.. option:: --cpu, -c
Show CPU load Show CPU load
-m, --mem
.. option:: --mem, -m
Show memory usage Show memory usage
-d, --disk
.. option:: --disk, -d
Show VM disk utilization statistics Show VM disk utilization statistics
-i, --ids
.. option:: --ids, -i
Show Qubes and Xen id Show Qubes and Xen id
-k, --kernel
.. option:: --kernel, -k
Show VM kernel options Show VM kernel options
-b, --last-backup
.. option:: --last-backup, -b
Show date of last VM backup Show date of last VM backup
--raw-list
.. option:: --raw-list
List only VM names one per line List only VM names one per line
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

35
doc/qvm-tools/qvm-pci.rst
View File

@ -1,32 +1,35 @@
======= .. program:: qvm-pci
qvm-pci
=======
NAME =============================================
==== :program:`qvm-pci` -- List/set VM PCI devices
qvm-pci - list/set VM PCI devices =============================================
Synopsis
:Date: 2012-04-11
SYNOPSIS
======== ========
| qvm-pci -l [options] <vm-name> | qvm-pci -l [options] <vm-name>
| qvm-pci -a [options] <vm-name> <device> | qvm-pci -a [options] <vm-name> <device>
| qvm-pci -d [options] <vm-name> <device> | qvm-pci -d [options] <vm-name> <device>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
-l, --list
.. option:: --list, -l
List VM PCI devices List VM PCI devices
-a, --add
.. option:: --add, -a
Add a PCI device to specified VM Add a PCI device to specified VM
-d, --delete
.. option:: --delete, -d
Remove a PCI device from specified VM Remove a PCI device from specified VM
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

36
doc/qvm-tools/qvm-prefs.rst
View File

@ -1,32 +1,36 @@
========= .. program:: qvm-prefs
qvm-prefs
=========
NAME ==========================================================
==== :program:`qvm-prefs` -- List/set various per-VM properties
qvm-prefs - list/set various per-VM properties ==========================================================
:Date: 2012-04-11 Synopsis
SYNOPSIS
======== ========
| qvm-prefs -l [options] <vm-name> | qvm-prefs -l [options] <vm-name>
| qvm-prefs -g [options] <vm-name> <property> | qvm-prefs -g [options] <vm-name> <property>
| qvm-prefs -s [options] <vm-name> <property> [...] | qvm-prefs -s [options] <vm-name> <property> [...]
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
-l, --list
.. option:: --list, -l
List properties of a specified VM List properties of a specified VM
-g, --get
.. option:: --get, -g
Get a single property of a specified VM Get a single property of a specified VM
-s, --set
.. option:: --set, -s
Set properties of a specified VM Set properties of a specified VM
PROPERTIES Properties
========== ==========
include_in_backups include_in_backups
@ -141,7 +145,7 @@ timezone
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). 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 Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

34
doc/qvm-tools/qvm-remove.rst
View File

@ -1,29 +1,33 @@
========== .. program:: qvm-remove
qvm-remove
==========
NAME ====================================
==== :program:`qvm-remove` -- Remove a VM
qvm-remove - remove a VM ====================================
:Date: 2012-04-11 Synopsis
SYNOPSIS
======== ========
| qvm-remove [options] <vm-name> | qvm-remove [options] <vm-name>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
-q, --quiet
.. option:: --quiet, -q
Be quiet Be quiet
--just-db
.. option:: --just-db
Remove only from the Qubes Xen DB, do not remove any files Remove only from the Qubes Xen DB, do not remove any files
--force-root
.. option:: --force-root
Force to run, even with root privileges Force to run, even with root privileges
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

26
doc/qvm-tools/qvm-revert-template-changes.rst
View File

@ -1,25 +1,25 @@
=========================== .. program:: qvm-revert-template-changes
qvm-revert-template-changes
===========================
NAME ======================================================================
==== :program:`qvm-revert-template-changes` -- Revert changes to a template
qvm-revert-template-changes ======================================================================
:Date: 2012-04-11 Synopsis
SYNOPSIS
======== ========
| qvm-revert-template-changes [options] <template-name> | qvm-revert-template-changes [options] <template-name>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
--force
.. option:: --force
Do not prompt for comfirmation Do not prompt for comfirmation
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

92
doc/qvm-tools/qvm-run.rst
View File

@ -1,49 +1,79 @@
======= .. program:: qvm-run
qvm-run
=======
NAME =====================================================
==== :program:`qvm-run` -- Run a command on a specified VM
qvm-run - run a command on a specified VM =====================================================
:Date: 2012-04-11 Synopsis
SYNOPSIS
======== ========
| qvm-run [options] [<vm-name>] [<cmd>] | qvm-run [options] [<vm-name>] [<cmd>]
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
-q, --quiet
.. option:: --quiet, -q
Be quiet Be quiet
-a, --auto
.. option:: --auto, -a
Auto start the VM if not running Auto start the VM if not running
-u USER, --user=USER
.. option:: --user=USER, -u USER
Run command in a VM as a specified user Run command in a VM as a specified user
--tray
.. option:: --tray
Use tray notifications instead of stdout Use tray notifications instead of stdout
--all
Run command on all currently running VMs (or all paused, in case of --unpause) .. option:: --all
--exclude=EXCLUDE_LIST
When --all is used: exclude this VM name (might be repeated) Run command on all currently running VMs (or all paused, in case of :option:`--unpause`)
--wait
.. option:: --exclude=EXCLUDE_LIST
When :option:`--all` is used: exclude this VM name (might be repeated)
.. option:: --wait
Wait for the VM(s) to shutdown Wait for the VM(s) to shutdown
--shutdown
(deprecated) Do 'xl shutdown' for the VM(s) (can be combined this with --all and --wait) .. option:: --shutdown
--pause
Do 'xl pause' for the VM(s) (can be combined this with --all and --wait) Do 'xl shutdown' for the VM(s) (can be combined with :option:`--all` and
--unpause :option:`--wait`)
Do 'xl unpause' for the VM(s) (can be combined this with --all and --wait)
-p, --pass-io .. deprecated:: R2
Use :manpage:`qvm-shutdown(1)` instead.
.. option:: --pause
Do 'xl pause' for the VM(s) (can be combined with :option:`--all` and
:option:`--wait`)
.. option:: --unpause
Do 'xl unpause' for the VM(s) (can be combined with :option:`--all` and
:option:`--wait`)
.. option:: --pass-io, -p
Pass stdin/stdout/stderr from remote program Pass stdin/stdout/stderr from remote program
--localcmd=LOCALCMD
With --pass-io, pass stdin/stdout/stderr to the given program .. option:: --localcmd=LOCALCMD
--force
With :option:`--pass-io`, pass stdin/stdout/stderr to the given program
.. option:: --force
Force operation, even if may damage other VMs (eg. shutdown of NetVM) Force operation, even if may damage other VMs (eg. shutdown of NetVM)
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

43
doc/qvm-tools/qvm-service.rst
View File

@ -1,33 +1,44 @@
=========== .. program:: qvm-service
qvm-service
=========== ========================================================================
:program:`qvm-service` -- Manage (Qubes-specific) services started in VM
========================================================================
NAME NAME
==== ====
qvm-service - manage (Qubes-specific) services started in VM qvm-service -
:Date: 2012-05-30 :Date: 2012-05-30
SYNOPSIS Synopsis
======== ========
| qvm-service [-l] <vmname> | qvm-service [-l] <vmname>
| qvm-service [-e|-d|-D] <vmname> <service> | qvm-service [-e|-d|-D] <vmname> <service>
OPTIONS Options
======= =======
-h, --help .. option:: --help, -h
Show this help message and exit Show this help message and exit
-l, --list
.. option:: --list, -l
List services (default action) List services (default action)
-e, --enable
.. option:: --enable, -e
Enable service Enable service
-d, --disable
.. option:: --disable, -d
Disable service Disable service
-D, --default
.. option:: --default, -D
Reset service to its default state (remove from the list). Default state 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). means "lets VM choose" and can depend on VM type (NetVM, AppVM etc).
SUPPORTED SERVICES Supported services
================== ==================
This list can be incomplete as VM can implement any additional service without knowlege of qubes-core code. This list can be incomplete as VM can implement any additional service without knowlege of qubes-core code.
@ -109,8 +120,10 @@ updates-proxy-setup
Setup yum at startup to use qubes-yum-proxy service. Setup yum at startup to use qubes-yum-proxy service.
*Note:* this service is automatically enabled when you allow VM to access .. note::
yum proxy (in firewall settings) and disabled when you deny access to yum
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. proxy.
disable-default-route disable-default-route
@ -128,7 +141,7 @@ disable-dns-server
The functionality is implemented in /usr/lib/qubes/setup-ip. The functionality is implemented in /usr/lib/qubes/setup-ip.
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

54
doc/qvm-tools/qvm-shutdown.rst
View File

@ -1,33 +1,41 @@
============ .. program:: qvm-shutdown
qvm-shutdown
============
NAME ====================================================
==== :program:`qvm-shutdown` -- Gracefully shut down a VM
qvm-shutdown ====================================================
:Date: 2012-04-11 Synopsis
SYNOPSIS
======== ========
| qvm-shutdown [options] <vm-name> | qvm-shutdown [options] <vm-name>
OPTIONS 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 .. option:: --help, -h
Show this help message and exit
.. option:: --quiet, -q
Be quiet
.. option:: --force
Force operation, even if may damage other VMs (eg. shutdown of NetVM)
.. option:: --wait
Wait for the VM(s) to shutdown
.. option:: --all
Shutdown all running VMs
.. option:: --exclude=EXCLUDE_LIST
When :option:`--all` is used: exclude this VM name (might be repeated)
Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

42
doc/qvm-tools/qvm-start.rst
View File

@ -1,33 +1,41 @@
========= .. program:: qvm-start
qvm-start
=========
NAME ============================================
==== :program:`qvm-start` -- Start a specified VM
qvm-start - start a specified VM ============================================
:Date: 2012-04-11 Synopsis
SYNOPSIS
======== ========
| qvm-start [options] <vm-name> | qvm-start [options] <vm-name>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
-q, --quiet
.. option:: --quiet, -q
Be quiet Be quiet
--no-guid
.. option:: --no-guid
Do not start the GUId (ignored) Do not start the GUId (ignored)
--console
.. option:: --console
Attach debugging console to the newly started VM Attach debugging console to the newly started VM
--dvm
.. option:: --dvm
Do actions necessary when preparing DVM image Do actions necessary when preparing DVM image
--custom-config=CUSTOM_CONFIG
.. option:: --custom-config=CUSTOM_CONFIG
Use custom Xen config instead of Qubes-generated one Use custom Xen config instead of Qubes-generated one
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

22
doc/qvm-tools/qvm-template-commit.rst
View File

@ -1,23 +1,21 @@
=================== .. program:: qvm-template-commit
qvm-template-commit
===================
NAME ==============================================================
==== :program:`qvm-template-commit` -- Commit changes to a template
qvm-template-commit ==============================================================
:Date: 2012-04-11 Synopsis
SYNOPSIS
======== ========
| qvm-template-commit [options] <vm-name> | qvm-template-commit [options] <vm-name>
OPTIONS Options
======= =======
-h, --help
.. option:: --help, -h
Show this help message and exit Show this help message and exit
AUTHORS Authors
======= =======
| Joanna Rutkowska <joanna at invisiblethingslab dot com> | Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com> | Rafal Wojtczuk <rafal at invisiblethingslab dot com>

2
rpm_spec/core-dom0-doc.spec
View File

@ -44,7 +44,7 @@ Provides: qubes-doc-dom0
The Qubes docs for dom0 tools The Qubes docs for dom0 tools
%build %build
make manpages make man
%install %install