Reorganize and update CLI tool references pages for 4.0

Requested by: QubesOS/qubes-issues#3495
Requests:     QubesOS/qubes-issues#3538
This commit is contained in:
Andrew David Wong 2018-02-04 17:32:30 -06:00
parent 0c29e05f3d
commit 35b02c848c
No known key found for this signature in database
GPG key ID: 8CE137352A019A17
38 changed files with 186 additions and 84 deletions

View file

@ -0,0 +1,39 @@
---
layout: doc
title: Dom0 Command-Line Tools for Qubes 3.2
permalink: /doc/tools/3.2/dom0/
redirect_from:
- /doc/tools/3.2/dom0/
- /en/doc/tools/3.2/dom0/
- /doc/DomZeroTools/
- /wiki/DomZeroTools/
---
Dom0 Command-Line Tools for Qubes 3.2
=====================================
* [qubes-dom0-update](/doc/tools/3.2/dom0/qubes-dom0-update/)
* [qubes-prefs](/doc/tools/3.2/dom0/qubes-prefs/)
* [qvm-add-appvm](/doc/tools/3.2/dom0/qvm-add-appvm/)
* [qvm-add-template](/doc/tools/3.2/dom0/qvm-add-template/)
* [qvm-backup-restore](/doc/tools/3.2/dom0/qvm-backup-restore/)
* [qvm-backup](/doc/tools/3.2/dom0/qvm-backup/)
* [qvm-block](/doc/tools/3.2/dom0/qvm-block/)
* [qvm-clone](/doc/tools/3.2/dom0/qvm-clone/)
* [qvm-create-default-dvm](/doc/tools/3.2/dom0/qvm-create-default-dvm/)
* [qvm-create](/doc/tools/3.2/dom0/qvm-create/)
* [qvm-firewall](/doc/tools/3.2/dom0/qvm-firewall/)
* [qvm-grow-private](/doc/tools/3.2/dom0/qvm-grow-private/)
* [qvm-ls](/doc/tools/3.2/dom0/qvm-ls/)
* [qvm-kill](/doc/tools/3.2/dom0/qvm-kill/)
* [qvm-pci](/doc/tools/3.2/dom0/qvm-pci/)
* [qvm-prefs](/doc/tools/3.2/dom0/qvm-prefs/)
* [qvm-remove](/doc/tools/3.2/dom0/qvm-remove/)
* [qvm-revert-template-changes](/doc/tools/3.2/dom0/qvm-revert-template-changes/)
* [qvm-run](/doc/tools/3.2/dom0/qvm-run/)
* [qvm-service](/doc/tools/3.2/dom0/qvm-service/)
* [qvm-shutdown](/doc/tools/3.2/dom0/qvm-shutdown/)
* [qvm-start](/doc/tools/3.2/dom0/qvm-start/)
* [qvm-sync-appmenus](/doc/tools/3.2/dom0/qvm-sync-appmenus/)
* [qvm-template-commit](/doc/tools/3.2/dom0/qvm-template-commit/)

View file

