From nobody Sun May 19 02:38:16 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) client-ip=216.205.24.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1601894877; cv=none; d=zohomail.com; s=zohoarc; b=glMtCiZh1BYVDTxL7qo1e+DXVGElTk3VnhQX6mbLqZGbIuBKt0xrnZnuo/6kZXY0otk2P6Bf0x/wy2F37KqHvDblZxg1e4JTMeB+zeH8gIpbUkh6Lyb/yWORcfgFtCeo7Y4m8HI3RBK5A91PcA7nxhelW4b0oslVgcNRGLBCKuw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1601894877; h=Content-Type:Content-Transfer-Encoding:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=U3rLUw7JvxPm33Ir/FkKhQ2D5zXjv7Swuxc5+rTMGmA=; b=aUkb2q6BQ4B99beW4CrxxFLOUBSu5G9IYCj2cqvMebhoOeiRuOmzm5+m2JQXTrTHN8RXs+oL5SyiKeRkXsTppbMCvSrQnVLN77hee/rOiQ+bOOW/D05RF5n6T41TmLwjsb8VIJt2kxHQGso2f8Yzc63raU5Q4mu05XJ5jHu3FeA= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 216.205.24.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) header.from= Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [216.205.24.124]) by mx.zohomail.com with SMTPS id 1601894877058359.44928464639327; Mon, 5 Oct 2020 03:47:57 -0700 (PDT) Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-61-EueGYUt7OOynGmjWpsBAFw-1; Mon, 05 Oct 2020 06:47:51 -0400 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.phx2.redhat.com [10.5.11.14]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 9B01E87315B; Mon, 5 Oct 2020 10:47:45 +0000 (UTC) Received: from colo-mx.corp.redhat.com (colo-mx02.intmail.prod.int.phx2.redhat.com [10.5.11.21]) by smtp.corp.redhat.com (Postfix) with ESMTPS id DCFC05DEB8; Mon, 5 Oct 2020 10:47:44 +0000 (UTC) Received: from lists01.pubmisc.prod.ext.phx2.redhat.com (lists01.pubmisc.prod.ext.phx2.redhat.com [10.5.19.33]) by colo-mx.corp.redhat.com (Postfix) with ESMTP id B5CE244A5E; Mon, 5 Oct 2020 10:47:42 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) by lists01.pubmisc.prod.ext.phx2.redhat.com (8.13.8/8.13.8) with ESMTP id 095AlfE3019908 for ; Mon, 5 Oct 2020 06:47:41 -0400 Received: by smtp.corp.redhat.com (Postfix) id 364C0277C6; Mon, 5 Oct 2020 10:47:41 +0000 (UTC) Received: from localhost.localdomain.com (ovpn-114-250.ams2.redhat.com [10.36.114.250]) by smtp.corp.redhat.com (Postfix) with ESMTP id D792C27CDF; Mon, 5 Oct 2020 10:47:29 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1601894874; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=U3rLUw7JvxPm33Ir/FkKhQ2D5zXjv7Swuxc5+rTMGmA=; b=hkTNcscScE2DpBBwfps+8wJ438UtnNKrCfjFgzZ/zfolDyCEefMrOPVQv8SWFZq15xfFD9 9xdP0Jz91xN4KuWH/8d4ifyDJdtEkbvebTsriebpSZNSftwytKPa+FaJZ/cY2Bgmw2S+xD 0Vds8nzDU3mJwwTzKK+OzNPtvwrnWK8= X-MC-Unique: EueGYUt7OOynGmjWpsBAFw-1 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: libvir-list@redhat.com Subject: [libvirt PATCH v2] docs: use "::" instead of ".. code-block::" Date: Mon, 5 Oct 2020 11:47:26 +0100 Message-Id: <20201005104726.2437119-1-berrange@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 X-loop: libvir-list@redhat.com X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.12 Precedence: junk List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: libvir-list-bounces@redhat.com Errors-To: libvir-list-bounces@redhat.com X-Scanned-By: MIMEDefang 2.79 on 10.5.11.14 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) The former is a short hand for the latter and is already widely used in the docs. Using the short hand avoids incompatibility with the alternate impl of rst2html5. Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Erik Skultety --- Changed in v2: - Simplify to use "::" instead of adding a language to ".. code-block::" because the latter didn't work on macOS builds due to problems with pygments integration in homebrew docs/manpages/libvirtd.rst | 4 +- docs/manpages/virsh.rst | 582 ++++++++++++++--------------- docs/manpages/virt-admin.rst | 52 +-- docs/manpages/virt-login-shell.rst | 8 +- docs/manpages/virtlockd.rst | 4 +- docs/manpages/virtlogd.rst | 4 +- 6 files changed, 327 insertions(+), 327 deletions(-) diff --git a/docs/manpages/libvirtd.rst b/docs/manpages/libvirtd.rst index c88e2dd7e1..cd9976c5e4 100644 --- a/docs/manpages/libvirtd.rst +++ b/docs/manpages/libvirtd.rst @@ -199,7 +199,7 @@ EXAMPLES =20 To retrieve the version of libvirtd: =20 -.. code-block:: +:: =20 # libvirtd --version libvirtd (libvirt) 0.8.2 @@ -207,7 +207,7 @@ To retrieve the version of libvirtd: =20 To start libvirtd, instructing it to daemonize and create a PID file: =20 -.. code-block:: +:: =20 # libvirtd -d # ls -la @RUNSTATEDIR@/libvirtd.pid diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst index 9ac379a4b8..c855269041 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: =20 =20 -.. code-block:: +:: =20 virsh [OPTION]... [ARG]... =20 @@ -185,7 +185,7 @@ historical reasons, some commands default to bytes, whi= le other commands default to kibibytes). The following case-insensitive suffixes can be used to select a specific scale: =20 -.. code-block:: +:: =20 b, byte byte 1 KB kilobyte 1,000 @@ -214,7 +214,7 @@ help =20 **Syntax:** =20 -.. code-block:: +:: =20 help [command-or-group] =20 @@ -228,7 +228,7 @@ group as an option. For example: =20 **Example 1:** =20 -.. code-block:: +:: =20 virsh # help host =20 @@ -250,7 +250,7 @@ option instead. For example: =20 **Example 2:** =20 -.. code-block:: +:: =20 virsh # help list NAME @@ -272,7 +272,7 @@ quit, exit =20 **Syntax:** =20 -.. code-block:: +:: =20 quit exit @@ -286,7 +286,7 @@ version =20 **Syntax:** =20 -.. code-block:: +:: =20 version [--daemon] =20 @@ -296,7 +296,7 @@ is included in the output. =20 **Example:** =20 -.. code-block:: +:: =20 $ virsh version Compiled against library: libvirt 1.2.3 @@ -317,7 +317,7 @@ cd =20 **Syntax:** =20 -.. code-block:: +:: =20 cd [directory] =20 @@ -334,7 +334,7 @@ pwd =20 **Syntax:** =20 -.. code-block:: +:: =20 pwd =20 @@ -347,7 +347,7 @@ connect =20 **Syntax:** =20 -.. code-block:: +:: =20 connect [URI] [--readonly] =20 @@ -388,7 +388,7 @@ uri =20 **Syntax:** =20 -.. code-block:: +:: =20 uri =20 @@ -400,7 +400,7 @@ hostname =20 **Syntax:** =20 -.. code-block:: +:: =20 hostname =20 @@ -412,7 +412,7 @@ sysinfo =20 **Syntax:** =20 -.. code-block:: +:: =20 sysinfo =20 @@ -424,7 +424,7 @@ nodeinfo =20 **Syntax:** =20 -.. code-block:: +:: =20 nodeinfo =20 @@ -440,7 +440,7 @@ nodecpumap =20 **Syntax:** =20 -.. code-block:: +:: =20 nodecpumap [--pretty] =20 @@ -456,7 +456,7 @@ nodecpustats =20 **Syntax:** =20 -.. code-block:: +:: =20 nodecpustats [cpu] [--percent] =20 @@ -471,7 +471,7 @@ nodememstats =20 **Syntax:** =20 -.. code-block:: +:: =20 nodememstats [cell] =20 @@ -484,7 +484,7 @@ nodesuspend =20 **Syntax:** =20 -.. code-block:: +:: =20 nodesuspend [target] [duration] =20 @@ -503,7 +503,7 @@ node-memory-tune =20 **Syntax:** =20 -.. code-block:: +:: =20 node-memory-tune [shm-pages-to-scan] [shm-sleep-millisecs] [shm-merge-a= cross-nodes] =20 @@ -525,7 +525,7 @@ capabilities =20 **Syntax:** =20 -.. code-block:: +:: =20 capabilities =20 @@ -545,7 +545,7 @@ domcapabilities =20 **Syntax:** =20 -.. code-block:: +:: =20 domcapabilities [virttype] [emulatorbin] [arch] [machine] =20 @@ -588,7 +588,7 @@ pool-capabilities =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-capabilities =20 @@ -605,7 +605,7 @@ inject-nmi =20 **Syntax:** =20 -.. code-block:: +:: =20 inject-nmi domain =20 @@ -617,7 +617,7 @@ list =20 **Syntax:** =20 -.. code-block:: +:: =20 list [--inactive | --all] [--managed-save] [--title] @@ -637,7 +637,7 @@ specified it prints out information about running domai= ns. =20 An example format for the list is as follows: =20 -.. code-block:: +:: =20 ``virsh`` list Id Name State @@ -775,7 +775,7 @@ printed in an extra column. This flag is usable only wi= th the default =20 **Example 2:** =20 -.. code-block:: +:: =20 $ virsh list --title Id Name State Title @@ -790,7 +790,7 @@ freecell =20 **Syntax:** =20 -.. code-block:: +:: =20 freecell [{ [--cellno] cellno | --all }] =20 @@ -809,7 +809,7 @@ freepages =20 **Syntax:** =20 -.. code-block:: +:: =20 freepages [{ [--cellno] cellno [--pagesize] pagesize | --all }] =20 @@ -824,7 +824,7 @@ allocpages =20 **Syntax:** =20 -.. code-block:: +:: =20 allocpages [--pagesize] pagesize [--pagecount] pagecount [[--cellno] ce= llno] [--add] [--all] =20 @@ -843,7 +843,7 @@ cpu-baseline =20 **Syntax:** =20 -.. code-block:: +:: =20 cpu-baseline FILE [--features] [--migratable] =20 @@ -864,7 +864,7 @@ cpu-compare =20 **Syntax:** =20 -.. code-block:: +:: =20 cpu-compare FILE [--error] =20 @@ -890,7 +890,7 @@ cpu-models =20 **Syntax:** =20 -.. code-block:: +:: =20 cpu-models arch =20 @@ -909,7 +909,7 @@ echo =20 **Syntax:** =20 -.. code-block:: +:: =20 echo [--shell] [--xml] [err...] [arg...] =20 @@ -926,7 +926,7 @@ hypervisor-cpu-compare =20 **Syntax:** =20 -.. code-block:: +:: =20 hypervisor-cpu-compare FILE [virttype] [emulator] [arch] [machine] [--e= rror] =20 @@ -958,7 +958,7 @@ hypervisor-cpu-baseline =20 **Syntax:** =20 -.. code-block:: +:: =20 hypervisor-cpu-baseline FILE [virttype] [emulator] [arch] [machine] [--= features] [--migratable] =20 @@ -1005,7 +1005,7 @@ autostart =20 **Syntax:** =20 -.. code-block:: +:: =20 autostart [--disable] domain =20 @@ -1020,7 +1020,7 @@ blkdeviotune =20 **Syntax:** =20 -.. code-block:: +:: =20 blkdeviotune domain device [[--config] [--live] | [--current]] [[total-bytes-sec] | [read-bytes-sec] [write-bytes-sec]] @@ -1103,7 +1103,7 @@ blkiotune =20 **Syntax:** =20 -.. code-block:: +:: =20 blkiotune domain [--weight weight] [--device-weights device-weights] [--device-read-iops-sec device-read-iops-sec] @@ -1165,7 +1165,7 @@ blockcommit =20 **Syntax:** =20 -.. code-block:: +:: =20 blockcommit domain path [bandwidth] [--bytes] [base] [--shallow] [top] [--delete] [--keep-relative] @@ -1223,7 +1223,7 @@ blockcopy =20 **Syntax:** =20 -.. code-block:: +:: =20 blockcopy domain path { dest [format] [--blockdev] | --xml file } [--shallow] [--reuse-external] [bandwidth] @@ -1295,7 +1295,7 @@ blockjob =20 **Syntax:** =20 -.. code-block:: +:: =20 blockjob domain path { [--abort] [--async] [--pivot] | [--info] [--raw] [--bytes] | [bandwidth] } @@ -1345,7 +1345,7 @@ blockpull =20 **Syntax:** =20 -.. code-block:: +:: =20 blockpull domain path [bandwidth] [--bytes] [base] [--wait [--verbose] [--timeout seconds] [--async]] @@ -1386,7 +1386,7 @@ blockresize =20 **Syntax:** =20 -.. code-block:: +:: =20 blockresize domain path size =20 @@ -1407,7 +1407,7 @@ console =20 **Syntax:** =20 -.. code-block:: +:: =20 console domain [devname] [--safe] [--force] =20 @@ -1428,7 +1428,7 @@ cpu-stats =20 **Syntax:** =20 -.. code-block:: +:: =20 cpu-stats domain [--total] [start] [count] =20 @@ -1444,7 +1444,7 @@ create =20 **Syntax:** =20 -.. code-block:: +:: =20 create FILE [--console] [--paused] [--autodestroy] [--pass-fds N,M,...] [--validate] @@ -1475,7 +1475,7 @@ is only supported with container based virtualization. #. prepare a template from an existing domain (skip directly to 3a if writ= ing one from scratch) =20 - .. code-block:: + :: =20 # virsh dumpxml > domain.xml =20 @@ -1484,7 +1484,7 @@ is only supported with container based virtualization. a. DO CHANGE! and ( can also be removed), or b. DON'T CHANGE! either or =20 - .. code-block:: + :: =20 # $EDITOR domain.xml =20 @@ -1495,7 +1495,7 @@ is only supported with container based virtualization. b. an existing persistent guest will run with a modified one-time configuration =20 - .. code-block:: + :: =20 # virsh create domain.xml =20 @@ -1505,7 +1505,7 @@ define =20 **Syntax:** =20 -.. code-block:: +:: =20 define FILE [--validate] =20 @@ -1521,7 +1521,7 @@ desc =20 **Syntax:** =20 -.. code-block:: +:: =20 desc domain [[--live] [--config] | [--current]] [--title] [--edit] [--new-desc @@ -1553,7 +1553,7 @@ destroy =20 **Syntax:** =20 -.. code-block:: +:: =20 destroy domain [--graceful] =20 @@ -1581,7 +1581,7 @@ domblkerror =20 **Syntax:** =20 -.. code-block:: +:: =20 domblkerror domain =20 @@ -1597,7 +1597,7 @@ domblkinfo =20 **Syntax:** =20 -.. code-block:: +:: =20 domblkinfo domain [block-device --all] [--human] =20 @@ -1617,7 +1617,7 @@ domblklist =20 **Syntax:** =20 -.. code-block:: +:: =20 domblklist domain [--inactive] [--details] =20 @@ -1637,7 +1637,7 @@ domblkstat =20 **Syntax:** =20 -.. code-block:: +:: =20 domblkstat domain [block-device] [--human] =20 @@ -1674,7 +1674,7 @@ domblkthreshold =20 **Syntax:** =20 -.. code-block:: +:: =20 domblkthreshold domain dev threshold =20 @@ -1689,7 +1689,7 @@ domcontrol =20 **Syntax:** =20 -.. code-block:: +:: =20 domcontrol domain =20 @@ -1703,7 +1703,7 @@ domdisplay =20 **Syntax:** =20 -.. code-block:: +:: =20 domdisplay domain [--include-password] [[--type] type] [--all] =20 @@ -1720,7 +1720,7 @@ domfsfreeze =20 **Syntax:** =20 -.. code-block:: +:: =20 domfsfreeze domain [[--mountpoint] mountpoint...] =20 @@ -1742,7 +1742,7 @@ domfsinfo =20 **Syntax:** =20 -.. code-block:: +:: =20 domfsinfo domain =20 @@ -1759,7 +1759,7 @@ domfsthaw =20 **Syntax:** =20 -.. code-block:: +:: =20 domfsthaw domain [[--mountpoint] mountpoint...] =20 @@ -1776,7 +1776,7 @@ domfstrim =20 **Syntax:** =20 -.. code-block:: +:: =20 domfstrim domain [--minimum bytes] [--mountpoint mountPoint] =20 @@ -1797,7 +1797,7 @@ domhostname =20 **Syntax:** =20 -.. code-block:: +:: =20 domhostname domain [--source lease|agent] =20 @@ -1814,7 +1814,7 @@ domid =20 **Syntax:** =20 -.. code-block:: +:: =20 domid domain-name-or-uuid =20 @@ -1826,7 +1826,7 @@ domif-getlink =20 **Syntax:** =20 -.. code-block:: +:: =20 domif-getlink domain interface-device [--config] =20 @@ -1842,7 +1842,7 @@ domif-setlink =20 **Syntax:** =20 -.. code-block:: +:: =20 domif-setlink domain interface-device state [--config] =20 @@ -1858,7 +1858,7 @@ domifaddr =20 **Syntax:** =20 -.. code-block:: +:: =20 domifaddr domain [interface] [--full] [--source lease|agent|arp] @@ -1885,7 +1885,7 @@ backup-begin =20 **Syntax:** =20 -.. code-block:: +:: =20 backup-begin domain [backupxml] [checkpointxml] [--reuse-external] =20 @@ -1919,7 +1919,7 @@ backup-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 backup-dumpxml domain =20 @@ -1931,7 +1931,7 @@ domiflist =20 **Syntax:** =20 -.. code-block:: +:: =20 domiflist domain [--inactive] =20 @@ -1948,7 +1948,7 @@ domifstat =20 **Syntax:** =20 -.. code-block:: +:: =20 domifstat domain interface-device =20 @@ -1965,7 +1965,7 @@ domiftune =20 **Syntax:** =20 -.. code-block:: +:: =20 domiftune domain interface-device [[--config] [--live] | [--current]] [*--inbound average,peak,burst,floor*] @@ -2000,7 +2000,7 @@ dominfo =20 **Syntax:** =20 -.. code-block:: +:: =20 dominfo domain =20 @@ -2012,7 +2012,7 @@ domjobabort =20 **Syntax:** =20 -.. code-block:: +:: =20 domjobabort domain =20 @@ -2024,7 +2024,7 @@ domjobinfo =20 **Syntax:** =20 -.. code-block:: +:: =20 domjobinfo domain [--completed [--keep-completed]] [--anystats] [--raws= tats] =20 @@ -2051,7 +2051,7 @@ dommemstat =20 **Syntax:** =20 -.. code-block:: +:: =20 dommemstat domain [--period seconds] [[--config] [--live] | [--current]] =20 @@ -2106,7 +2106,7 @@ domname =20 **Syntax:** =20 -.. code-block:: +:: =20 domname domain-id-or-uuid =20 @@ -2118,7 +2118,7 @@ dompmsuspend =20 **Syntax:** =20 -.. code-block:: +:: =20 dompmsuspend domain target [--duration] =20 @@ -2149,7 +2149,7 @@ dompmwakeup =20 **Syntax:** =20 -.. code-block:: +:: =20 dompmwakeup domain =20 @@ -2164,7 +2164,7 @@ domrename =20 **Syntax:** =20 -.. code-block:: +:: =20 domrename domain new-name =20 @@ -2179,7 +2179,7 @@ domstate =20 **Syntax:** =20 -.. code-block:: +:: =20 domstate domain [--reason] =20 @@ -2192,7 +2192,7 @@ domstats =20 **Syntax:** =20 -.. code-block:: +:: =20 domstats [--raw] [--enforce] [--backing] [--nowait] [--state] [--cpu-total] [--balloon] [--vcpu] [--interface] @@ -2426,7 +2426,7 @@ domtime =20 **Syntax:** =20 -.. code-block:: +:: =20 domtime domain { [--now] [--pretty] [--sync] [--time time] } =20 @@ -2451,7 +2451,7 @@ domuuid =20 **Syntax:** =20 -.. code-block:: +:: =20 domuuid domain-name-or-id =20 @@ -2463,7 +2463,7 @@ domxml-from-native =20 **Syntax:** =20 -.. code-block:: +:: =20 domxml-from-native format config =20 @@ -2481,7 +2481,7 @@ domxml-to-native =20 **Syntax:** =20 -.. code-block:: +:: =20 domxml-to-native format { [--xml] xml | --domain domain-name-or-id-or-u= uid } =20 @@ -2496,7 +2496,7 @@ dump =20 **Syntax:** =20 -.. code-block:: +:: =20 dump domain corefilepath [--bypass-cache] { [--live] | [--crash] | [--reset] } @@ -2538,7 +2538,7 @@ dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 dumpxml domain [--inactive] [--security-info] [--update-cpu] [--migrata= ble] =20 @@ -2559,7 +2559,7 @@ edit =20 **Syntax:** =20 -.. code-block:: +:: =20 edit domain =20 @@ -2568,7 +2568,7 @@ next boot of the guest. =20 This is equivalent to: =20 -.. code-block:: +:: =20 virsh dumpxml --inactive --security-info domain > domain.xml vi domain.xml (or make changes with your other text editor) @@ -2585,7 +2585,7 @@ emulatorpin =20 **Syntax:** =20 -.. code-block:: +:: =20 emulatorpin domain [cpulist] [[--live] [--config] | [--current]] =20 @@ -2608,7 +2608,7 @@ event =20 **Syntax:** =20 -.. code-block:: +:: =20 event {[domain] { event | --all } [--loop] [--timeout seconds] [--times= tamp] | --list} =20 @@ -2635,7 +2635,7 @@ guest-agent-timeout =20 **Syntax:** =20 -.. code-block:: +:: =20 guest-agent-timeout domain [--timeout value] =20 @@ -2655,7 +2655,7 @@ guestinfo =20 **Syntax:** =20 -.. code-block:: +:: =20 guestinfo domain [--user] [--os] [--timezone] [--hostname] [--filesyste= m] =20 @@ -2731,7 +2731,7 @@ guestvcpus =20 **Syntax:** =20 -.. code-block:: +:: =20 guestvcpus domain [[--enable] | [--disable]] [cpulist] =20 @@ -2750,7 +2750,7 @@ iothreadadd =20 **Syntax:** =20 -.. code-block:: +:: =20 iothreadadd domain iothread_id [[--config] [--live] | [--current]] =20 @@ -2770,7 +2770,7 @@ iothreaddel =20 **Syntax:** =20 -.. code-block:: +:: =20 iothreaddel domain iothread_id [[--config] [--live] | [--current]] =20 @@ -2792,7 +2792,7 @@ iothreadinfo =20 **Syntax:** =20 -.. code-block:: +:: =20 iothreadinfo domain [[--live] [--config] | [--current]] =20 @@ -2813,7 +2813,7 @@ iothreadpin =20 **Syntax:** =20 -.. code-block:: +:: =20 iothreadpin domain iothread cpulist [[--live] [--config] | [--current]] =20 @@ -2846,7 +2846,7 @@ iothreadset =20 **Syntax:** =20 -.. code-block:: +:: =20 iothreadset domain iothread_id [[--poll-max-ns ns] [--poll-grow factor] [--poll-shrink divisor]] @@ -2878,7 +2878,7 @@ managedsave =20 **Syntax:** =20 -.. code-block:: +:: =20 managedsave domain [--bypass-cache] [{--running | --paused}] [--verbose] =20 @@ -2907,7 +2907,7 @@ managedsave-define =20 **Syntax:** =20 -.. code-block:: +:: =20 managedsave-define domain xml [{--running | --paused}] =20 @@ -2927,7 +2927,7 @@ managedsave-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 managedsave-dumpxml domain [--security-info] =20 @@ -2941,7 +2941,7 @@ managedsave-edit =20 **Syntax:** =20 -.. code-block:: +:: =20 managedsave-edit domain [{--running | --paused}] =20 @@ -2955,7 +2955,7 @@ will allow overriding which state the ``restore`` sho= uld use. =20 This is equivalent to: =20 -.. code-block:: +:: =20 virsh managedsave-dumpxml domain-name > state-file.xml vi state-file.xml (or make changes with your other text editor) @@ -2972,7 +2972,7 @@ managedsave-remove =20 **Syntax:** =20 -.. code-block:: +:: =20 managedsave-remove domain =20 @@ -2985,7 +2985,7 @@ maxvcpus =20 **Syntax:** =20 -.. code-block:: +:: =20 maxvcpus [type] =20 @@ -2999,7 +2999,7 @@ memtune =20 **Syntax:** =20 -.. code-block:: +:: =20 memtune domain [--hard-limit size] [--soft-limit size] [--swap-hard-lim= it size] [--min-guarantee size] [[--config] [--live] | [--current]] @@ -3058,7 +3058,7 @@ metadata =20 **Syntax:** =20 -.. code-block:: +:: =20 metadata domain [[--live] [--config] | [--current]] [--edit] [uri] [key] [set] [--remove] @@ -3097,7 +3097,7 @@ migrate =20 **Syntax:** =20 -.. code-block:: +:: =20 migrate [--live] [--offline] [--direct] [--p2p [--tunnelled]] [--persistent] [--undefinesource] [--suspend] [--copy-storage-all] @@ -3240,7 +3240,7 @@ and/or libvirt does not have network access to the re= mote side you can use a UNIX transport in the URI and specify a socket path in the query, for exam= ple with the qemu driver you could use this: =20 -.. code-block:: +:: =20 qemu+unix:///system?socket=3D/path/to/socket =20 @@ -3274,7 +3274,7 @@ There are a few scenarios where specifying *migrateur= i* may help: should not guess a *migrateuri* and it should be specified using UNIX socket path URI: =20 -.. code-block:: +:: =20 unix:///path/to/socket =20 @@ -3289,7 +3289,7 @@ connected to and needs to connect through a proxy, *g= raphicsuri* may be used to specify the address the client should connect to. The URI is formed as follows: =20 -.. code-block:: +:: =20 protocol://hostname[:port]/[?parameters] =20 @@ -3297,7 +3297,7 @@ where protocol is either "spice" or "vnc" and paramet= ers is a list of protocol specific parameters separated by '&'. Currently recognized parameters are "tlsPort" and "tlsSubject". For example, =20 -.. code-block:: +:: =20 spice://target.host.com:1234/?tlsPort=3D4567 =20 @@ -3327,7 +3327,7 @@ migrate-compcache =20 **Syntax:** =20 -.. code-block:: +:: =20 migrate-compcache domain [--size bytes] =20 @@ -3347,7 +3347,7 @@ migrate-getmaxdowntime =20 **Syntax:** =20 -.. code-block:: +:: =20 migrate-getmaxdowntime domain =20 @@ -3362,7 +3362,7 @@ migrate-getspeed =20 **Syntax:** =20 -.. code-block:: +:: =20 migrate-getspeed domain [--postcopy] =20 @@ -3376,7 +3376,7 @@ migrate-postcopy =20 **Syntax:** =20 -.. code-block:: +:: =20 migrate-postcopy domain =20 @@ -3389,7 +3389,7 @@ migrate-setmaxdowntime =20 **Syntax:** =20 -.. code-block:: +:: =20 migrate-setmaxdowntime domain downtime =20 @@ -3403,7 +3403,7 @@ migrate-setspeed =20 **Syntax:** =20 -.. code-block:: +:: =20 migrate-setspeed domain bandwidth [--postcopy] =20 @@ -3421,7 +3421,7 @@ numatune =20 **Syntax:** =20 -.. code-block:: +:: =20 numatune domain [--mode mode] [--nodeset nodeset] [[--config] [--live] | [--current]] @@ -3459,7 +3459,7 @@ perf =20 **Syntax:** =20 -.. code-block:: +:: =20 perf domain [--enable eventSpec] [--disable eventSpec] [[--config] [--live] | [--current]] @@ -3548,7 +3548,7 @@ reboot =20 **Syntax:** =20 -.. code-block:: +:: =20 reboot domain [--mode MODE-LIST] =20 @@ -3574,7 +3574,7 @@ reset =20 **Syntax:** =20 -.. code-block:: +:: =20 reset domain =20 @@ -3590,7 +3590,7 @@ restore =20 **Syntax:** =20 -.. code-block:: +:: =20 restore state-file [--bypass-cache] [--xml file] [{--running | --paused}] @@ -3622,7 +3622,7 @@ resume =20 **Syntax:** =20 -.. code-block:: +:: =20 resume domain =20 @@ -3636,7 +3636,7 @@ save =20 **Syntax:** =20 -.. code-block:: +:: =20 save domain state-file [--bypass-cache] [--xml file] [{--running | --paused}] [--verbose] @@ -3680,7 +3680,7 @@ save-image-define =20 **Syntax:** =20 -.. code-block:: +:: =20 save-image-define file xml [{--running | --paused}] =20 @@ -3702,7 +3702,7 @@ save-image-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 save-image-dumpxml file [--security-info] =20 @@ -3716,7 +3716,7 @@ save-image-edit =20 **Syntax:** =20 -.. code-block:: +:: =20 save-image-edit file [{--running | --paused}] =20 @@ -3730,7 +3730,7 @@ will allow overriding which state the ``restore`` sho= uld use. =20 This is equivalent to: =20 -.. code-block:: +:: =20 virsh save-image-dumpxml state-file > state-file.xml vi state-file.xml (or make changes with your other text editor) @@ -3747,7 +3747,7 @@ schedinfo =20 **Syntax:** =20 -.. code-block:: +:: =20 schedinfo domain [[--config] [--live] | [--current]] [[--set] parameter= =3Dvalue]... schedinfo [--weight number] [--cap number] domain @@ -3790,7 +3790,7 @@ screenshot =20 **Syntax:** =20 -.. code-block:: +:: =20 screenshot domain [imagefilepath] [--screen screenID] =20 @@ -3807,7 +3807,7 @@ send-key =20 **Syntax:** =20 -.. code-block:: +:: =20 send-key domain [--codeset codeset] [--holdtime holdtime] keycode... =20 @@ -3904,7 +3904,7 @@ distinct keypresses, you must use multiple send-key i= nvocations. =20 **Examples:** =20 -.. code-block:: +:: =20 # send three strokes 'k', 'e', 'y', using xt codeset. these # are all pressed simultaneously and may be received by the guest @@ -3924,7 +3924,7 @@ send-process-signal =20 **Syntax:** =20 -.. code-block:: +:: =20 send-process-signal domain-id pid signame =20 @@ -3935,7 +3935,7 @@ domain namespace. The *signame* argument may be either an integer signal constant number, or one of the symbolic names: =20 -.. code-block:: +:: =20 "nop", "hup", "int", "quit", "ill", "trap", "abrt", "bus", "fpe", "kill", @@ -3955,7 +3955,7 @@ may be in uppercase or lowercase. =20 **Examples:** =20 -.. code-block:: +:: =20 virsh send-process-signal myguest 1 15 virsh send-process-signal myguest 1 term @@ -3968,7 +3968,7 @@ set-lifecycle-action =20 **Syntax:** =20 -.. code-block:: +:: =20 set-lifecycle-action domain type action [[--config] [--live] | [--current]] @@ -3985,7 +3985,7 @@ set-user-password =20 **Syntax:** =20 -.. code-block:: +:: =20 set-user-password domain user password [--encrypted] =20 @@ -4003,7 +4003,7 @@ setmaxmem =20 **Syntax:** =20 -.. code-block:: +:: =20 setmaxmem domain size [[--config] [--live] | [--current]] =20 @@ -4035,7 +4035,7 @@ setmem =20 **Syntax:** =20 -.. code-block:: +:: =20 setmem domain size [[--config] [--live] | [--current]] =20 @@ -4071,7 +4071,7 @@ setvcpus =20 **Syntax:** =20 -.. code-block:: +:: =20 setvcpus domain count [--maximum] [[--config] [--live] | [--current]] [= --guest] [--hotpluggable] =20 @@ -4123,7 +4123,7 @@ setvcpu =20 **Syntax:** =20 -.. code-block:: +:: =20 setvcpu domain vcpulist [--enable] | [--disable] [[--live] [--config] | [--current]] @@ -4151,7 +4151,7 @@ shutdown =20 **Syntax:** =20 -.. code-block:: +:: =20 shutdown domain [--mode MODE-LIST] =20 @@ -4183,7 +4183,7 @@ start =20 **Syntax:** =20 -.. code-block:: +:: =20 start domain-name-or-uuid [--console] [--paused] [--autodestroy] [--bypass-cache] [--force-boot] @@ -4212,7 +4212,7 @@ suspend =20 **Syntax:** =20 -.. code-block:: +:: =20 suspend domain =20 @@ -4225,7 +4225,7 @@ ttyconsole =20 **Syntax:** =20 -.. code-block:: +:: =20 ttyconsole domain =20 @@ -4238,7 +4238,7 @@ undefine =20 **Syntax:** =20 -.. code-block:: +:: =20 undefine domain [--managed-save] [--snapshots-metadata] [--checkpoints-metadata] [--nvram] [--keep-nvram] @@ -4304,7 +4304,7 @@ vcpucount =20 **Syntax:** =20 -.. code-block:: +:: =20 vcpucount domain [{--maximum | --active} {--config | --live | --current}] [--guest] @@ -4335,7 +4335,7 @@ vcpuinfo =20 **Syntax:** =20 -.. code-block:: +:: =20 vcpuinfo domain [--pretty] =20 @@ -4346,7 +4346,7 @@ With *--pretty*, cpu affinities are shown as ranges. =20 **Example:** =20 -.. code-block:: +:: =20 $ virsh vcpuinfo fedora VCPU: 0 @@ -4399,7 +4399,7 @@ vcpupin =20 **Syntax:** =20 -.. code-block:: +:: =20 vcpupin domain [vcpu] [cpulist] [[--live] [--config] | [--current]] =20 @@ -4428,7 +4428,7 @@ vncdisplay =20 **Syntax:** =20 -.. code-block:: +:: =20 vncdisplay domain =20 @@ -4451,7 +4451,7 @@ attach-device =20 **Syntax:** =20 -.. code-block:: +:: =20 attach-device domain FILE [[[--live] [--config] | [--current]] | [--per= sistent]] =20 @@ -4488,7 +4488,7 @@ attach-disk =20 **Syntax:** =20 -.. code-block:: +:: =20 attach-disk domain source target [[[--live] [--config] | [--current]] | [--persistent]] [--targetbus bus] @@ -4556,7 +4556,7 @@ attach-interface =20 **Syntax:** =20 -.. code-block:: +:: =20 attach-interface domain type source [[[--live] [--config] | [--current]] | [--persistent]] @@ -4648,7 +4648,7 @@ detach-device =20 **Syntax:** =20 -.. code-block:: +:: =20 detach-device domain FILE [[[--live] [--config] | [--current]] | [--persistent]] @@ -4695,7 +4695,7 @@ detach-device-alias =20 **Syntax:** =20 -.. code-block:: +:: =20 detach-device-alias domain alias [[[--live] [--config] | [--current]]]] =20 @@ -4717,7 +4717,7 @@ detach-disk =20 **Syntax:** =20 -.. code-block:: +:: =20 detach-disk domain target [[[--live] [--config] | [--current]] | [--persistent]] [--print-xml] @@ -4751,7 +4751,7 @@ detach-interface =20 **Syntax:** =20 -.. code-block:: +:: =20 detach-interface domain type [--mac mac] [[[--live] [--config] | [--current]] | [--persistent]] @@ -4784,7 +4784,7 @@ update-device =20 **Syntax:** =20 -.. code-block:: +:: =20 update-device domain file [--force] [[[--live] [--config] | [--current]] | [--persistent]] @@ -4819,7 +4819,7 @@ change-media =20 **Syntax:** =20 -.. code-block:: +:: =20 change-media domain path [--eject] [--insert] [--update] [source] [--force] [[--live] [--config] | @@ -4889,7 +4889,7 @@ nodedev-create =20 **Syntax:** =20 -.. code-block:: +:: =20 nodedev-create FILE =20 @@ -4905,7 +4905,7 @@ nodedev-destroy =20 **Syntax:** =20 -.. code-block:: +:: =20 nodedev-destroy device =20 @@ -4920,7 +4920,7 @@ nodedev-detach =20 **Syntax:** =20 -.. code-block:: +:: =20 nodedev-detach nodedev [--driver backend_driver] =20 @@ -4940,7 +4940,7 @@ nodedev-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 nodedev-dumpxml device =20 @@ -4957,7 +4957,7 @@ nodedev-list =20 **Syntax:** =20 -.. code-block:: +:: =20 nodedev-list cap --tree =20 @@ -4976,7 +4976,7 @@ nodedev-reattach =20 **Syntax:** =20 -.. code-block:: +:: =20 nodedev-reattach nodedev =20 @@ -4991,7 +4991,7 @@ nodedev-reset =20 **Syntax:** =20 -.. code-block:: +:: =20 nodedev-reset nodedev =20 @@ -5006,7 +5006,7 @@ nodedev-event =20 **Syntax:** =20 -.. code-block:: +:: =20 nodedev-event {[nodedev] event [--loop] [--timeout seconds] [--timestam= p] | --list} =20 @@ -5042,7 +5042,7 @@ net-autostart =20 **Syntax:** =20 -.. code-block:: +:: =20 net-autostart network [--disable] =20 @@ -5055,7 +5055,7 @@ net-create =20 **Syntax:** =20 -.. code-block:: +:: =20 net-create file =20 @@ -5070,7 +5070,7 @@ net-define =20 **Syntax:** =20 -.. code-block:: +:: =20 net-define file =20 @@ -5083,7 +5083,7 @@ net-destroy =20 **Syntax:** =20 -.. code-block:: +:: =20 net-destroy network =20 @@ -5096,7 +5096,7 @@ net-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 net-dumpxml network [--inactive] =20 @@ -5111,7 +5111,7 @@ net-edit =20 **Syntax:** =20 -.. code-block:: +:: =20 net-edit network =20 @@ -5119,7 +5119,7 @@ Edit the XML configuration file for a network. =20 This is equivalent to: =20 -.. code-block:: +:: =20 virsh net-dumpxml --inactive network > network.xml vi network.xml (or make changes with your other text editor) @@ -5136,7 +5136,7 @@ net-event =20 **Syntax:** =20 -.. code-block:: +:: =20 net-event {[network] event [--loop] [--timeout seconds] [--timestamp] |= --list} =20 @@ -5161,7 +5161,7 @@ net-info =20 **Syntax:** =20 -.. code-block:: +:: =20 net-info network =20 @@ -5173,7 +5173,7 @@ net-list =20 **Syntax:** =20 -.. code-block:: +:: =20 net-list [--inactive | --all] { [--table] | --name | --uuid } @@ -5204,7 +5204,7 @@ net-name =20 **Syntax:** =20 -.. code-block:: +:: =20 net-name network-UUID =20 @@ -5216,7 +5216,7 @@ net-start =20 **Syntax:** =20 -.. code-block:: +:: =20 net-start network =20 @@ -5228,7 +5228,7 @@ net-undefine =20 **Syntax:** =20 -.. code-block:: +:: =20 net-undefine network =20 @@ -5241,7 +5241,7 @@ net-uuid =20 **Syntax:** =20 -.. code-block:: +:: =20 net-uuid network-name =20 @@ -5253,7 +5253,7 @@ net-update =20 **Syntax:** =20 -.. code-block:: +:: =20 net-update network command section xml [--parent-index index] [[--live] [--config] | [--current]] @@ -5301,7 +5301,7 @@ net-dhcp-leases =20 **Syntax:** =20 -.. code-block:: +:: =20 net-dhcp-leases network [mac] =20 @@ -5326,7 +5326,7 @@ net-port-list =20 **Syntax:** =20 -.. code-block:: +:: =20 net-port-list { [--table] | --uuid } network =20 @@ -5343,7 +5343,7 @@ net-port-create =20 **Syntax:** =20 -.. code-block:: +:: =20 net-port-create network file =20 @@ -5356,7 +5356,7 @@ net-port-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 net-port-dumpxml network port =20 @@ -5368,7 +5368,7 @@ net-port-delete =20 **Syntax:** =20 -.. code-block:: +:: =20 net-port-delete network port =20 @@ -5397,7 +5397,7 @@ iface-bridge =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-bridge interface bridge [--no-stp] [delay] [--no-start] =20 @@ -5416,7 +5416,7 @@ iface-define =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-define file =20 @@ -5429,7 +5429,7 @@ iface-destroy =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-destroy interface =20 @@ -5442,7 +5442,7 @@ iface-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-dumpxml interface [--inactive] =20 @@ -5456,7 +5456,7 @@ iface-edit =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-edit interface =20 @@ -5464,7 +5464,7 @@ Edit the XML configuration file for a host interface. =20 This is equivalent to: =20 -.. code-block:: +:: =20 virsh iface-dumpxml iface > iface.xml vi iface.xml (or make changes with your other text editor) @@ -5481,7 +5481,7 @@ iface-list =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-list [--inactive | --all] =20 @@ -5495,7 +5495,7 @@ iface-name =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-name interface =20 @@ -5510,7 +5510,7 @@ iface-mac =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-mac interface =20 @@ -5524,7 +5524,7 @@ iface-start =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-start interface =20 @@ -5536,7 +5536,7 @@ iface-unbridge =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-unbridge bridge [--no-start] =20 @@ -5554,7 +5554,7 @@ iface-undefine =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-undefine interface =20 @@ -5566,7 +5566,7 @@ iface-begin =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-begin =20 @@ -5584,7 +5584,7 @@ iface-commit =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-commit =20 @@ -5598,7 +5598,7 @@ iface-rollback =20 **Syntax:** =20 -.. code-block:: +:: =20 iface-rollback =20 @@ -5624,7 +5624,7 @@ find-storage-pool-sources =20 **Syntax:** =20 -.. code-block:: +:: =20 find-storage-pool-sources type [srcSpec] =20 @@ -5662,7 +5662,7 @@ find-pool-sources-as =20 **Syntax:** =20 -.. code-block:: +:: =20 find-storage-pool-sources-as type [host] [port] [initiator] =20 @@ -5686,7 +5686,7 @@ pool-autostart =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-autostart pool-or-uuid [--disable] =20 @@ -5698,7 +5698,7 @@ pool-build =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-build pool-or-uuid [--overwrite] [--no-overwrite] =20 @@ -5740,7 +5740,7 @@ pool-create =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-create file [--build] [[--overwrite] | [--no-overwrite]] =20 @@ -5758,7 +5758,7 @@ pool-create-as =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-create-as name type [--source-host hostname] [--source-path path] [--source-dev path] @@ -5848,7 +5848,7 @@ pool-define =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-define file =20 @@ -5861,7 +5861,7 @@ pool-define-as =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-define-as name type [--source-host hostname] [--source-path path] [--source-dev path] @@ -5887,7 +5887,7 @@ pool-destroy =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-destroy pool-or-uuid =20 @@ -5902,7 +5902,7 @@ pool-delete =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-delete pool-or-uuid =20 @@ -5916,7 +5916,7 @@ pool-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-dumpxml [--inactive] pool-or-uuid =20 @@ -5930,7 +5930,7 @@ pool-edit =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-edit pool-or-uuid =20 @@ -5938,7 +5938,7 @@ Edit the XML configuration file for a storage pool. =20 This is equivalent to: =20 -.. code-block:: +:: =20 virsh pool-dumpxml pool > pool.xml vi pool.xml (or make changes with your other text editor) @@ -5955,7 +5955,7 @@ pool-info =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-info [--bytes] pool-or-uuid =20 @@ -5968,7 +5968,7 @@ pool-list =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-list [--inactive] [--all] [--persistent] [--transient] @@ -6008,7 +6008,7 @@ pool-name =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-name uuid =20 @@ -6020,7 +6020,7 @@ pool-refresh =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-refresh pool-or-uuid =20 @@ -6032,7 +6032,7 @@ pool-start =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-start pool-or-uuid [--build] [[--overwrite] | [--no-overwrite]] =20 @@ -6060,7 +6060,7 @@ pool-undefine =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-undefine pool-or-uuid =20 @@ -6072,7 +6072,7 @@ pool-uuid =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-uuid pool =20 @@ -6084,7 +6084,7 @@ pool-event =20 **Syntax:** =20 -.. code-block:: +:: =20 pool-event {[pool] event [--loop] [--timeout seconds] [--timestamp] | -= -list} =20 @@ -6112,7 +6112,7 @@ vol-create =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-create pool-or-uuid FILE [--prealloc-metadata] =20 @@ -6131,7 +6131,7 @@ only slightly higher initial disk space usage. =20 **Example:** =20 -.. code-block:: +:: =20 virsh vol-dumpxml --pool storagepool1 appvolume1 > newvolume.xml vi newvolume.xml (or make changes with your other text editor) @@ -6143,7 +6143,7 @@ vol-create-from =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-create-from pool-or-uuid FILE vol-name-or-key-or-path [--inputpool pool-or-uuid] [--prealloc-metadata] [--reflink] @@ -6174,7 +6174,7 @@ vol-create-as =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-create-as pool-or-uuid name capacity [--allocation size] [--format = string] [--backing-vol vol-name-or-key-or-path] @@ -6223,7 +6223,7 @@ vol-clone =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-clone vol-name-or-key-or-path name [--pool pool-or-uuid] [--prealloc-metadata] [--reflink] @@ -6256,7 +6256,7 @@ vol-delete =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-delete vol-name-or-key-or-path [--pool pool-or-uuid] [--delete-snap= shots] =20 @@ -6280,7 +6280,7 @@ vol-upload =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-upload vol-name-or-key-or-path local-file [--pool pool-or-uuid] [--offset bytes] @@ -6318,7 +6318,7 @@ vol-download =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-download vol-name-or-key-or-path local-file [--pool pool-or-uuid] [--offset bytes] [--length bytes] @@ -6349,7 +6349,7 @@ vol-wipe =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-wipe vol-name-or-key-or-path [--pool pool-or-uuid] [--algorithm alg= orithm] =20 @@ -6408,7 +6408,7 @@ vol-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-dumpxml vol-name-or-key-or-path [--pool pool-or-uuid] =20 @@ -6428,7 +6428,7 @@ vol-info =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-info vol-name-or-key-or-path [--pool pool-or-uuid] [--bytes] [--phy= sical] =20 @@ -6457,7 +6457,7 @@ vol-list =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-list [--pool pool-or-uuid] [--details] =20 @@ -6474,7 +6474,7 @@ vol-pool =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-pool vol-key-or-path [--uuid] =20 @@ -6492,7 +6492,7 @@ vol-path =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-path vol-name-or-key [--pool pool-or-uuid] =20 @@ -6511,7 +6511,7 @@ vol-name =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-name vol-key-or-path =20 @@ -6525,7 +6525,7 @@ vol-key =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-key vol-name-or-path [--pool pool-or-uuid] =20 @@ -6545,7 +6545,7 @@ vol-resize =20 **Syntax:** =20 -.. code-block:: +:: =20 vol-resize vol-name-or-path capacity [--pool pool-or-uuid] [--allocate]= [--delta] [--shrink] =20 @@ -6590,7 +6590,7 @@ secret-define =20 **Syntax:** =20 -.. code-block:: +:: =20 secret-define file =20 @@ -6605,7 +6605,7 @@ secret-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 secret-dumpxml secret =20 @@ -6617,7 +6617,7 @@ secret-event =20 **Syntax:** =20 -.. code-block:: +:: =20 secret-event {[secret] event [--loop] [--timeout seconds] [--timestamp]= | --list} =20 @@ -6642,7 +6642,7 @@ secret-set-value =20 **Syntax:** =20 -.. code-block:: +:: =20 secret-set-value secret (--file filename [--plain] | --interactive | ba= se64) =20 @@ -6665,7 +6665,7 @@ secret-get-value =20 **Syntax:** =20 -.. code-block:: +:: =20 secret-get-value [--plain] secret =20 @@ -6682,7 +6682,7 @@ secret-undefine =20 **Syntax:** =20 -.. code-block:: +:: =20 secret-undefine secret =20 @@ -6696,7 +6696,7 @@ secret-list =20 **Syntax:** =20 -.. code-block:: +:: =20 secret-list [--ephemeral] [--no-ephemeral] [--private] [--no-private] @@ -6723,7 +6723,7 @@ snapshot-create =20 **Syntax:** =20 -.. code-block:: +:: =20 snapshot-create domain [xmlfile] {[--redefine [--current]] | [--no-metadata] [--halt] [--disk-only] [--reuse-external] @@ -6804,7 +6804,7 @@ snapshot-create-as =20 **Syntax:** =20 -.. code-block:: +:: =20 snapshot-create-as domain {[--print-xml] [--no-metadata] [--halt] [--reuse-external]} [name] @@ -6843,7 +6843,7 @@ all three of *domain*, *name*, and *description* are = also present. For example, a diskspec of "vda,snapshot=3Dexternal,file=3D/path/to,,new" results in the following XML: =20 -.. code-block:: +:: =20 @@ -6886,7 +6886,7 @@ snapshot-current =20 **Syntax:** =20 -.. code-block:: +:: =20 snapshot-current domain {[--name] | [--security-info] | [snapshotname]} =20 @@ -6905,7 +6905,7 @@ snapshot-edit =20 **Syntax:** =20 -.. code-block:: +:: =20 snapshot-edit domain [snapshotname] [--current] {[--rename] | [--clone]} =20 @@ -6917,7 +6917,7 @@ snapshot. =20 This is equivalent to: =20 -.. code-block:: +:: =20 virsh snapshot-dumpxml dom name > snapshot.xml vi snapshot.xml (or make changes with your other text editor) @@ -6942,7 +6942,7 @@ snapshot-info =20 **Syntax:** =20 -.. code-block:: +:: =20 snapshot-info domain {snapshot | --current} =20 @@ -6955,7 +6955,7 @@ snapshot-list =20 **Syntax:** =20 -.. code-block:: +:: =20 snapshot-list domain [--metadata] [--no-metadata] [{--parent | --roots | [{--tree | --name}]}] [--topological] @@ -7024,7 +7024,7 @@ snapshot-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 snapshot-dumpxml domain snapshot [--security-info] =20 @@ -7038,7 +7038,7 @@ snapshot-parent =20 **Syntax:** =20 -.. code-block:: +:: =20 snapshot-parent domain {snapshot | --current} =20 @@ -7051,7 +7051,7 @@ snapshot-revert =20 **Syntax:** =20 -.. code-block:: +:: =20 snapshot-revert domain {snapshot | --current} [{--running | --paused}] = [--force] =20 @@ -7101,7 +7101,7 @@ snapshot-delete =20 **Syntax:** =20 -.. code-block:: +:: =20 snapshot-delete domain {snapshot | --current} [--metadata] [{--children | --children-only}] @@ -7135,7 +7135,7 @@ checkpoint-create =20 **Syntax:** =20 -.. code-block:: +:: =20 checkpoint-create domain [xmlfile] { --redefine | [--quiesce]} =20 @@ -7174,7 +7174,7 @@ checkpoint-create-as =20 **Syntax:** =20 -.. code-block:: +:: =20 checkpoint-create-as domain [--print-xml] [name] [description] [--quiesce] [--diskspec] diskspec]... @@ -7194,7 +7194,7 @@ all three of *domain*, *name*, and *description* are = also present. For example, a diskspec of "vda,checkpoint=3Dbitmap,bitmap=3Dmap1" results in the following XML: =20 -.. code-block:: +:: =20 =20 @@ -7212,7 +7212,7 @@ checkpoint-edit =20 **Syntax:** =20 -.. code-block:: +:: =20 checkpoint-edit domain checkpointname =20 @@ -7220,7 +7220,7 @@ Edit the XML configuration file for *checkpointname* = of a domain. =20 This is equivalent to: =20 -.. code-block:: +:: =20 virsh checkpoint-dumpxml dom name > checkpoint.xml vi checkpoint.xml (or make changes with your other text editor) @@ -7238,7 +7238,7 @@ checkpoint-info =20 **Syntax:** =20 -.. code-block:: +:: =20 checkpoint-info domain checkpoint =20 @@ -7250,7 +7250,7 @@ checkpoint-list =20 **Syntax:** =20 -.. code-block:: +:: =20 checkpoint-list domain [{--parent | --roots | [{--tree | --name}]}] [--topological] @@ -7296,7 +7296,7 @@ checkpoint-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 checkpoint-dumpxml domain checkpoint [--security-info] [--no-domain] [-= -size] =20 @@ -7316,7 +7316,7 @@ checkpoint-parent =20 **Syntax:** =20 -.. code-block:: +:: =20 checkpoint-parent domain checkpoint =20 @@ -7328,7 +7328,7 @@ checkpoint-delete =20 **Syntax:** =20 -.. code-block:: +:: =20 checkpoint-delete domain checkpoint [--metadata] [{--children | --children-only}] @@ -7365,7 +7365,7 @@ nwfilter-define =20 **Syntax:** =20 -.. code-block:: +:: =20 nwfilter-define xmlfile =20 @@ -7382,7 +7382,7 @@ nwfilter-undefine =20 **Syntax:** =20 -.. code-block:: +:: =20 nwfilter-undefine nwfilter-name =20 @@ -7395,7 +7395,7 @@ nwfilter-list =20 **Syntax:** =20 -.. code-block:: +:: =20 nwfilter-list =20 @@ -7407,7 +7407,7 @@ nwfilter-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 nwfilter-dumpxml nwfilter-name =20 @@ -7419,7 +7419,7 @@ nwfilter-edit =20 **Syntax:** =20 -.. code-block:: +:: =20 nwfilter-edit nwfilter-name =20 @@ -7427,7 +7427,7 @@ Edit the XML of a network filter. =20 This is equivalent to: =20 -.. code-block:: +:: =20 virsh nwfilter-dumpxml myfilter > myfilter.xml vi myfilter.xml (or make changes with your other text editor) @@ -7458,7 +7458,7 @@ nwfilter-binding-create =20 **Syntax:** =20 -.. code-block:: +:: =20 nwfilter-binding-create xmlfile =20 @@ -7477,7 +7477,7 @@ nwfilter-binding-delete =20 **Syntax:** =20 -.. code-block:: +:: =20 nwfilter-binding-delete port-name =20 @@ -7495,7 +7495,7 @@ nwfilter-binding-list =20 **Syntax:** =20 -.. code-block:: +:: =20 nwfilter-binding-list =20 @@ -7507,7 +7507,7 @@ nwfilter-binding-dumpxml =20 **Syntax:** =20 -.. code-block:: +:: =20 nwfilter-binding-dumpxml port-name =20 @@ -7531,7 +7531,7 @@ qemu-attach =20 **Syntax:** =20 -.. code-block:: +:: =20 qemu-attach pid =20 @@ -7540,7 +7540,7 @@ The QEMU process must have been created with a monito= r connection using the UNIX driver. Ideally the process will also have had the '-name' argument specified. =20 -.. code-block:: +:: =20 $ qemu-kvm -cdrom ~/demo.iso \ -monitor unix:/tmp/demo,server,nowait \ @@ -7561,7 +7561,7 @@ qemu-monitor-command =20 **Syntax:** =20 -.. code-block:: +:: =20 qemu-monitor-command domain { [--hmp] | [--pretty] [--return-value] } c= ommand... =20 @@ -7588,7 +7588,7 @@ qemu-agent-command =20 **Syntax:** =20 -.. code-block:: +:: =20 qemu-agent-command domain [--timeout seconds | --async | --block] comma= nd... =20 @@ -7606,7 +7606,7 @@ qemu-monitor-event =20 **Syntax:** =20 -.. code-block:: +:: =20 qemu-monitor-event [domain] [--event event-name] [--loop] [--timeout seconds] [--pretty] [--regex] [--no-case] @@ -7637,7 +7637,7 @@ lxc-enter-namespace =20 **Syntax:** =20 -.. code-block:: +:: =20 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 d5cb23a1c5..940a38bfce 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 t= he daemon. =20 The basic structure of most virt-admin usage is: =20 -.. code-block:: +:: =20 virt-admin [OPTION]... [ARG]... =20 @@ -107,7 +107,7 @@ help =20 **Syntax:** =20 -.. code-block:: +:: =20 help [command-or-group] =20 @@ -124,7 +124,7 @@ quit, exit =20 **Syntax:** =20 -.. code-block:: +:: =20 quit exit @@ -136,7 +136,7 @@ version =20 **Syntax:** =20 -.. code-block:: +:: =20 version =20 @@ -146,7 +146,7 @@ the version of the daemon. =20 **Example:** =20 -.. code-block:: +:: =20 $ virt-admin version Compiled against library: libvirt 1.2.21 @@ -160,7 +160,7 @@ cd =20 **Syntax:** =20 -.. code-block:: +:: =20 cd [directory] =20 @@ -175,7 +175,7 @@ pwd =20 **Syntax:** =20 -.. code-block:: +:: =20 pwd =20 @@ -187,7 +187,7 @@ connect =20 **Syntax:** =20 -.. code-block:: +:: =20 connect [URI] =20 @@ -206,7 +206,7 @@ uri =20 **Syntax:** =20 -.. code-block:: +:: =20 uri =20 @@ -230,7 +230,7 @@ server-list =20 **Syntax:** =20 -.. code-block:: +:: =20 server-list =20 @@ -243,7 +243,7 @@ daemon-log-filters =20 **Syntax:** =20 -.. code-block:: +:: =20 daemon-log-filters [--filters string] =20 @@ -264,7 +264,7 @@ space. Each filter must conform to the form described i= n detail by To define a filter which suppresses all e.g. 'virObjectUnref' DEBUG messages, use the following: =20 -.. code-block:: +:: =20 $ virt-admin daemon-log-filters "4:util.object" =20 @@ -277,7 +277,7 @@ daemon-log-outouts =20 **Syntax:** =20 -.. code-block:: +:: =20 daemon-log-outputs [--outputs string] =20 @@ -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: =20 -.. code-block:: +:: =20 $ virt-admin daemon-log-outputs "4:file:" =20 To define multiple outputs at once they need to be delimited by spaces: =20 -.. code-block:: +:: =20 $ virt-admin daemon-log-outputs "4:stderr 2:syslog:" =20 @@ -320,7 +320,7 @@ server-threadpool-info =20 **Syntax:** =20 -.. code-block:: +:: =20 server-threadpool-info server =20 @@ -355,7 +355,7 @@ that, unlike tasks carried out by normal workers, are w= ithin libvirt's full control and libvirt guarantees that such a task cannot hang, thus will alw= ays finish. An example of such a task this would be destroying a domain: =20 -.. code-block:: +:: =20 $ virsh destroy . =20 @@ -365,7 +365,7 @@ server-threadpool-set =20 **Syntax:** =20 -.. code-block:: +:: =20 server-threadpool-set server [--min-workers count] [--max-workers count= ] [--priority-workers count] =20 @@ -394,7 +394,7 @@ server-clients-info =20 **Syntax:** =20 -.. code-block:: +:: =20 server-clients-info server =20 @@ -407,7 +407,7 @@ runtime values, more specifically, the current number o= f clients connected to =20 **Example:** =20 -.. code-block:: +:: =20 # virt-admin server-clients-info libvirtd nclients_max : 120 @@ -421,7 +421,7 @@ server-clients-set =20 **Syntax:** =20 -.. code-block:: +:: =20 server-clients-set server [--max-clients count] [--max-unauth-clients c= ount] =20 @@ -447,7 +447,7 @@ server-update-tls =20 **Syntax:** =20 -.. code-block:: +:: =20 server-update-tls server =20 @@ -474,7 +474,7 @@ client-list =20 **Syntax:** =20 -.. code-block:: +:: =20 client-list server =20 @@ -488,7 +488,7 @@ client-info =20 **Syntax:** =20 -.. code-block:: +:: =20 client-info server client =20 @@ -504,7 +504,7 @@ enabled within daemon). =20 **Examples:** =20 -.. code-block:: +:: =20 # virt-admin client-info libvirtd 1 id : 1 @@ -530,7 +530,7 @@ client-disconnect =20 **Syntax:** =20 -.. code-block:: +:: =20 client-disconnect server client =20 diff --git a/docs/manpages/virt-login-shell.rst b/docs/manpages/virt-login-= shell.rst index 3833a3e912..bc0215294b 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``. =20 The basic structure of most ``virt-login-shell`` usage is: =20 -.. code-block:: +:: =20 virt-login-shell =20 @@ -58,7 +58,7 @@ By default, ``virt-login-shell`` will execute the ``/bin/= sh`` program for the user. You can modify this behaviour by defining the shell variable in ``/etc/libvirt/virt-login-shell.conf``. e.g. =20 -.. code-block:: +:: =20 shell =3D [ "/bin/bash" ] =20 @@ -68,7 +68,7 @@ detect the shell from ``/etc/password`` inside the contai= ner. This should only be done if the container has a separate ``/etc`` directory from the host, otherwise it will end up recursively invoking ``virt-login-shell``. e.g. =20 -.. code-block:: +:: =20 auto_shell =3D 1 =20 @@ -77,7 +77,7 @@ By default no users are allowed to use virt-login-shell, = if you want to allow certain users to use virt-login-shell, you need to modify the allowed_users variable in /etc/libvirt/virt-login-shell.conf. e.g. =20 -.. code-block:: +:: =20 allowed_users =3D [ "tom", "dick", "harry" ] =20 diff --git a/docs/manpages/virtlockd.rst b/docs/manpages/virtlockd.rst index ea37b25d05..8ca231d14f 100644 --- a/docs/manpages/virtlockd.rst +++ b/docs/manpages/virtlockd.rst @@ -120,14 +120,14 @@ EXAMPLES =20 To retrieve the version of ``virtlockd``: =20 -.. code-block:: +:: =20 # virtlockd --version virtlockd (libvirt) 1.1.1 =20 To start ``virtlockd``, instructing it to daemonize and create a PID file: =20 -.. code-block:: +:: =20 # virtlockd -d # ls -la @RUNSTATEDIR@/virtlockd.pid diff --git a/docs/manpages/virtlogd.rst b/docs/manpages/virtlogd.rst index edf8288230..4b749fe18e 100644 --- a/docs/manpages/virtlogd.rst +++ b/docs/manpages/virtlogd.rst @@ -121,14 +121,14 @@ EXAMPLES =20 To retrieve the version of ``virtlogd``: =20 -.. code-block:: +:: =20 # virtlogd --version virtlogd (libvirt) 1.1.1 =20 To start ``virtlogd``, instructing it to daemonize and create a PID file: =20 -.. code-block:: +:: =20 # virtlogd -d # ls -la @RUNSTATEDIR@/virtlogd.pid --=20 2.26.2