Some versions of the rst2man convertor are buggy failing to cope with syntax highlighting in code blocks. This isn't something we really need for the man page code blocks, so we can just delete the highlighting directive. Signed-off-by: Daniel P. Berrangé <berrange(a)redhat.com&gt; --- docs/manpages/libvirtd.rst | 4 +- docs/manpages/virsh.rst | 576 ++++++++++++++--------------- docs/manpages/virt-admin.rst | 50 +-- docs/manpages/virt-login-shell.rst | 2 +- docs/manpages/virtlockd.rst | 4 +- docs/manpages/virtlogd.rst | 4 +- 6 files changed, 320 insertions(+), 320 deletions(-) diff --git a/docs/manpages/libvirtd.rst b/docs/manpages/libvirtd.rst index b7489a57fc..4125604f9a 100644 --- a/docs/manpages/libvirtd.rst +++ b/docs/manpages/libvirtd.rst @@ -199,7 +199,7 @@ EXAMPLES To retrieve the version of libvirtd: -.. code-block:: shell +.. code-block:: # libvirtd --version libvirtd (libvirt) 0.8.2 @@ -207,7 +207,7 @@ To retrieve the version of libvirtd: To start libvirtd, instructing it to daemonize and create a PID file: -.. code-block:: shell +.. code-block:: # libvirtd -d # ls -la RUNSTATEDIR/libvirtd.pid diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst index e9d6deaee1..e063b76641 100644 --- a/docs/manpages/virsh.rst +++ b/docs/manpages/virsh.rst @@ -38,7 +38,7 @@ KVM, LXC, OpenVZ, VirtualBox and VMware ESX. The basic structure of most virsh usage is: -.. code-block:: shell +.. code-block:: virsh [OPTION]... <command> <domain> [ARG]... @@ -214,7 +214,7 @@ help **Syntax:** -.. code-block:: shell +.. code-block:: help [command-or-group] @@ -228,7 +228,7 @@ group as an option. For example: **Example 1:** -.. code-block:: shell +.. code-block:: virsh # help host @@ -250,7 +250,7 @@ option instead. For example: **Example 2:** -.. code-block:: shell +.. code-block:: virsh # help list NAME @@ -272,7 +272,7 @@ quit, exit **Syntax:** -.. code-block:: shell +.. code-block:: quit exit @@ -286,7 +286,7 @@ version **Syntax:** -.. code-block:: shell +.. code-block:: version [--daemon] @@ -296,7 +296,7 @@ is included in the output. **Example:** -.. code-block:: shell +.. code-block:: $ virsh version Compiled against library: libvirt 1.2.3 @@ -317,7 +317,7 @@ cd **Syntax:** -.. code-block:: shell +.. code-block:: cd [directory] @@ -334,7 +334,7 @@ pwd **Syntax:** -.. code-block:: shell +.. code-block:: pwd @@ -347,7 +347,7 @@ connect **Syntax:** -.. code-block:: shell +.. code-block:: connect [URI] [--readonly] @@ -388,7 +388,7 @@ uri **Syntax:** -.. code-block:: shell +.. code-block:: uri @@ -400,7 +400,7 @@ hostname **Syntax:** -.. code-block:: shell +.. code-block:: hostname @@ -412,7 +412,7 @@ sysinfo **Syntax:** -.. code-block:: shell +.. code-block:: sysinfo @@ -424,7 +424,7 @@ nodeinfo **Syntax:** -.. code-block:: shell +.. code-block:: nodeinfo @@ -440,7 +440,7 @@ nodecpumap **Syntax:** -.. code-block:: shell +.. code-block:: nodecpumap [--pretty] @@ -456,7 +456,7 @@ nodecpustats **Syntax:** -.. code-block:: shell +.. code-block:: nodecpustats [cpu] [--percent] @@ -471,7 +471,7 @@ nodememstats **Syntax:** -.. code-block:: shell +.. code-block:: nodememstats [cell] @@ -484,7 +484,7 @@ nodesuspend **Syntax:** -.. code-block:: shell +.. code-block:: nodesuspend [target] [duration] @@ -503,7 +503,7 @@ node **Syntax:** -.. code-block:: shell +.. code-block:: node-memory-tune [shm-pages-to-scan] [shm-sleep-millisecs] [shm-merge-across-nodes] @@ -525,7 +525,7 @@ capabilities **Syntax:** -.. code-block:: shell +.. code-block:: capabilities @@ -545,7 +545,7 @@ domcapabilities **Syntax:** -.. code-block:: shell +.. code-block:: domcapabilities [virttype] [emulatorbin] [arch] [machine] @@ -588,7 +588,7 @@ pool-capabilities **Syntax:** -.. code-block:: shell +.. code-block:: pool-capabilities @@ -605,7 +605,7 @@ inject **Syntax:** -.. code-block:: shell +.. code-block:: inject-nmi domain @@ -617,7 +617,7 @@ list **Syntax:** -.. code-block:: shell +.. code-block:: list [--inactive | --all] [--managed-save] [--title] @@ -637,7 +637,7 @@ specified it prints out information about running domains. An example format for the list is as follows: -.. code-block:: shell +.. code-block:: ``virsh`` list Id Name State @@ -775,7 +775,7 @@ printed in an extra column. This flag is usable only with the default **Example 2:** -.. code-block:: shell +.. code-block:: $ virsh list --title Id Name State Title @@ -790,7 +790,7 @@ freecell **Syntax:** -.. code-block:: shell +.. code-block:: freecell [{ [--cellno] cellno | --all }] @@ -809,7 +809,7 @@ freepages **Syntax:** -.. code-block:: shell +.. code-block:: freepages [{ [--cellno] cellno [--pagesize] pagesize | --all }] @@ -824,7 +824,7 @@ allocpages **Syntax:** -.. code-block:: shell +.. code-block:: allocpages [--pagesize] pagesize [--pagecount] pagecount [[--cellno] cellno] [--add] [--all] @@ -843,7 +843,7 @@ cpu-baseline **Syntax:** -.. code-block:: shell +.. code-block:: cpu-baseline FILE [--features] [--migratable] @@ -864,7 +864,7 @@ cpu-compare **Syntax:** -.. code-block:: shell +.. code-block:: cpu-compare FILE [--error] @@ -890,7 +890,7 @@ cpu-models **Syntax:** -.. code-block:: shell +.. code-block:: cpu-models arch @@ -909,7 +909,7 @@ echo **Syntax:** -.. code-block:: shell +.. code-block:: echo [--shell] [--xml] [err...] [arg...] @@ -926,7 +926,7 @@ hypervisor-cpu-compare **Syntax:** -.. code-block:: shell +.. code-block:: hypervisor-cpu-compare FILE [virttype] [emulator] [arch] [machine] [--error] @@ -958,7 +958,7 @@ hypervisor-cpu-baseline **Syntax:** -.. code-block:: shell +.. code-block:: hypervisor-cpu-baseline FILE [virttype] [emulator] [arch] [machine] [--features] [--migratable] @@ -1005,7 +1005,7 @@ autostart **Syntax:** -.. code-block:: shell +.. code-block:: autostart [--disable] domain @@ -1020,7 +1020,7 @@ blkdeviotune **Syntax:** -.. code-block:: shell +.. code-block:: blkdeviotune domain device [[--config] [--live] | [--current]] [[total-bytes-sec] | [read-bytes-sec] [write-bytes-sec]] @@ -1102,7 +1102,7 @@ blkiotune **Syntax:** -.. code-block:: shell +.. code-block:: blkiotune domain [--weight weight] [--device-weights device-weights] [--device-read-iops-sec device-read-iops-sec] @@ -1163,7 +1163,7 @@ blockcommit **Syntax:** -.. code-block:: shell +.. code-block:: blockcommit domain path [bandwidth] [--bytes] [base] [--shallow] [top] [--delete] [--keep-relative] @@ -1221,7 +1221,7 @@ blockcopy **Syntax:** -.. code-block:: shell +.. code-block:: blockcopy domain path { dest [format] [--blockdev] | --xml file } [--shallow] [--reuse-external] [bandwidth] @@ -1293,7 +1293,7 @@ blockjob **Syntax:** -.. code-block:: shell +.. code-block:: blockjob domain path { [--abort] [--async] [--pivot] | [--info] [--raw] [--bytes] | [bandwidth] } @@ -1343,7 +1343,7 @@ blockpull **Syntax:** -.. code-block:: shell +.. code-block:: blockpull domain path [bandwidth] [--bytes] [base] [--wait [--verbose] [--timeout seconds] [--async]] @@ -1384,7 +1384,7 @@ blockresize **Syntax:** -.. code-block:: shell +.. code-block:: blockresize domain path size @@ -1405,7 +1405,7 @@ console **Syntax:** -.. code-block:: shell +.. code-block:: console domain [devname] [--safe] [--force] @@ -1426,7 +1426,7 @@ cpu-stats **Syntax:** -.. code-block:: shell +.. code-block:: cpu-stats domain [--total] [start] [count] @@ -1442,7 +1442,7 @@ create **Syntax:** -.. code-block:: shell +.. code-block:: create FILE [--console] [--paused] [--autodestroy] [--pass-fds N,M,...] [--validate] @@ -1473,7 +1473,7 @@ is only supported with container based virtualization. #. prepare a template from an existing domain (skip directly to 3a if writing one from scratch) - .. code-block:: shell + .. code-block:: # virsh dumpxml <domain> > domain.xml @@ -1482,7 +1482,7 @@ is only supported with container based virtualization. a. DO CHANGE! <name> and <uuid> (<uuid> can also be removed), or b. DON'T CHANGE! either <name> or <uuid> - .. code-block:: shell + .. code-block:: # $EDITOR domain.xml @@ -1493,7 +1493,7 @@ is only supported with container based virtualization. b. an existing persistent domain will run with a modified one-time configuration - .. code-block:: shell + .. code-block:: # virsh create domain.xml @@ -1503,7 +1503,7 @@ define **Syntax:** -.. code-block:: shell +.. code-block:: define FILE [--validate] @@ -1519,7 +1519,7 @@ desc **Syntax:** -.. code-block:: shell +.. code-block:: desc domain [[--live] [--config] | [--current]] [--title] [--edit] [--new-desc @@ -1551,7 +1551,7 @@ destroy **Syntax:** -.. code-block:: shell +.. code-block:: destroy domain [--graceful] @@ -1579,7 +1579,7 @@ domblkerror **Syntax:** -.. code-block:: shell +.. code-block:: domblkerror domain @@ -1595,7 +1595,7 @@ domblkinfo **Syntax:** -.. code-block:: shell +.. code-block:: domblkinfo domain [block-device --all] [--human] @@ -1615,7 +1615,7 @@ domblklist **Syntax:** -.. code-block:: shell +.. code-block:: domblklist domain [--inactive] [--details] @@ -1635,7 +1635,7 @@ domblkstat **Syntax:** -.. code-block:: shell +.. code-block:: domblkstat domain [block-device] [--human] @@ -1672,7 +1672,7 @@ domblkthreshold **Syntax:** -.. code-block:: shell +.. code-block:: domblkthreshold domain dev threshold @@ -1687,7 +1687,7 @@ domcontrol **Syntax:** -.. code-block:: shell +.. code-block:: domcontrol domain @@ -1701,7 +1701,7 @@ domdisplay **Syntax:** -.. code-block:: shell +.. code-block:: domdisplay domain [--include-password] [[--type] type] [--all] @@ -1718,7 +1718,7 @@ domfsfreeze **Syntax:** -.. code-block:: shell +.. code-block:: domfsfreeze domain [[--mountpoint] mountpoint...] @@ -1740,7 +1740,7 @@ domfsinfo **Syntax:** -.. code-block:: shell +.. code-block:: domfsinfo domain @@ -1757,7 +1757,7 @@ domfsthaw **Syntax:** -.. code-block:: shell +.. code-block:: domfsthaw domain [[--mountpoint] mountpoint...] @@ -1774,7 +1774,7 @@ domfstrim **Syntax:** -.. code-block:: shell +.. code-block:: domfstrim domain [--minimum bytes] [--mountpoint mountPoint] @@ -1795,7 +1795,7 @@ domhostname **Syntax:** -.. code-block:: shell +.. code-block:: domhostname domain @@ -1807,7 +1807,7 @@ domid **Syntax:** -.. code-block:: shell +.. code-block:: domid domain-name-or-uuid @@ -1819,7 +1819,7 @@ domif **Syntax:** -.. code-block:: shell +.. code-block:: domif-getlink domain interface-device [--config] @@ -1835,7 +1835,7 @@ domif **Syntax:** -.. code-block:: shell +.. code-block:: domif-setlink domain interface-device state [--config] @@ -1851,7 +1851,7 @@ domifaddr **Syntax:** -.. code-block:: shell +.. code-block:: domifaddr domain [interface] [--full] [--source lease|agent|arp] @@ -1878,7 +1878,7 @@ backup-begin **Syntax:** -.. code-block:: shell +.. code-block:: backup-begin domain [backupxml] [checkpointxml] [--reuse-external] @@ -1912,7 +1912,7 @@ backup-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: backup-dumpxml domain @@ -1924,7 +1924,7 @@ domiflist **Syntax:** -.. code-block:: shell +.. code-block:: domiflist domain [--inactive] @@ -1941,7 +1941,7 @@ domifstat **Syntax:** -.. code-block:: shell +.. code-block:: domifstat domain interface-device @@ -1958,7 +1958,7 @@ domiftune **Syntax:** -.. code-block:: shell +.. code-block:: domiftune domain interface-device [[--config] [--live] | [--current]] [*--inbound average,peak,burst,floor*] @@ -1992,7 +1992,7 @@ dominfo **Syntax:** -.. code-block:: shell +.. code-block:: dominfo domain @@ -2004,7 +2004,7 @@ domjobabort **Syntax:** -.. code-block:: shell +.. code-block:: domjobabort domain @@ -2016,7 +2016,7 @@ domjobinfo **Syntax:** -.. code-block:: shell +.. code-block:: domjobinfo domain [--completed [--keep-completed]] [--anystats] [--rawstats] @@ -2043,7 +2043,7 @@ dommemstat **Syntax:** -.. code-block:: shell +.. code-block:: dommemstat domain [--period seconds] [[--config] [--live] | [--current]] @@ -2096,7 +2096,7 @@ domname **Syntax:** -.. code-block:: shell +.. code-block:: domname domain-id-or-uuid @@ -2108,7 +2108,7 @@ dompmsuspend **Syntax:** -.. code-block:: shell +.. code-block:: dompmsuspend domain target [--duration] @@ -2139,7 +2139,7 @@ dompmwakeup **Syntax:** -.. code-block:: shell +.. code-block:: dompmwakeup domain @@ -2154,7 +2154,7 @@ domrename **Syntax:** -.. code-block:: shell +.. code-block:: domrename domain new-name @@ -2169,7 +2169,7 @@ domstate **Syntax:** -.. code-block:: shell +.. code-block:: domstate domain [--reason] @@ -2182,7 +2182,7 @@ domstats **Syntax:** -.. code-block:: shell +.. code-block:: domstats [--raw] [--enforce] [--backing] [--nowait] [--state] [--cpu-total] [--balloon] [--vcpu] [--interface] @@ -2389,7 +2389,7 @@ domtime **Syntax:** -.. code-block:: shell +.. code-block:: domtime domain { [--now] [--pretty] [--sync] [--time time] } @@ -2414,7 +2414,7 @@ domuuid **Syntax:** -.. code-block:: shell +.. code-block:: domuuid domain-name-or-id @@ -2426,7 +2426,7 @@ domxml **Syntax:** -.. code-block:: shell +.. code-block:: domxml-from-native format config @@ -2444,7 +2444,7 @@ domxml **Syntax:** -.. code-block:: shell +.. code-block:: domxml-to-native format { [--xml] xml | --domain domain-name-or-id-or-uuid } @@ -2459,7 +2459,7 @@ dump **Syntax:** -.. code-block:: shell +.. code-block:: dump domain corefilepath [--bypass-cache] { [--live] | [--crash] | [--reset] } @@ -2501,7 +2501,7 @@ dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: dumpxml domain [--inactive] [--security-info] [--update-cpu] [--migratable] @@ -2522,7 +2522,7 @@ edit **Syntax:** -.. code-block:: shell +.. code-block:: edit domain @@ -2531,7 +2531,7 @@ next boot of the guest. This is equivalent to: -.. code-block:: shell +.. code-block:: virsh dumpxml --inactive --security-info domain > domain.xml vi domain.xml (or make changes with your other text editor) @@ -2548,7 +2548,7 @@ emulatorpin **Syntax:** -.. code-block:: shell +.. code-block:: emulatorpin domain [cpulist] [[--live] [--config] | [--current]] @@ -2570,7 +2570,7 @@ event **Syntax:** -.. code-block:: shell +.. code-block:: event {[domain] { event | --all } [--loop] [--timeout seconds] [--timestamp] | --list} @@ -2597,7 +2597,7 @@ guest **Syntax:** -.. code-block:: shell +.. code-block:: guest-agent-timeout domain --timeout value @@ -2616,7 +2616,7 @@ guestinfo **Syntax:** -.. code-block:: shell +.. code-block:: guestinfo domain [--user] [--os] [--timezone] [--hostname] [--filesystem] @@ -2692,7 +2692,7 @@ guestvcpus **Syntax:** -.. code-block:: shell +.. code-block:: guestvcpus domain [[--enable] | [--disable]] [cpulist] @@ -2711,7 +2711,7 @@ iothreadadd **Syntax:** -.. code-block:: shell +.. code-block:: iothreadadd domain iothread_id [[--config] [--live] | [--current]] @@ -2731,7 +2731,7 @@ iothreaddel **Syntax:** -.. code-block:: shell +.. code-block:: iothreaddel domain iothread_id [[--config] [--live] | [--current]] @@ -2752,7 +2752,7 @@ iothreadinfo **Syntax:** -.. code-block:: shell +.. code-block:: iothreadinfo domain [[--live] [--config] | [--current]] @@ -2772,7 +2772,7 @@ iothreadpin **Syntax:** -.. code-block:: shell +.. code-block:: iothreadpin domain iothread cpulist [[--live] [--config] | [--current]] @@ -2805,7 +2805,7 @@ iothreadset **Syntax:** -.. code-block:: shell +.. code-block:: iothreadset domain iothread_id [[--poll-max-ns ns] [--poll-grow factor] [--poll-shrink divisor]] @@ -2836,7 +2836,7 @@ managedsave **Syntax:** -.. code-block:: shell +.. code-block:: managedsave domain [--bypass-cache] [{--running | --paused}] [--verbose] @@ -2865,7 +2865,7 @@ managedsave-define **Syntax:** -.. code-block:: shell +.. code-block:: managedsave-define domain xml [{--running | --paused}] @@ -2885,7 +2885,7 @@ managedsave-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: managedsave-dumpxml domain [--security-info] @@ -2899,7 +2899,7 @@ managedsave-edit **Syntax:** -.. code-block:: shell +.. code-block:: managedsave-edit domain [{--running | --paused}] @@ -2913,7 +2913,7 @@ will allow overriding which state the ``restore`` should use. This is equivalent to: -.. code-block:: shell +.. code-block:: virsh managedsave-dumpxml domain-name > state-file.xml vi state-file.xml (or make changes with your other text editor) @@ -2930,7 +2930,7 @@ managedsave-remove **Syntax:** -.. code-block:: shell +.. code-block:: managedsave-remove domain @@ -2943,7 +2943,7 @@ maxvcpus **Syntax:** -.. code-block:: shell +.. code-block:: maxvcpus [type] @@ -2957,7 +2957,7 @@ memtune **Syntax:** -.. code-block:: shell +.. code-block:: memtune domain [--hard-limit size] [--soft-limit size] [--swap-hard-limit size] [--min-guarantee size] [[--config] [--live] | [--current]] @@ -3015,7 +3015,7 @@ metadata **Syntax:** -.. code-block:: shell +.. code-block:: metadata domain [[--live] [--config] | [--current]] [--edit] [uri] [key] [set] [--remove] @@ -3054,7 +3054,7 @@ migrate **Syntax:** -.. code-block:: shell +.. code-block:: migrate [--live] [--offline] [--direct] [--p2p [--tunnelled]] [--persistent] [--undefinesource] [--suspend] [--copy-storage-all] @@ -3228,7 +3228,7 @@ connected to and needs to connect through a proxy, *graphicsuri* may be used to specify the address the client should connect to. The URI is formed as follows: -.. code-block:: shell +.. code-block:: protocol://hostname[:port]/[?parameters] @@ -3236,7 +3236,7 @@ where protocol is either "spice" or "vnc" and parameters is a list of protocol specific parameters separated by '&'. Currently recognized parameters are "tlsPort" and "tlsSubject". For example, -.. code-block:: shell +.. code-block:: spice://target.host.com:1234/?tlsPort=4567 @@ -3255,7 +3255,7 @@ migrate-compcache **Syntax:** -.. code-block:: shell +.. code-block:: migrate-compcache domain [--size bytes] @@ -3275,7 +3275,7 @@ migrate-getmaxdowntime **Syntax:** -.. code-block:: shell +.. code-block:: migrate-getmaxdowntime domain @@ -3290,7 +3290,7 @@ migrate-getspeed **Syntax:** -.. code-block:: shell +.. code-block:: migrate-getspeed domain [--postcopy] @@ -3304,7 +3304,7 @@ migrate-postcopy **Syntax:** -.. code-block:: shell +.. code-block:: migrate-postcopy domain @@ -3317,7 +3317,7 @@ migrate-setmaxdowntime **Syntax:** -.. code-block:: shell +.. code-block:: migrate-setmaxdowntime domain downtime @@ -3331,7 +3331,7 @@ migrate-setspeed **Syntax:** -.. code-block:: shell +.. code-block:: migrate-setspeed domain bandwidth [--postcopy] @@ -3349,7 +3349,7 @@ numatune **Syntax:** -.. code-block:: shell +.. code-block:: numatune domain [--mode mode] [--nodeset nodeset] [[--config] [--live] | [--current]] @@ -3378,7 +3378,7 @@ perf **Syntax:** -.. code-block:: shell +.. code-block:: perf domain [--enable eventSpec] [--disable eventSpec] [[--config] [--live] | [--current]] @@ -3466,7 +3466,7 @@ reboot **Syntax:** -.. code-block:: shell +.. code-block:: reboot domain [--mode MODE-LIST] @@ -3492,7 +3492,7 @@ reset **Syntax:** -.. code-block:: shell +.. code-block:: reset domain @@ -3508,7 +3508,7 @@ restore **Syntax:** -.. code-block:: shell +.. code-block:: restore state-file [--bypass-cache] [--xml file] [{--running | --paused}] @@ -3540,7 +3540,7 @@ resume **Syntax:** -.. code-block:: shell +.. code-block:: resume domain @@ -3554,7 +3554,7 @@ save **Syntax:** -.. code-block:: shell +.. code-block:: save domain state-file [--bypass-cache] [--xml file] [{--running | --paused}] [--verbose] @@ -3598,7 +3598,7 @@ save-image-define **Syntax:** -.. code-block:: shell +.. code-block:: save-image-define file xml [{--running | --paused}] @@ -3620,7 +3620,7 @@ save-image-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: save-image-dumpxml file [--security-info] @@ -3634,7 +3634,7 @@ save-image-edit **Syntax:** -.. code-block:: shell +.. code-block:: save-image-edit file [{--running | --paused}] @@ -3648,7 +3648,7 @@ will allow overriding which state the ``restore`` should use. This is equivalent to: -.. code-block:: shell +.. code-block:: virsh save-image-dumpxml state-file > state-file.xml vi state-file.xml (or make changes with your other text editor) @@ -3665,7 +3665,7 @@ schedinfo **Syntax:** -.. code-block:: shell +.. code-block:: schedinfo domain [[--config] [--live] | [--current]] [[--set] parameter=value]... schedinfo [--weight number] [--cap number] domain @@ -3706,7 +3706,7 @@ screenshot **Syntax:** -.. code-block:: shell +.. code-block:: screenshot domain [imagefilepath] [--screen screenID] @@ -3723,7 +3723,7 @@ send-key **Syntax:** -.. code-block:: shell +.. code-block:: send-key domain [--codeset codeset] [--holdtime holdtime] keycode... @@ -3820,7 +3820,7 @@ distinct keypresses, you must use multiple send-key invocations. **Examples:** -.. code-block:: shell +.. code-block:: # send three strokes 'k', 'e', 'y', using xt codeset. these # are all pressed simultaneously and may be received by the guest @@ -3840,7 +3840,7 @@ send-process-signal **Syntax:** -.. code-block:: shell +.. code-block:: send-process-signal domain-id pid signame @@ -3851,7 +3851,7 @@ domain namespace. The *signame* argument may be either an integer signal constant number, or one of the symbolic names: -.. code-block:: shell +.. code-block:: "nop", "hup", "int", "quit", "ill", "trap", "abrt", "bus", "fpe", "kill", @@ -3871,7 +3871,7 @@ may be in uppercase or lowercase. **Examples:** -.. code-block:: shell +.. code-block:: virsh send-process-signal myguest 1 15 virsh send-process-signal myguest 1 term @@ -3884,7 +3884,7 @@ set-lifecycle-action **Syntax:** -.. code-block:: shell +.. code-block:: set-lifecycle-action domain type action [[--config] [--live] | [--current]] @@ -3901,7 +3901,7 @@ set-user-password **Syntax:** -.. code-block:: shell +.. code-block:: set-user-password domain user password [--encrypted] @@ -3919,7 +3919,7 @@ setmaxmem **Syntax:** -.. code-block:: shell +.. code-block:: setmaxmem domain size [[--config] [--live] | [--current]] @@ -3950,7 +3950,7 @@ setmem **Syntax:** -.. code-block:: shell +.. code-block:: setmem domain size [[--config] [--live] | [--current]] @@ -3985,7 +3985,7 @@ setvcpus **Syntax:** -.. code-block:: shell +.. code-block:: setvcpus domain count [--maximum] [[--config] [--live] | [--current]] [--guest] [--hotpluggable] @@ -4036,7 +4036,7 @@ setvcpu **Syntax:** -.. code-block:: shell +.. code-block:: setvcpu domain vcpulist [--enable] | [--disable] [[--live] [--config] | [--current]] @@ -4063,7 +4063,7 @@ shutdown **Syntax:** -.. code-block:: shell +.. code-block:: shutdown domain [--mode MODE-LIST] @@ -4095,7 +4095,7 @@ start **Syntax:** -.. code-block:: shell +.. code-block:: start domain-name-or-uuid [--console] [--paused] [--autodestroy] [--bypass-cache] [--force-boot] @@ -4124,7 +4124,7 @@ suspend **Syntax:** -.. code-block:: shell +.. code-block:: suspend domain @@ -4137,7 +4137,7 @@ ttyconsole **Syntax:** -.. code-block:: shell +.. code-block:: ttyconsole domain @@ -4150,7 +4150,7 @@ undefine **Syntax:** -.. code-block:: shell +.. code-block:: undefine domain [--managed-save] [--snapshots-metadata] [--checkpoints-metadata] [--nvram] [--keep-nvram] @@ -4216,7 +4216,7 @@ vcpucount **Syntax:** -.. code-block:: shell +.. code-block:: vcpucount domain [{--maximum | --active} {--config | --live | --current}] [--guest] @@ -4247,7 +4247,7 @@ vcpuinfo **Syntax:** -.. code-block:: shell +.. code-block:: vcpuinfo domain [--pretty] @@ -4258,7 +4258,7 @@ With *--pretty*, cpu affinities are shown as ranges. **Example:** -.. code-block:: shell +.. code-block:: $ virsh vcpuinfo fedora VCPU: 0 @@ -4311,7 +4311,7 @@ vcpupin **Syntax:** -.. code-block:: shell +.. code-block:: vcpupin domain [vcpu] [cpulist] [[--live] [--config] | [--current]] @@ -4339,7 +4339,7 @@ vncdisplay **Syntax:** -.. code-block:: shell +.. code-block:: vncdisplay domain @@ -4362,7 +4362,7 @@ attach-device **Syntax:** -.. code-block:: shell +.. code-block:: attach-device domain FILE [[[--live] [--config] | [--current]] | [--persistent]] @@ -4398,7 +4398,7 @@ attach-disk **Syntax:** -.. code-block:: shell +.. code-block:: attach-disk domain source target [[[--live] [--config] | [--current]] | [--persistent]] [--targetbus bus] @@ -4464,7 +4464,7 @@ attach-interface **Syntax:** -.. code-block:: shell +.. code-block:: attach-interface domain type source [[[--live] [--config] | [--current]] | [--persistent]] @@ -4555,7 +4555,7 @@ detach-device **Syntax:** -.. code-block:: shell +.. code-block:: detach-device domain FILE [[[--live] [--config] | [--current]] | [--persistent]] @@ -4601,7 +4601,7 @@ detach-device-alias **Syntax:** -.. code-block:: shell +.. code-block:: detach-device-alias domain alias [[[--live] [--config] | [--current]]]] @@ -4622,7 +4622,7 @@ detach-disk **Syntax:** -.. code-block:: shell +.. code-block:: detach-disk domain target [[[--live] [--config] | [--current]] | [--persistent]] [--print-xml] @@ -4655,7 +4655,7 @@ detach-interface **Syntax:** -.. code-block:: shell +.. code-block:: detach-interface domain type [--mac mac] [[[--live] [--config] | [--current]] | [--persistent]] @@ -4687,7 +4687,7 @@ update-device **Syntax:** -.. code-block:: shell +.. code-block:: update-device domain file [--force] [[[--live] [--config] | [--current]] | [--persistent]] @@ -4721,7 +4721,7 @@ change-media **Syntax:** -.. code-block:: shell +.. code-block:: change-media domain path [--eject] [--insert] [--update] [source] [--force] [[--live] [--config] | @@ -4791,7 +4791,7 @@ nodedev-create **Syntax:** -.. code-block:: shell +.. code-block:: nodedev-create FILE @@ -4807,7 +4807,7 @@ nodedev-destroy **Syntax:** -.. code-block:: shell +.. code-block:: nodedev-destroy device @@ -4822,7 +4822,7 @@ nodedev-detach **Syntax:** -.. code-block:: shell +.. code-block:: nodedev-detach nodedev [--driver backend_driver] @@ -4842,7 +4842,7 @@ nodedev-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: nodedev-dumpxml device @@ -4859,7 +4859,7 @@ nodedev-list **Syntax:** -.. code-block:: shell +.. code-block:: nodedev-list cap --tree @@ -4878,7 +4878,7 @@ nodedev-reattach **Syntax:** -.. code-block:: shell +.. code-block:: nodedev-reattach nodedev @@ -4893,7 +4893,7 @@ nodedev-reset **Syntax:** -.. code-block:: shell +.. code-block:: nodedev-reset nodedev @@ -4908,7 +4908,7 @@ nodedev-event **Syntax:** -.. code-block:: shell +.. code-block:: nodedev-event {[nodedev] event [--loop] [--timeout seconds] [--timestamp] | --list} @@ -4944,7 +4944,7 @@ net-autostart **Syntax:** -.. code-block:: shell +.. code-block:: net-autostart network [--disable] @@ -4957,7 +4957,7 @@ net-create **Syntax:** -.. code-block:: shell +.. code-block:: net-create file @@ -4972,7 +4972,7 @@ net-define **Syntax:** -.. code-block:: shell +.. code-block:: net-define file @@ -4985,7 +4985,7 @@ net-destroy **Syntax:** -.. code-block:: shell +.. code-block:: net-destroy network @@ -4998,7 +4998,7 @@ net-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: net-dumpxml network [--inactive] @@ -5013,7 +5013,7 @@ net-edit **Syntax:** -.. code-block:: shell +.. code-block:: net-edit network @@ -5021,7 +5021,7 @@ Edit the XML configuration file for a network. This is equivalent to: -.. code-block:: shell +.. code-block:: virsh net-dumpxml --inactive network > network.xml vi network.xml (or make changes with your other text editor) @@ -5038,7 +5038,7 @@ net-event **Syntax:** -.. code-block:: shell +.. code-block:: net-event {[network] event [--loop] [--timeout seconds] [--timestamp] | --list} @@ -5063,7 +5063,7 @@ net-info **Syntax:** -.. code-block:: shell +.. code-block:: net-info network @@ -5075,7 +5075,7 @@ net-list **Syntax:** -.. code-block:: shell +.. code-block:: net-list [--inactive | --all] { [--table] | --name | --uuid } @@ -5106,7 +5106,7 @@ net-name **Syntax:** -.. code-block:: shell +.. code-block:: net-name network-UUID @@ -5118,7 +5118,7 @@ net-start **Syntax:** -.. code-block:: shell +.. code-block:: net-start network @@ -5130,7 +5130,7 @@ net-undefine **Syntax:** -.. code-block:: shell +.. code-block:: net-undefine network @@ -5143,7 +5143,7 @@ net-uuid **Syntax:** -.. code-block:: shell +.. code-block:: net-uuid network-name @@ -5155,7 +5155,7 @@ net-update **Syntax:** -.. code-block:: shell +.. code-block:: net-update network command section xml [--parent-index index] [[--live] [--config] | [--current]] @@ -5202,7 +5202,7 @@ net-dhcp-leases **Syntax:** -.. code-block:: shell +.. code-block:: net-dhcp-leases network [mac] @@ -5227,7 +5227,7 @@ net-port-list **Syntax:** -.. code-block:: shell +.. code-block:: net-port-list { [--table] | --uuid } network @@ -5244,7 +5244,7 @@ net-port-create **Syntax:** -.. code-block:: shell +.. code-block:: net-port-create network file @@ -5257,7 +5257,7 @@ net-port-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: net-port-dumpxml network port @@ -5269,7 +5269,7 @@ net-port-delete **Syntax:** -.. code-block:: shell +.. code-block:: net-port-delete network port @@ -5298,7 +5298,7 @@ iface-bridge **Syntax:** -.. code-block:: shell +.. code-block:: iface-bridge interface bridge [--no-stp] [delay] [--no-start] @@ -5317,7 +5317,7 @@ iface-define **Syntax:** -.. code-block:: shell +.. code-block:: iface-define file @@ -5330,7 +5330,7 @@ iface-destroy **Syntax:** -.. code-block:: shell +.. code-block:: iface-destroy interface @@ -5343,7 +5343,7 @@ iface-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: iface-dumpxml interface [--inactive] @@ -5357,7 +5357,7 @@ iface-edit **Syntax:** -.. code-block:: shell +.. code-block:: iface-edit interface @@ -5365,7 +5365,7 @@ Edit the XML configuration file for a host interface. This is equivalent to: -.. code-block:: shell +.. code-block:: virsh iface-dumpxml iface > iface.xml vi iface.xml (or make changes with your other text editor) @@ -5382,7 +5382,7 @@ iface-list **Syntax:** -.. code-block:: shell +.. code-block:: iface-list [--inactive | --all] @@ -5396,7 +5396,7 @@ iface-name **Syntax:** -.. code-block:: shell +.. code-block:: iface-name interface @@ -5411,7 +5411,7 @@ iface-mac **Syntax:** -.. code-block:: shell +.. code-block:: iface-mac interface @@ -5425,7 +5425,7 @@ iface-start **Syntax:** -.. code-block:: shell +.. code-block:: iface-start interface @@ -5437,7 +5437,7 @@ iface-unbridge **Syntax:** -.. code-block:: shell +.. code-block:: iface-unbridge bridge [--no-start] @@ -5455,7 +5455,7 @@ iface-undefine **Syntax:** -.. code-block:: shell +.. code-block:: iface-undefine interface @@ -5467,7 +5467,7 @@ iface-begin **Syntax:** -.. code-block:: shell +.. code-block:: iface-begin @@ -5485,7 +5485,7 @@ iface-commit **Syntax:** -.. code-block:: shell +.. code-block:: iface-commit @@ -5499,7 +5499,7 @@ iface-rollback **Syntax:** -.. code-block:: shell +.. code-block:: iface-rollback @@ -5525,7 +5525,7 @@ find-storage-pool-sources **Syntax:** -.. code-block:: shell +.. code-block:: find-storage-pool-sources type [srcSpec] @@ -5562,7 +5562,7 @@ find-pool-sources-as **Syntax:** -.. code-block:: shell +.. code-block:: find-storage-pool-sources-as type [host] [port] [initiator] @@ -5586,7 +5586,7 @@ pool-autostart **Syntax:** -.. code-block:: shell +.. code-block:: pool-autostart pool-or-uuid [--disable] @@ -5598,7 +5598,7 @@ pool-build **Syntax:** -.. code-block:: shell +.. code-block:: pool-build pool-or-uuid [--overwrite] [--no-overwrite] @@ -5640,7 +5640,7 @@ pool-create **Syntax:** -.. code-block:: shell +.. code-block:: pool-create file [--build] [[--overwrite] | [--no-overwrite]] @@ -5658,7 +5658,7 @@ pool-create-as **Syntax:** -.. code-block:: shell +.. code-block:: pool-create-as name type [--source-host hostname] [--source-path path] [--source-dev path] @@ -5744,7 +5744,7 @@ pool-define **Syntax:** -.. code-block:: shell +.. code-block:: pool-define file @@ -5757,7 +5757,7 @@ pool-define-as **Syntax:** -.. code-block:: shell +.. code-block:: pool-define-as name type [--source-host hostname] [--source-path path] [--source-dev path] @@ -5782,7 +5782,7 @@ pool-destroy **Syntax:** -.. code-block:: shell +.. code-block:: pool-destroy pool-or-uuid @@ -5797,7 +5797,7 @@ pool-delete **Syntax:** -.. code-block:: shell +.. code-block:: pool-delete pool-or-uuid @@ -5811,7 +5811,7 @@ pool-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: pool-dumpxml [--inactive] pool-or-uuid @@ -5825,7 +5825,7 @@ pool-edit **Syntax:** -.. code-block:: shell +.. code-block:: pool-edit pool-or-uuid @@ -5833,7 +5833,7 @@ Edit the XML configuration file for a storage pool. This is equivalent to: -.. code-block:: shell +.. code-block:: virsh pool-dumpxml pool > pool.xml vi pool.xml (or make changes with your other text editor) @@ -5850,7 +5850,7 @@ pool-info **Syntax:** -.. code-block:: shell +.. code-block:: pool-info [--bytes] pool-or-uuid @@ -5863,7 +5863,7 @@ pool-list **Syntax:** -.. code-block:: shell +.. code-block:: pool-list [--inactive] [--all] [--persistent] [--transient] @@ -5903,7 +5903,7 @@ pool-name **Syntax:** -.. code-block:: shell +.. code-block:: pool-name uuid @@ -5915,7 +5915,7 @@ pool-refresh **Syntax:** -.. code-block:: shell +.. code-block:: pool-refresh pool-or-uuid @@ -5927,7 +5927,7 @@ pool-start **Syntax:** -.. code-block:: shell +.. code-block:: pool-start pool-or-uuid [--build] [[--overwrite] | [--no-overwrite]] @@ -5955,7 +5955,7 @@ pool-undefine **Syntax:** -.. code-block:: shell +.. code-block:: pool-undefine pool-or-uuid @@ -5967,7 +5967,7 @@ pool-uuid **Syntax:** -.. code-block:: shell +.. code-block:: pool-uuid pool @@ -5979,7 +5979,7 @@ pool-event **Syntax:** -.. code-block:: shell +.. code-block:: pool-event {[pool] event [--loop] [--timeout seconds] [--timestamp] | --list} @@ -6007,7 +6007,7 @@ vol-create **Syntax:** -.. code-block:: shell +.. code-block:: vol-create pool-or-uuid FILE [--prealloc-metadata] @@ -6026,7 +6026,7 @@ only slightly higher initial disk space usage. **Example:** -.. code-block:: shell +.. code-block:: virsh vol-dumpxml --pool storagepool1 appvolume1 > newvolume.xml vi newvolume.xml (or make changes with your other text editor) @@ -6038,7 +6038,7 @@ vol-create-from **Syntax:** -.. code-block:: shell +.. code-block:: vol-create-from pool-or-uuid FILE vol-name-or-key-or-path [--inputpool pool-or-uuid] [--prealloc-metadata] [--reflink] @@ -6069,7 +6069,7 @@ vol-create-as **Syntax:** -.. code-block:: shell +.. code-block:: vol-create-as pool-or-uuid name capacity [--allocation size] [--format string] [--backing-vol vol-name-or-key-or-path] @@ -6118,7 +6118,7 @@ vol-clone **Syntax:** -.. code-block:: shell +.. code-block:: vol-clone vol-name-or-key-or-path name [--pool pool-or-uuid] [--prealloc-metadata] [--reflink] @@ -6151,7 +6151,7 @@ vol-delete **Syntax:** -.. code-block:: shell +.. code-block:: vol-delete vol-name-or-key-or-path [--pool pool-or-uuid] [--delete-snapshots] @@ -6175,7 +6175,7 @@ vol-upload **Syntax:** -.. code-block:: shell +.. code-block:: vol-upload vol-name-or-key-or-path local-file [--pool pool-or-uuid] [--offset bytes] @@ -6213,7 +6213,7 @@ vol-download **Syntax:** -.. code-block:: shell +.. code-block:: vol-download vol-name-or-key-or-path local-file [--pool pool-or-uuid] [--offset bytes] [--length bytes] @@ -6244,7 +6244,7 @@ vol-wipe **Syntax:** -.. code-block:: shell +.. code-block:: vol-wipe vol-name-or-key-or-path [--pool pool-or-uuid] [--algorithm algorithm] @@ -6303,7 +6303,7 @@ vol-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: vol-dumpxml vol-name-or-key-or-path [--pool pool-or-uuid] @@ -6323,7 +6323,7 @@ vol-info **Syntax:** -.. code-block:: shell +.. code-block:: vol-info vol-name-or-key-or-path [--pool pool-or-uuid] [--bytes] [--physical] @@ -6352,7 +6352,7 @@ vol-list **Syntax:** -.. code-block:: shell +.. code-block:: vol-list [--pool pool-or-uuid] [--details] @@ -6369,7 +6369,7 @@ vol-pool **Syntax:** -.. code-block:: shell +.. code-block:: vol-pool vol-key-or-path [--uuid] @@ -6387,7 +6387,7 @@ vol-path **Syntax:** -.. code-block:: shell +.. code-block:: vol-path vol-name-or-key [--pool pool-or-uuid] @@ -6406,7 +6406,7 @@ vol-name **Syntax:** -.. code-block:: shell +.. code-block:: vol-name vol-key-or-path @@ -6420,7 +6420,7 @@ vol-key **Syntax:** -.. code-block:: shell +.. code-block:: vol-key vol-name-or-path [--pool pool-or-uuid] @@ -6440,7 +6440,7 @@ vol-resize **Syntax:** -.. code-block:: shell +.. code-block:: vol-resize vol-name-or-path capacity [--pool pool-or-uuid] [--allocate] [--delta] [--shrink] @@ -6485,7 +6485,7 @@ secret-define **Syntax:** -.. code-block:: shell +.. code-block:: secret-define file @@ -6500,7 +6500,7 @@ secret-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: secret-dumpxml secret @@ -6512,7 +6512,7 @@ secret-event **Syntax:** -.. code-block:: shell +.. code-block:: secret-event {[secret] event [--loop] [--timeout seconds] [--timestamp] | --list} @@ -6537,7 +6537,7 @@ secret-set-value **Syntax:** -.. code-block:: shell +.. code-block:: secret-set-value secret base64 @@ -6550,7 +6550,7 @@ secret-get-value **Syntax:** -.. code-block:: shell +.. code-block:: secret-get-value secret @@ -6563,7 +6563,7 @@ secret-undefine **Syntax:** -.. code-block:: shell +.. code-block:: secret-undefine secret @@ -6577,7 +6577,7 @@ secret-list **Syntax:** -.. code-block:: shell +.. code-block:: secret-list [--ephemeral] [--no-ephemeral] [--private] [--no-private] @@ -6604,7 +6604,7 @@ snapshot-create **Syntax:** -.. code-block:: shell +.. code-block:: snapshot-create domain [xmlfile] {[--redefine [--current]] | [--no-metadata] [--halt] [--disk-only] [--reuse-external] @@ -6685,7 +6685,7 @@ snapshot-create-as **Syntax:** -.. code-block:: shell +.. code-block:: snapshot-create-as domain {[--print-xml] [--no-metadata] [--halt] [--reuse-external]} [name] @@ -6723,7 +6723,7 @@ all three of *domain*, *name*, and *description* are also present. For example, a diskspec of "vda,snapshot=external,file=/path/to,,new" results in the following XML: -.. code-block:: xml +.. code-block:: <disk name='vda' snapshot='external'> <source file='/path/to,new'/> @@ -6766,7 +6766,7 @@ snapshot-current **Syntax:** -.. code-block:: shell +.. code-block:: snapshot-current domain {[--name] | [--security-info] | [snapshotname]} @@ -6785,7 +6785,7 @@ snapshot-edit **Syntax:** -.. code-block:: shell +.. code-block:: snapshot-edit domain [snapshotname] [--current] {[--rename] | [--clone]} @@ -6797,7 +6797,7 @@ snapshot. This is equivalent to: -.. code-block:: shell +.. code-block:: virsh snapshot-dumpxml dom name > snapshot.xml vi snapshot.xml (or make changes with your other text editor) @@ -6822,7 +6822,7 @@ snapshot-info **Syntax:** -.. code-block:: shell +.. code-block:: snapshot-info domain {snapshot | --current} @@ -6835,7 +6835,7 @@ snapshot-list **Syntax:** -.. code-block:: shell +.. code-block:: snapshot-list domain [--metadata] [--no-metadata] [{--parent | --roots | [{--tree | --name}]}] [--topological] @@ -6904,7 +6904,7 @@ snapshot-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: snapshot-dumpxml domain snapshot [--security-info] @@ -6918,7 +6918,7 @@ snapshot-parent **Syntax:** -.. code-block:: shell +.. code-block:: snapshot-parent domain {snapshot | --current} @@ -6931,7 +6931,7 @@ snapshot-revert **Syntax:** -.. code-block:: shell +.. code-block:: snapshot-revert domain {snapshot | --current} [{--running | --paused}] [--force] @@ -6972,7 +6972,7 @@ snapshot-delete **Syntax:** -.. code-block:: shell +.. code-block:: snapshot-delete domain {snapshot | --current} [--metadata] [{--children | --children-only}] @@ -7006,7 +7006,7 @@ checkpoint-create **Syntax:** -.. code-block:: shell +.. code-block:: checkpoint-create domain [xmlfile] { --redefine | [--quiesce]} @@ -7045,7 +7045,7 @@ checkpoint-create-as **Syntax:** -.. code-block:: shell +.. code-block:: checkpoint-create-as domain [--print-xml] [name] [description] [--quiesce] [--diskspec] diskspec]... @@ -7065,7 +7065,7 @@ all three of *domain*, *name*, and *description* are also present. For example, a diskspec of "vda,checkpoint=bitmap,bitmap=map1" results in the following XML: -.. code-block:: xml +.. code-block:: <disk name='vda' checkpoint='bitmap' bitmap='map1'/> @@ -7083,7 +7083,7 @@ checkpoint-edit **Syntax:** -.. code-block:: shell +.. code-block:: checkpoint-edit domain checkpointname @@ -7091,7 +7091,7 @@ Edit the XML configuration file for *checkpointname* of a domain. This is equivalent to: -.. code-block:: shell +.. code-block:: virsh checkpoint-dumpxml dom name > checkpoint.xml vi checkpoint.xml (or make changes with your other text editor) @@ -7109,7 +7109,7 @@ checkpoint-info **Syntax:** -.. code-block:: shell +.. code-block:: checkpoint-info domain checkpoint @@ -7121,7 +7121,7 @@ checkpoint-list **Syntax:** -.. code-block:: shell +.. code-block:: checkpoint-list domain [{--parent | --roots | [{--tree | --name}]}] [--topological] @@ -7167,7 +7167,7 @@ checkpoint-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: checkpoint-dumpxml domain checkpoint [--security-info] [--no-domain] [--size] @@ -7187,7 +7187,7 @@ checkpoint-parent **Syntax:** -.. code-block:: shell +.. code-block:: checkpoint-parent domain checkpoint @@ -7199,7 +7199,7 @@ checkpoint **Syntax:** -.. code-block:: shell +.. code-block:: checkpoint-delete domain checkpoint [--metadata] [{--children | --children-only}] @@ -7236,7 +7236,7 @@ nwfilter-define **Syntax:** -.. code-block:: shell +.. code-block:: nwfilter-define xmlfile @@ -7253,7 +7253,7 @@ nwfilter-undefine **Syntax:** -.. code-block:: shell +.. code-block:: nwfilter-undefine nwfilter-name @@ -7266,7 +7266,7 @@ nwfilter-list **Syntax:** -.. code-block:: shell +.. code-block:: nwfilter-list @@ -7278,7 +7278,7 @@ nwfilter-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: nwfilter-dumpxml nwfilter-name @@ -7290,7 +7290,7 @@ nwfilter-edit **Syntax:** -.. code-block:: shell +.. code-block:: nwfilter-edit nwfilter-name @@ -7298,7 +7298,7 @@ Edit the XML of a network filter. This is equivalent to: -.. code-block:: shell +.. code-block:: virsh nwfilter-dumpxml myfilter > myfilter.xml vi myfilter.xml (or make changes with your other text editor) @@ -7329,7 +7329,7 @@ nwfilter-binding-create **Syntax:** -.. code-block:: shell +.. code-block:: nwfilter-binding-create xmlfile @@ -7348,7 +7348,7 @@ nwfilter-binding-delete **Syntax:** -.. code-block:: shell +.. code-block:: nwfilter-binding-delete port-name @@ -7366,7 +7366,7 @@ nwfilter-binding-list **Syntax:** -.. code-block:: shell +.. code-block:: nwfilter-binding-list @@ -7378,7 +7378,7 @@ nwfilter-binding-dumpxml **Syntax:** -.. code-block:: shell +.. code-block:: nwfilter-binding-dumpxml port-name @@ -7402,7 +7402,7 @@ qemu-attach **Syntax:** -.. code-block:: shell +.. code-block:: qemu-attach pid @@ -7411,7 +7411,7 @@ The QEMU process must have been created with a monitor connection using the UNIX driver. Ideally the process will also have had the '-name' argument specified. -.. code-block:: shell +.. code-block:: $ qemu-kvm -cdrom ~/demo.iso \ -monitor unix:/tmp/demo,server,nowait \ @@ -7432,7 +7432,7 @@ qemu-monitor-command **Syntax:** -.. code-block:: shell +.. code-block:: qemu-monitor-command domain { [--hmp] | [--pretty] } command... @@ -7451,7 +7451,7 @@ qemu-agent-command **Syntax:** -.. code-block:: shell +.. code-block:: qemu-agent-command domain [--timeout seconds | --async | --block] command... @@ -7469,7 +7469,7 @@ qemu-monitor-event **Syntax:** -.. code-block:: shell +.. code-block:: qemu-monitor-event [domain] [--event event-name] [--loop] [--timeout seconds] [--pretty] [--regex] [--no-case] @@ -7500,7 +7500,7 @@ lxc-enter-namespace **Syntax:** -.. code-block:: shell +.. code-block:: lxc-enter-namespace domain [--noseclabel] -- /path/to/binary [arg1, [arg2, ...]] diff --git a/docs/manpages/virt-admin.rst b/docs/manpages/virt-admin.rst index bf42139f30..51c3d3917e 100644 --- a/docs/manpages/virt-admin.rst +++ b/docs/manpages/virt-admin.rst @@ -28,7 +28,7 @@ as for monitoring and managing all clients connected to the daemon. The basic structure of most virt-admin usage is: -.. code-block:: shell +.. code-block:: virt-admin [OPTION]... <command> [ARG]... @@ -107,7 +107,7 @@ help **Syntax:** -.. code-block:: shell +.. code-block:: help [command-or-group] @@ -124,7 +124,7 @@ quit, exit **Syntax:** -.. code-block:: shell +.. code-block:: quit exit @@ -136,7 +136,7 @@ version **Syntax:** -.. code-block:: shell +.. code-block:: version @@ -146,7 +146,7 @@ the version of the daemon. **Example:** -.. code-block:: shell +.. code-block:: $ virt-admin version Compiled against library: libvirt 1.2.21 @@ -160,7 +160,7 @@ cd **Syntax:** -.. code-block:: shell +.. code-block:: cd [directory] @@ -175,7 +175,7 @@ pwd **Syntax:** -.. code-block:: shell +.. code-block:: pwd @@ -187,7 +187,7 @@ connect **Syntax:** -.. code-block:: shell +.. code-block:: connect [URI] @@ -206,7 +206,7 @@ uri **Syntax:** -.. code-block:: shell +.. code-block:: uri @@ -230,7 +230,7 @@ server-list **Syntax:** -.. code-block:: shell +.. code-block:: server-list @@ -243,7 +243,7 @@ daemon-log-filters **Syntax:** -.. code-block:: shell +.. code-block:: daemon-log-filters [--filters string] @@ -264,7 +264,7 @@ space. Each filter must conform to the form described in detail by To define a filter which suppresses all e.g. 'virObjectUnref' DEBUG messages, use the following: -.. code-block:: shell +.. code-block:: $ virt-admin daemon-log-filters "4:util.object" @@ -277,7 +277,7 @@ daemon-log-outouts **Syntax:** -.. code-block:: shell +.. code-block:: daemon-log-outputs [--outputs string] @@ -298,13 +298,13 @@ space. Each output must conform to the form described in detail by To replace the current setting for logging outputs with one that writes to a file while logging errors only, the following could be used: -.. code-block:: shell +.. code-block:: $ virt-admin daemon-log-outputs "4:file:<absolute_path_to_the_file>" To define multiple outputs at once they need to be delimited by spaces: -.. code-block:: shell +.. code-block:: $ virt-admin daemon-log-outputs "4:stderr 2:syslog:<msg_ident>" @@ -320,7 +320,7 @@ server-threadpool-info **Syntax:** -.. code-block:: shell +.. code-block:: server-threadpool-info server @@ -355,7 +355,7 @@ that, unlike tasks carried out by normal workers, are within libvirt's full control and libvirt guarantees that such a task cannot hang, thus will always finish. An example of such a task this would be destroying a domain: -.. code-block:: shell +.. code-block:: $ virsh destroy <domain>. @@ -365,7 +365,7 @@ server-threadpool-set **Syntax:** -.. code-block:: shell +.. code-block:: server-threadpool-set server [--min-workers count] [--max-workers count] [--priority-workers count] @@ -394,7 +394,7 @@ server-clients-info **Syntax:** -.. code-block:: shell +.. code-block:: server-clients-info server @@ -407,7 +407,7 @@ runtime values, more specifically, the current number of clients connected to **Example:** -.. code-block:: shell +.. code-block:: # virt-admin server-clients-info libvirtd nclients_max : 120 @@ -421,7 +421,7 @@ server-clients-set **Syntax:** -.. code-block:: shell +.. code-block:: server-clients-set server [--max-clients count] [--max-unauth-clients count] @@ -457,7 +457,7 @@ client-list **Syntax:** -.. code-block:: shell +.. code-block:: client-list server @@ -471,7 +471,7 @@ client-info **Syntax:** -.. code-block:: shell +.. code-block:: client-info server client @@ -487,7 +487,7 @@ enabled within daemon). **Examples:** -.. code-block:: shell +.. code-block:: # virt-admin client-info libvirtd 1 id : 1 @@ -513,7 +513,7 @@ client-disconnect **Syntax:** -.. code-block:: shell +.. code-block:: client-disconnect server client diff --git a/docs/manpages/virt-login-shell.rst b/docs/manpages/virt-login-shell.rst index 4716493f87..3833a3e912 100644 --- a/docs/manpages/virt-login-shell.rst +++ b/docs/manpages/virt-login-shell.rst @@ -29,7 +29,7 @@ configured in ``/etc/libvirt/virt-login-shell.conf``. The basic structure of most ``virt-login-shell`` usage is: -.. code-block:: shell +.. code-block:: virt-login-shell diff --git a/docs/manpages/virtlockd.rst b/docs/manpages/virtlockd.rst index 4066934e42..1dc106d6fc 100644 --- a/docs/manpages/virtlockd.rst +++ b/docs/manpages/virtlockd.rst @@ -120,14 +120,14 @@ EXAMPLES To retrieve the version of ``virtlockd``: -.. code-block:: shell +.. code-block:: # virtlockd --version virtlockd (libvirt) 1.1.1 To start ``virtlockd``, instructing it to daemonize and create a PID file: -.. code-block:: shell +.. code-block:: # virtlockd -d # ls -la RUNSTATEDIR/virtlockd.pid diff --git a/docs/manpages/virtlogd.rst b/docs/manpages/virtlogd.rst index 7f4c5d7e7f..c84ab2e621 100644 --- a/docs/manpages/virtlogd.rst +++ b/docs/manpages/virtlogd.rst @@ -121,14 +121,14 @@ EXAMPLES To retrieve the version of ``virtlogd``: -.. code-block:: shell +.. code-block:: # virtlogd --version virtlogd (libvirt) 1.1.1 To start ``virtlogd``, instructing it to daemonize and create a PID file: -.. code-block:: shell +.. code-block:: # virtlogd -d # ls -la RUNSTATEDIR/virtlogd.pid -- 2.23.0