@ -0,0 +1,50 @@
---
layout: doc
title: qubes-dom0-update
permalink: /doc/tools/3.2/dom0/qubes-dom0-update/
redirect_from:
- /doc/dom0-tools/qubes-dom0-update/
- /en/doc/dom0-tools/qubes-dom0-update/
- /doc/Dom0Tools/QubesDom0Update/
- /wiki/Dom0Tools/QubesDom0Update/
---
qubes-dom0-update
=================
NAME
----
qubes-dom0-update - update software in dom0
Date
2012-04-13
SYNOPSIS
--------
qubes-dom0-update [--clean] [--check-only] [--gui] [\<yum opts\>] [\<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
Besides above options, when no --gui or --check-only given, all other options are passed to yum call. So for example --enablerepo/--disablerepo options works as well.
AUTHORS
-------
Joanna Rutkowska \<joanna at invisiblethingslab dot com\>
Rafal Wojtczuk \<rafal at invisiblethingslab dot com\>
Marek Marczykowski \<marmarek at invisiblethingslab dot com\>

View file

@ -0,0 +1,40 @@
---
layout: doc
title: qubes-prefs
permalink: /doc/tools/3.2/dom0/qubes-prefs/
redirect_from:
- /doc/dom0-tools/qubes-prefs/
- /en/doc/dom0-tools/qubes-prefs/
- /doc/Dom0Tools/QubesPrefs/
- /wiki/Dom0Tools/QubesPrefs/
---
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\>

View file

@ -0,0 +1,47 @@
---
layout: doc
title: qvm-add-appvm
permalink: /doc/tools/3.2/dom0/qvm-add-appvm/
redirect_from:
- /doc/dom0-tools/qvm-add-appvm/
- /en/doc/dom0-tools/qvm-add-appvm/
- /doc/Dom0Tools/QvmAddAppvm/
- /wiki/Dom0Tools/QvmAddAppvm/
---
qvm-add-appvm
=============
NAME
----
qvm-add-appvm - add an already installed appvm to the Qubes DB
WARNING: Normally you should not need this command, and you should 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\>

View file

@ -0,0 +1,48 @@
---
layout: doc
title: qvm-add-template
permalink: /doc/tools/3.2/dom0/qvm-add-template/
redirect_from:
- /doc/dom0-tools/qvm-add-template/
- /en/doc/dom0-tools/qvm-add-template/
- /doc/Dom0Tools/QvmAddTemplate/
- /wiki/Dom0Tools/QvmAddTemplate/
---
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\>

View file

@ -0,0 +1,78 @@
---
layout: doc
title: qvm-backup-restore
permalink: /doc/tools/3.2/dom0/qvm-backup-restore/
redirect_from:
- /doc/dom0-tools/qvm-backup-restore/
- /en/doc/dom0-tools/qvm-backup-restore/
- /doc/Dom0Tools/QvmBackupRestore/
- /wiki/Dom0Tools/QvmBackupRestore/
---
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
--verify-only
Do not restore the data, only verify backup integrity
--skip-broken
Do not restore VMs that have missing templates or netvms
--ignore-missing
Ignore missing templates and netvms, and restore the VMs anyway
--skip-conflicting
Do not restore VMs that are already present on the host
--force-root
Force to run with root privileges
--replace-template=REPLACE\_TEMPLATE
Restore VMs using another template, syntax: old-template-name:new-template-name (can be repeated)
-x EXCLUDE, --exclude=EXCLUDE
Skip restore of specified VM (can be repeated)
--skip-dom0-home
Do not restore dom0's user home directory
--ignore-username-mismatch
Ignore dom0 username mismatch when restoring dom0's user home directory
-d APPVM, --dest-vm=APPVM
Restore from a backup located in a specific AppVM
-e, --encrypted
The backup is encrypted
-z, --compressed
The backup is compressed
--debug
Enable (a lot of) debug output
AUTHORS
-------
Joanna Rutkowska \<joanna at invisiblethingslab dot com\>
Rafal Wojtczuk \<rafal at invisiblethingslab dot com\>
Marek Marczykowski \<marmarek at invisiblethingslab dot com\>

View file

@ -0,0 +1,42 @@
---
layout: doc
title: qvm-backup
permalink: /doc/tools/3.2/dom0/qvm-backup/
redirect_from:
- /doc/dom0-tools/qvm-backup/
- /en/doc/dom0-tools/qvm-backup/
- /doc/Dom0Tools/QvmBackup/
- /wiki/Dom0Tools/QvmBackup/
---
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\>

View file

@ -0,0 +1,61 @@
---
layout: doc
title: qvm-block
permalink: /doc/tools/3.2/dom0/qvm-block/
redirect_from:
- /doc/dom0-tools/qvm-block/
- /doc/dom0-tools/qvm-block/
- /en/doc/dom0-tools/qvm-block/
- /doc/Dom0Tools/QvmBlock/
- /wiki/Dom0Tools/QvmBlock/
---
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\>

View file

@ -0,0 +1,45 @@
---
layout: doc
title: qvm-clone
permalink: /doc/tools/3.2/dom0/qvm-clone/
redirect_from:
- /doc/dom0-tools/qvm-clone/
- /en/doc/dom0-tools/qvm-clone/
- /doc/Dom0Tools/QvmClone/
- /wiki/Dom0Tools/QvmClone/
---
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\>

View file

@ -0,0 +1,48 @@
---
layout: doc
title: qvm-create-default-dvm
permalink: /doc/tools/3.2/dom0/qvm-create-default-dvm/
redirect_from:
- /doc/dom0-tools/qvm-create-default-dvm/
- /en/doc/dom0-tools/qvm-create-default-dvm/
- /doc/Dom0Tools/QvmCreateDefaultDvm/
- /wiki/Dom0Tools/QvmCreateDefaultDvm/
---
qvm-create-default-dvm
======================
NAME
----
qvm-create-default-dvm - creates a default disposable VM
Date
2012-04-10
SYNOPSIS
--------
qvm-create-default-dvm templatename|--default-template|--used-template [script-name|--default-script]
OPTIONS
-------
templatename
Base DispVM on given template. The command will create AppVM named after template with "-dvm" suffix. This VM will be used to create DispVM savefile. If you want to customize DispVM, use this VM - take a look at <https://wiki.qubes-os.org/wiki/UserDoc/DispVMCustomization>
--default-template
Use default template for the DispVM
--used-template
Use the same template as earlier
--default-script
Use default script for seeding DispVM home.
AUTHORS
-------
Joanna Rutkowska \<joanna at invisiblethingslab dot com\>
Rafal Wojtczuk \<rafal at invisiblethingslab dot com\>
Marek Marczykowski \<marmarek at invisiblethingslab dot com\>

View file

@ -0,0 +1,81 @@
---
layout: doc
title: qvm-create
permalink: /doc/tools/3.2/dom0/qvm-create/
redirect_from:
- /doc/dom0-tools/qvm-create/
- /en/doc/dom0-tools/qvm-create/
- /doc/Dom0Tools/QvmCreate/
- /wiki/Dom0Tools/QvmCreate/
---
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
-H, --hvm
Create HVM (standalone, unless --template option used)
--hvm-template
Create HVM template
-R ROOT\_MOVE, --root-move-from=ROOT\_MOVE
Use provided root.img instead of default/empty one (file will be MOVED)
-r ROOT\_COPY, --root-copy-from=ROOT\_COPY
Use provided root.img instead of default/empty one (file will be COPIED)
-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\>

View file

@ -0,0 +1,68 @@
---
layout: doc
title: qvm-firewall
permalink: /doc/tools/3.2/dom0/qvm-firewall/
redirect_from:
- /doc/dom0-tools/qvm-firewall/
- /en/doc/dom0-tools/qvm-firewall/
- /doc/Dom0Tools/QvmFirewall/
- /wiki/Dom0Tools/QvmFirewall/
---
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\>

View file

@ -0,0 +1,39 @@
---
layout: doc
title: qvm-grow-private
permalink: /doc/tools/3.2/dom0/qvm-grow-private/
redirect_from:
- /doc/dom0-tools/qvm-grow-private/
- /en/doc/dom0-tools/qvm-grow-private/
- /doc/Dom0Tools/QvmGrowPrivate/
- /wiki/Dom0Tools/QvmGrowPrivate/
---
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\>

View file

@ -0,0 +1,39 @@
---
layout: doc
title: qvm-kill
permalink: /doc/tools/3.2/dom0/qvm-kill/
redirect_from:
- /doc/dom0-tools/qvm-kill/
- /en/doc/dom0-tools/qvm-kill/
- /doc/Dom0Tools/QvmKill/
- /wiki/Dom0Tools/QvmKill/
---
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\>

View file

@ -0,0 +1,63 @@
---
layout: doc
title: qvm-ls
permalink: /doc/tools/3.2/dom0/qvm-ls/
redirect_from:
- /doc/dom0-tools/qvm-ls/
- /en/doc/dom0-tools/qvm-ls/
- /doc/Dom0Tools/QvmLs/
- /wiki/Dom0Tools/QvmLs/
---
qvm-ls
======
NAME
----
qvm-ls - list VMs and various information about their state
Date
2012-04-03
SYNOPSIS
--------
qvm-ls [options] \<vm-name\>
OPTIONS
-------
-h, --help
Show help message and exit
-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
-k, --kernel
Show VM kernel options
-b, --last-backup
Show date of last VM backup
--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\>

View file

@ -0,0 +1,54 @@
---
layout: doc
title: qvm-pci
permalink: /doc/tools/3.2/dom0/qvm-pci/
redirect_from:
- /doc/dom0-tools/qvm-pci/
- /en/doc/dom0-tools/qvm-pci/
- /doc/Dom0Tools/QvmPci/
- /wiki/Dom0Tools/QvmPci/
---
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
-C, --add-class
Add all devices of given class:
net - network interfaces, usb - USB controllers
-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\>

View file

@ -0,0 +1,158 @@
---
layout: doc
title: qvm-prefs
permalink: /doc/tools/3.2/dom0/qvm-prefs/
redirect_from:
- /doc/dom0-tools/qvm-prefs/
- /en/doc/dom0-tools/qvm-prefs/
- /doc/Dom0Tools/QvmPrefs/
- /wiki/Dom0Tools/QvmPrefs/
---
qvm-prefs
=========
NAME
----
qvm-prefs - list/set various per-VM properties
Date
2012-04-11
SYNOPSIS
--------
qvm-prefs -l [options] \<vm-name\>
qvm-prefs -g [options] \<vm-name\> \<property\>
qvm-prefs -s [options] \<vm-name\> \<property\> [...]
OPTIONS
-------
-h, --help
Show this help message and exit
-l, --list
List properties of a specified VM
-g, --get
Get a single property 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.
pci\_strictreset
Accepted values: `True`, `False`
Control whether prevent assigning to VM a device which does not support any reset method. Generally such devices should not be assigned to any VM, because there will be no way to reset device state after VM shutdown, so the device could attack next VM to which it will be assigned. But in some cases it could make sense - for example when the VM to which it is assigned is trusted one, or is running all the time.
label
Accepted values: `red`, `orange`, `yellow`, `green`, `gray`, `blue`, `purple`, `black`
Color of VM label (icon, appmenus, windows border). If VM is running, change will be applied at first VM restart.
netvm
Accepted values: netvm name, `default`, `none`
To which NetVM connect. Setting to `default` will follow system-global default NetVM (managed by qubes-prefs). Setting to `none` will disable networking in this VM.
dispvm\_netvm
Accepted values: netvm name, `default`, `none`
Which NetVM should be used for Disposable VMs started by this one. `default` is to use the same NetVM as the VM itself.
maxmem
Accepted values: memory size in MB
Maximum memory size available for this VM. Dynamic memory management (aka qmemman) will not be able to balloon over this limit. For VMs with qmemman disabled, this will be overridden by *memory* property (at VM startup).
memory
Accepted values: memory size in MB
Initial memory size for VM. This should be large enough to allow VM startup - before qmemman starts managing memory for this VM. For VM with qmemman disabled, this is static memory size.
kernel
Accepted values: kernel version, `default`, `none`
Kernel version to use (only for PV VMs). Available kernel versions will be listed when no value given (there are in /var/lib/qubes/vm-kernels). Setting to `default` will follow system-global default kernel (managed via qubes-prefs). Setting to `none` will use "kernels" subdir in VM directory - this allows having VM-specific kernel; also this the only case when /lib/modules is writable from within VM.
template
Accepted values: TemplateVM name
TemplateVM on which VM base. It can be changed only when VM isn't running.
vcpus
Accepted values: no of CPUs
Number of CPU (cores) available to VM. Some VM types (eg DispVM) will not work properly with more than one CPU.
kernelopts
Accepted values: string, `default`
VM kernel parameters (available only for PV VMs). This can be used to workaround some hardware specific problems (eg for NetVM). Setting to `default` will use some reasonable defaults (currently different for VMs with PCI devices and without). For VM without PCI devices `default` option means inherit this value from the VM template (if any). Some helpful options (for debugging purposes): `earlyprintk=xen`, `init=/bin/bash`
name
Accepted values: alphanumerical name
Name of the VM. Can be only changed when VM isn't running.
drive
Accepted values: [hd:|cdrom:][backend-vm:]path
Additional drive for the VM (available only for HVMs). This can be used to attach installation image. `path` can be file or physical device (eg. /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 licensing requires a static MAC address. For template-based HVM `auto` mode means to clone template MAC.
default\_user
Accepted values: username
Default user used by 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). For template-based HVM, enabling debug mode also disables automatic reset root.img (actually volatile.img) before each VM startup, so changes made to root filesystem stays intact. To force reset root.img when debug mode enabled, either change something in the template (simple start+stop will do, even touch its root.img is enough), or remove VM's volatile.img (check the path with qvm-prefs).
qrexec\_installed
Accepted values: `True`, `False`
This HVM have qrexec agent installed. When VM have qrexec agent installed, one can use qvm-run to start VM process, VM will benefit from Qubes RPC services (like file copy, or inter-vm clipboard). This option will be automatically turned on during Qubes Windows Tools installation, but if you install qrexec agent in some other OS, you need to turn this option on manually.
guiagent\_installed
Accepted values: `True`, `False`
This HVM have gui agent installed. This option disables full screen GUI virtualization and enables per-window seemless GUI mode. This option will be automatically turned on during Qubes Windows Tools installation, but if you install Qubes gui agent in some other OS, you need to turn this option on manually. You can turn this option off to troubleshoot some early HVM OS boot problems (enter safe mode etc), but the option will be automatically enabled at first VM normal startup (and will take effect from the next startup).
*Notice:* when Windows GUI agent is installed in the VM, SVGA device (used to full screen video) is disabled, so even if you disable this option, you will not get functional full desktop access (on normal VM startup). Use some other means for that (VNC, RDP or so).
autostart
Accepted values: `True`, `False`
Start the VM during system startup. The default netvm is autostarted regardless of this setting.
timezone
Accepted values: `localtime`, time offset in seconds
Set emulated HVM clock timezone. Use `localtime` (the default) to use the same time as dom0 have. Note that HVM will get only clock value, not the timezone itself, so if you use `localtime` setting, OS inside of HVM should also be configured to treat hardware clock as local time (and have proper timezone set).
AUTHORS
-------
Joanna Rutkowska \<joanna at invisiblethingslab dot com\>
Rafal Wojtczuk \<rafal at invisiblethingslab dot com\>
Marek Marczykowski \<marmarek at invisiblethingslab dot com\>

View file

@ -0,0 +1,48 @@
---
layout: doc
title: qvm-remove
permalink: /doc/tools/3.2/dom0/qvm-remove/
redirect_from:
- /doc/dom0-tools/qvm-remove/
- /en/doc/dom0-tools/qvm-remove/
- /doc/Dom0Tools/QvmRemove/
- /wiki/Dom0Tools/QvmRemove/
---
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\>

View file

@ -0,0 +1,42 @@
---
layout: doc
title: qvm-revert-template-changes
permalink: /doc/tools/3.2/dom0/qvm-revert-template-changes/
redirect_from:
- /doc/dom0-tools/qvm-revert-template-changes/
- /en/doc/dom0-tools/qvm-revert-template-changes/
- /doc/Dom0Tools/QvmRevertTemplateChanges/
- /wiki/Dom0Tools/QvmRevertTemplateChanges/
---
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 confirmation
AUTHORS
-------
Joanna Rutkowska \<joanna at invisiblethingslab dot com\>
Rafal Wojtczuk \<rafal at invisiblethingslab dot com\>
Marek Marczykowski \<marmarek at invisiblethingslab dot com\>

View file

@ -0,0 +1,78 @@
---
layout: doc
title: qvm-run
permalink: /doc/tools/3.2/dom0/qvm-run/
redirect_from:
- /doc/dom0-tools/qvm-run/
- /en/doc/dom0-tools/qvm-run/
- /doc/Dom0Tools/QvmRun/
- /wiki/Dom0Tools/QvmRun/
---
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\>

View file

@ -0,0 +1,137 @@
---
layout: doc
title: qvm-service
permalink: /doc/tools/3.2/dom0/qvm-service/
redirect_from:
- /doc/dom0-tools/qvm-service/
- /en/doc/dom0-tools/qvm-service/
- /doc/Dom0Tools/QvmService/
- /wiki/Dom0Tools/QvmService/
---
qvm-service
===========
NAME
----
qvm-service - manage (Qubes-specific) services started 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 knowledge of qubes-core code.
meminfo-writer
Default: enabled everywhere excluding NetVM
This service reports VM memory usage to dom0, which effectively enables dynamic memory management for the VM.
*Note:* this service is enforced to be set by dom0 code. If you try to remove it (reset to default state), will be recreated with the rule: enabled if VM have no PCI devices assigned, otherwise disabled.
qubes-dvm
Default: disabled
Used internally when creating DispVM savefile.
qubes-firewall
Default: enabled only in ProxyVM
Dynamic firewall manager, based on settings in dom0 (qvm-firewall, firewall tab in qubes-manager). This service is not supported in netvms.
qubes-network
Default: enabled only in NetVM and ProxyVM
Expose network for other VMs. This includes enabling network forwarding, MASQUERADE, DNS redirection and basic firewall.
qubes-netwatcher
Default: enabled only in ProxyVM
Monitor IP change notification from NetVM. When received, reload qubes-firewall service (to force DNS resolution). This service makes sense only with qubes-firewall enabled.
qubes-update-check
Default: enabled
Notify dom0 about updates available for this VM. This is shown in qubes-manager as 'update-pending' flag.
cups
Default: enabled only in AppVM
Enable CUPS service. The user can disable cups in VM which do not need printing to speed up booting.
crond
Default: disabled
Enable CRON service. To have cron jobs persist across reboots, /var/spool/cron is bind-mounted from /rw/bind-dirs. To override this see [Bind-Dir Instructions](/doc/bind-dirs/) )
network-manager
Default: enabled in NetVM
Enable NetworkManager. Only VM with direct access to network device needs this service, but can be useful in ProxyVM to ease VPN setup.
ntpd
Default: disabled
Enable NTPD service. By default Qubes calls ntpdate every 6 minutes in selected VM (aka ClockVM), then propagate the result using qrexec calls. Enabling ntpd *do not* disable this behaviour.
qubes-yum-proxy
Deprecated name for qubes-updates-proxy.
qubes-updates-proxy
Default: enabled in NetVM
Provide proxy service, which allow access only to yum repos. Filtering is done based on URLs, so it shouldn't be used as leak control (pretty easy to bypass), but is enough to prevent some erroneous user actions.
yum-proxy-setup
Deprecated name for updates-proxy-setup.
updates-proxy-setup
Default: enabled in AppVM (also in templates)
Setup yum at startup to use qubes-yum-proxy service.
*Note:* this service is automatically enabled when you allow VM to access yum proxy (in firewall settings) and disabled when you deny access to yum proxy.
disable-default-route
Default: disabled
Disables the default route for networking. Enabling this service will prevent the creation of the default route, but the VM will still be able to reach it's direct neighbors. The functionality is implemented in /usr/lib/qubes/setup-ip.
disable-dns-server
Default: disabled
Enabling this service will result in an empty /etc/resolv.conf. The functionality is implemented in /usr/lib/qubes/setup-ip.
AUTHORS
-------
Joanna Rutkowska \<joanna at invisiblethingslab dot com\>
Rafal Wojtczuk \<rafal at invisiblethingslab dot com\>
Marek Marczykowski \<marmarek at invisiblethingslab dot com\>

