doc: manpage formatting
This commit is contained in:
Wojtek Porczyk
parent
6146c8e466
commit
2835238a87
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qubes-guid -d domain_id [-c color] [-l label_index] [-i icon name, no suffix] [-v] [-q]
|
||||
:command:`qubes-guid` -d *domain_id* [-c *color*] [-l *label_index*] [-i *icon name*, no suffix] [-v] [-q]
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -13,7 +13,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qubes-prefs
|
||||
:command:`qubes-prefs`
|
||||
|
||||
Authors
|
||||
=======
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-add-appvm [options] <appvm-name> <vm-template-name>
|
||||
:command:`qvm-add-appvm` [*options*] <*appvm-name*> <*vm-template-name*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-add-template [options] <vm-template-name>
|
||||
:command:`qvm-add-template` [*options*] <*vm-template-name*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-backup-restore [options] <backup-dir>
|
||||
:command:`qvm-backup-restore` [*options*] <*backup-dir*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-backup [options] <backup-dir-path>
|
||||
:command:`qvm-backup` [*options*] <*backup-dir-path*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,10 +6,10 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-block -l [options]
|
||||
| qvm-block -a [options] <device> <vm-name>
|
||||
| qvm-block -d [options] <device>
|
||||
| qvm-block -d [options] <vm-name>
|
||||
| :command:`qvm-block` [*options*] -l
|
||||
| :command:`qvm-block` [*options*] -a <*device*> <*vm-name*>
|
||||
| :command:`qvm-block` [*options*] -d <*device*>
|
||||
| :command:`qvm-block` [*options*] -d <*vm-name*>
|
||||
|
||||
|
||||
Options
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-clone-template [options] <src-template-name> <new-template-name>
|
||||
:command:`qvm-clone-template` [*options*] <*src-template-name*> <*new-template-name*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-clone [options] <src-name> <new-name>
|
||||
:command:`qvm-clone` [*options*] <*src-name*> <*new-name*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-create-default-dvm templatename|--default-template|--used-template [script-name|--default-script]
|
||||
| :command:`qvm-create-default-dvm` templatename|--default-template|--used-template [script-name|--default-script]
|
||||
|
||||
OPTIONS
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-create [options] <vm-name>
|
||||
:command:`qvm-create` [*options*] <*vm-name*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,12 +6,12 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-firewall [-n] <vm-name> [action] [rule spec]
|
||||
:command:`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
|
||||
1. *address*\ |\ *hostname*\ [/*netmask*] tcp|udp *port*\ [-*port*]
|
||||
2. *address*\ |\ *hostname*\ [/*netmask*] tcp|udp *service_name*
|
||||
3. *address*\ |\ *hostname*\ [/*netmask*] any
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-grow-private <vm-name> <size>
|
||||
:command:`qvm-grow-private` <*vm-name*> <*size*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-kill [options] <vm-name>
|
||||
:command:`qvm-kill` [*options*] <*vm-name*>
|
||||
|
||||
|
||||
Options
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-ls [options] <vm-name>
|
||||
:command:`qvm-ls` [*options*] <*vm-name*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,9 +6,9 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-pci -l [options] <vm-name>
|
||||
| qvm-pci -a [options] <vm-name> <device>
|
||||
| qvm-pci -d [options] <vm-name> <device>
|
||||
| :command:`qvm-pci` [*options*] -l <*vm-name*>
|
||||
| :command:`qvm-pci` [*options*] -a <*vm-name*> <*device*>
|
||||
| :command:`qvm-pci` [*options*] -d <*vm-name*> <*device*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,9 +6,9 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-prefs -l [options] <vm-name>
|
||||
| qvm-prefs -g [options] <vm-name> <property>
|
||||
| qvm-prefs -s [options] <vm-name> <property> [...]
|
||||
| :command:`qvm-prefs` [*options*] -l <*vm-name*>
|
||||
| :command:`qvm-prefs` [*options*] -g <*vm-name*> <*property*>
|
||||
| :command:`qvm-prefs` [*options*] -s <*vm-name*> <*property*> [*...*]
|
||||
|
||||
|
||||
Options
|
||||
@ -36,10 +36,13 @@ 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.
|
||||
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 devices assigned to the VM. Should be edited using
|
||||
:manpage:`qvm-pci(1)` tool.
|
||||
|
||||
pci_strictreset
|
||||
Accepted values: ``True``, ``False``
|
||||
@ -52,14 +55,24 @@ pci_strictreset
|
||||
is trusted one, or is running all the time.
|
||||
|
||||
label
|
||||
Accepted values: ``red``, ``orange``, ``yellow``, ``green``, ``gray``, ``blue``, ``purple``, ``black``
|
||||
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.
|
||||
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.
|
||||
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.
|
||||
|
||||
.. note::
|
||||
|
||||
When setting to ``none``, firewall will be set to block all traffic -
|
||||
it will be used by DispVM started from this VM. Setting back to some
|
||||
NetVM will *NOT* restore previous firewall settings.
|
||||
|
||||
dispvm_netvm
|
||||
Accepted values: netvm name, ``default``, ``none``
|
||||
@ -69,17 +82,27 @@ dispvm_netvm
|
||||
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).
|
||||
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.
|
||||
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.
|
||||
Kernel version to use (only for PV VMs). Available kernel versions will be
|
||||
listed when no value given (there are in
|
||||
:file:`/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 :file:`/lib/modules` is writable from
|
||||
within VM.
|
||||
|
||||
template
|
||||
Accepted values: TemplateVM name
|
||||
@ -89,12 +112,17 @@ template
|
||||
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.
|
||||
Number of CPU (cores) available to VM. Some VM types (eg DispVM) will not
|
||||
work properly with more than one CPU.
|
||||
|
||||
kernelopts
|
||||
Accepted values: string, ``default``
|
||||
|
||||
VM kernel parameters (available only for PV VMs). This can be used to workaround some hardware specific problems (eg for NetVM). Setting to ``default`` will use some reasonable defaults (currently different for VMs with PCI devices and without). Some helpful options (for debugging purposes): ``earlyprintk=xen``, ``init=/bin/bash``
|
||||
VM kernel parameters (available only for PV VMs). This can be used to
|
||||
workaround some hardware specific problems (eg for NetVM). Setting to
|
||||
``default`` will use some reasonable defaults (currently different for VMs
|
||||
with PCI devices and without). Some helpful options (for debugging
|
||||
purposes): ``earlyprintk=xen``, ``init=/bin/bash``
|
||||
|
||||
name
|
||||
Accepted values: alphanumerical name
|
||||
@ -102,48 +130,86 @@ name
|
||||
Name of the VM. Can be only changed when VM isn't running.
|
||||
|
||||
drive
|
||||
Accepted values: [hd:\|cdrom:][backend-vm:]path
|
||||
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.
|
||||
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.
|
||||
:file:`/dev/sr0`). The same syntax can be used in :option:`qvm-start
|
||||
--drive` - to attach drive only temporarily.
|
||||
|
||||
mac
|
||||
Accepted values: MAC address, ``auto``
|
||||
|
||||
Can be used to force specific of virtual ethernet card in the VM. Setting to ``auto`` will use automatic-generated MAC - based on VM id. Especially useful when some licencing depending on static MAC address.
|
||||
Can be used to force specific of virtual ethernet card in the VM. Setting
|
||||
to ``auto`` will use automatic-generated MAC - based on VM id. Especially
|
||||
useful when some licencing depending on static MAC address.
|
||||
|
||||
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.
|
||||
Default user used by :manpage:`qvm-run(1)`. 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).
|
||||
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
|
||||
:file:`root.img` (actually :file:`volatile.img`) before each VM startup, so
|
||||
changes made to root filesystem stays intact. To force reset
|
||||
:file:`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 :file:`volatile.img` (check the path with
|
||||
:manpage:`qvm-prefs(1)`).
|
||||
|
||||
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.
|
||||
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).
|
||||
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).
|
||||
.. note::
|
||||
|
||||
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.
|
||||
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).
|
||||
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
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-remove [options] <vm-name>
|
||||
:command:`qvm-remove` [*options*] <*vm-name*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-revert-template-changes [options] <template-name>
|
||||
:command:`qvm-revert-template-changes` [*options*] <*template-name*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-run [options] [<vm-name>] [<cmd>]
|
||||
:command:`qvm-run` [*options*] [<*vm-name*>] [<*cmd*>]
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -4,16 +4,10 @@
|
||||
:program:`qvm-service` -- Manage (Qubes-specific) services started in VM
|
||||
========================================================================
|
||||
|
||||
NAME
|
||||
====
|
||||
qvm-service -
|
||||
|
||||
:Date: 2012-05-30
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-service [-l] <vmname>
|
||||
| qvm-service [-e|-d|-D] <vmname> <service>
|
||||
| :command:`qvm-service` [-l] <*vmname*>
|
||||
| :command:`qvm-service` [-e|-d|-D] <*vmname*> <*service*>
|
||||
|
||||
Options
|
||||
=======
|
||||
@ -41,16 +35,20 @@ Options
|
||||
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.
|
||||
|
||||
meminfo-writer
|
||||
Default: enabled everywhere excluding NetVM
|
||||
|
||||
This service reports VM memory usage to dom0, which effectively enables dynamic memory management for the VM.
|
||||
This service reports VM memory usage to dom0, which effectively enables
|
||||
dynamic memory management for the VM.
|
||||
|
||||
*Note:* this service is enforced to be set by dom0 code. If you try to
|
||||
remove it (reset to defult state), will be recreated with the rule: enabled
|
||||
if VM have no PCI devices assigned, otherwise disabled.
|
||||
.. note::
|
||||
|
||||
This service is enforced to be set by dom0 code. If you try to
|
||||
remove it (reset to defult state), will be recreated with the rule: enabled
|
||||
if VM have no PCI devices assigned, otherwise disabled.
|
||||
|
||||
qubes-dvm
|
||||
Default: disabled
|
||||
@ -68,21 +66,31 @@ qubes-network
|
||||
|
||||
Expose network for other VMs. This includes enabling network forwarding, MASQUERADE, DNS redirection and basic firewall.
|
||||
|
||||
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).
|
||||
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.
|
||||
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.
|
||||
Enable CUPS service. The user can disable cups in VM which do not need
|
||||
printing to speed up booting.
|
||||
|
||||
cron
|
||||
Default: disabled
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-shutdown [options] <vm-name>
|
||||
:command:`qvm-shutdown` [*options*] <*vm-name*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-start [options] <vm-name>
|
||||
:command:`qvm-start` [*options*] <*vm-name*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
Synopsis
|
||||
========
|
||||
| qvm-template-commit [options] <vm-name>
|
||||
:command:`qvm-template-commit` [*options*] <*vm-name*>
|
||||
|
||||
Options
|
||||
=======
|
||||
|
||||
Loading…
Reference in New Issue
Block a user