View file

@ -0,0 +1,54 @@
---
layout: doc
title: qvm-shutdown
permalink: /doc/tools/3.2/dom0/qvm-shutdown/
redirect_from:
- /doc/dom0-tools/qvm-shutdown/
- /en/doc/dom0-tools/qvm-shutdown/
- /doc/Dom0Tools/QvmShutdown/
- /wiki/Dom0Tools/QvmShutdown/
---
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\>

View file

@ -0,0 +1,54 @@
---
layout: doc
title: qvm-start
permalink: /doc/tools/3.2/dom0/qvm-start/
redirect_from:
- /doc/dom0-tools/qvm-start/
- /en/doc/dom0-tools/qvm-start/
- /doc/Dom0Tools/QvmStart/
- /wiki/Dom0Tools/QvmStart/
---
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\>

View file

@ -0,0 +1,42 @@
---
layout: doc
title: qvm-sync-appmenus
permalink: /doc/tools/3.2/dom0/qvm-sync-appmenus/
redirect_from:
- /doc/dom0-tools/qvm-sync-appmenus/
- /en/doc/dom0-tools/qvm-sync-appmenus/
- /doc/Dom0Tools/QvmSyncAppmenus/
- /wiki/Dom0Tools/QvmSyncAppmenus/
---
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\>

View file

@ -0,0 +1,39 @@
---
layout: doc
title: qvm-template-commit
permalink: /doc/tools/3.2/dom0/qvm-template-commit/
redirect_from:
- /doc/dom0-tools/qvm-template-commit/
- /en/doc/dom0-tools/qvm-template-commit/
- /doc/Dom0Tools/QvmTemplateCommit/
- /wiki/Dom0Tools/QvmTemplateCommit/
---
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\>

View file

@ -0,0 +1,19 @@
---
layout: doc
title: DomU Command-Line Tools for Qubes 3.2
permalink: /doc/tools/3.2/domU/
redirect_from:
- /doc/tools/3.2/domU/
- /en/doc/tools/3.2/domU/
- /doc/VmTools/
- /wiki/VmTools/
---
DomU Command-Line Tools for Qubes 3.2
=====================================
* [qvm-copy-to-vm](/doc/tools/3.2/domU/qvm-copy-to-vm/)
* [qvm-open-in-dvm](/doc/tools/3.2/domU/qvm-open-in-dvm/)
* [qvm-open-in-vm](/doc/tools/3.2/domU/qvm-open-in-vm/)
* [qvm-run](/doc/tools/3.2/domU/qvm-run/)

View file

@ -0,0 +1,39 @@
---
layout: doc
title: qvm-copy-to-vm
permalink: /doc/tools/3.2/domU/qvm-copy-to-vm/
redirect_from:
- /doc/vm-tools/qvm-copy-to-vm/
- /en/doc/vm-tools/qvm-copy-to-vm/
- /doc/VmTools/QvmCopyToVm/
- /wiki/VmTools/QvmCopyToVm/
---
qvm-copy-to-vm
==============
NAME
----
qvm-copy-to-vm - copy specified files to specified destination VM
Date
2012-05-30
SYNOPSIS
--------
qvm-copy-to-vm [--without-progress] dest\_vmname file [file]+
OPTIONS
-------
--without-progress
Don't display progress info
AUTHORS
-------
Joanna Rutkowska \<joanna at invisiblethingslab dot com\>
Rafal Wojtczuk \<rafal at invisiblethingslab dot com\>
Marek Marczykowski \<marmarek at invisiblethingslab dot com\>

View file

@ -0,0 +1,36 @@
---
layout: doc
title: qvm-open-in-dvm
permalink: /doc/tools/3.2/domU/qvm-open-in-dvm/
redirect_from:
- /doc/vm-tools/qvm-open-in-dvm/
- /en/doc/vm-tools/qvm-open-in-dvm/
- /doc/VmTools/QvmOpenInDvm/
- /wiki/VmTools/QvmOpenInDvm/
---
qvm-open-in-dvm
===============
NAME
----
qvm-open-in-dvm - open a specified file in disposable VM
Date
2012-05-30
SYNOPSIS
--------
qvm-open-in-dvm filename
OPTIONS
-------
AUTHORS
-------
Joanna Rutkowska \<joanna at invisiblethingslab dot com\>
Rafal Wojtczuk \<rafal at invisiblethingslab dot com\>
Marek Marczykowski \<marmarek at invisiblethingslab dot com\>

View file

@ -0,0 +1,36 @@
---
layout: doc
title: qvm-open-in-vm
permalink: /doc/tools/3.2/domU/qvm-open-in-vm/
redirect_from:
- /doc/vm-tools/qvm-open-in-vm/
- /en/doc/vm-tools/qvm-open-in-vm/
- /doc/VmTools/QvmOpenInVm/
- /wiki/VmTools/QvmOpenInVm/
---
qvm-open-in-vm
==============
NAME
----
qvm-open-in-vm - open a specified file in other VM
Date
2012-05-30
SYNOPSIS
--------
qvm-open-in-vm vmname filename
OPTIONS
-------
AUTHORS
-------
Joanna Rutkowska \<joanna at invisiblethingslab dot com\>
Rafal Wojtczuk \<rafal at invisiblethingslab dot com\>
Marek Marczykowski \<marmarek at invisiblethingslab dot com\>

View file

@ -0,0 +1,39 @@
---
layout: doc
title: qvm-run
permalink: /doc/tools/3.2/domU/qvm-run/
redirect_from:
- /doc/vm-tools/qvm-run/
- /en/doc/vm-tools/qvm-run/
- /doc/VmTools/QvmRun/
- /wiki/VmTools/QvmRun/
---
qvm-run
=======
NAME
----
qvm-run - run a specified command in a specified VM
Date
2012-05-30
SYNOPSIS
--------
qvm-run vmname command [arguments]
OPTIONS
-------
--dispvm
Pass this option instead of vmname to start new DisposableVM
AUTHORS
-------
Joanna Rutkowska \<joanna at invisiblethingslab dot com\>
Rafal Wojtczuk \<rafal at invisiblethingslab dot com\>
Marek Marczykowski \<marmarek at invisiblethingslab dot com\>

View file

@ -0,0 +1,14 @@
---
layout: doc
title: Dom0 Command-Line Tools for Qubes 4.0
permalink: /doc/tools/4.0/dom0/
---
Dom0 Command-Line Tools for Qubes 4.0
=====================================
Reference pages for these tools are being written.
This page will be updated when they're available.
Tracking issue: <https://github.com/QubesOS/qubes-issues/issues/3538>

View file

@ -0,0 +1,14 @@
---
layout: doc
title: DomU Command-Line Tools for Qubes 4.0
permalink: /doc/tools/4.0/domU/
---
DomU Command-Line Tools for Qubes 4.0
=====================================
Reference pages for these tools are being written.
This page will be updated when they're available.
Tracking issue: <https://github.com/QubesOS/qubes-issues/issues/3538>

View file

@ -0,0 +1,13 @@
---
layout: doc
title: Qubes 3.2 Command-Line Tools
permalink: /doc/tools/3.2/
---
Qubes 3.2 Command-Line Tools
============================
Please see the page for your desired domain:
* [Dom0 Command-Line Tools](/doc/tools/3.2/dom0/)
* [DomU Command-Line Tools](/doc/tools/3.2/domU/)

View file

@ -0,0 +1,13 @@
---
layout: doc
title: Qubes 4.0 Command-Line Tools
permalink: /doc/tools/4.0/
---
Qubes 4.0 Command-Line Tools
============================
Please see the page for your desired domain:
* [Dom0 Command-Line Tools](/doc/tools/4.0/dom0/)
* [DomU Command-Line Tools](/doc/tools/4.0/domU/)