openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: use "::" instead of ".. code-block::" 

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.

Reviewed-by: Erik Skultety <eskultet@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Daniel P. Berrangé 2020-10-05 11:27:44 +01:00
parent 4d36554716
commit a7464a3f01
6 changed files with 327 additions and 327 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/manpages/libvirtd.rst
View File

@ -199,7 +199,7 @@ EXAMPLES
To retrieve the version of libvirtd:
.. 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::
::
# libvirtd -d
# ls -la @RUNSTATEDIR@/libvirtd.pid

582
docs/manpages/virsh.rst
View File

File diff suppressed because it is too large Load Diff

52
docs/manpages/virt-admin.rst
View File

@ -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::
::
virt-admin [OPTION]... <command> [ARG]...
@ -107,7 +107,7 @@ help
**Syntax:**
.. code-block::
::
help [command-or-group]
@ -124,7 +124,7 @@ quit, exit
**Syntax:**
.. code-block::
::
quit
exit
@ -136,7 +136,7 @@ version
**Syntax:**
.. code-block::
::
version
@ -146,7 +146,7 @@ the version of the daemon.
**Example:**
.. code-block::
::
$ virt-admin version
Compiled against library: libvirt 1.2.21
@ -160,7 +160,7 @@ cd
**Syntax:**
.. code-block::
::
cd [directory]
@ -175,7 +175,7 @@ pwd
**Syntax:**
.. code-block::
::
pwd
@ -187,7 +187,7 @@ connect
**Syntax:**
.. code-block::
::
connect [URI]
@ -206,7 +206,7 @@ uri
**Syntax:**
.. code-block::
::
uri
@ -230,7 +230,7 @@ server-list
**Syntax:**
.. code-block::
::
server-list
@ -243,7 +243,7 @@ daemon-log-filters
**Syntax:**
.. 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::
::
$ virt-admin daemon-log-filters "4:util.object"
@ -277,7 +277,7 @@ daemon-log-outouts
**Syntax:**
.. 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::
::
$ 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::
::
$ virt-admin daemon-log-outputs "4:stderr 2:syslog:<msg_ident>"
@ -320,7 +320,7 @@ server-threadpool-info
**Syntax:**
.. 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::
::
$ virsh destroy <domain>.
@ -365,7 +365,7 @@ server-threadpool-set
**Syntax:**
.. 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::
::
server-clients-info server
@ -407,7 +407,7 @@ runtime values, more specifically, the current number of clients connected to
**Example:**
.. code-block::
::
# virt-admin server-clients-info libvirtd
nclients_max : 120
@ -421,7 +421,7 @@ server-clients-set
**Syntax:**
.. code-block::
::
server-clients-set server [--max-clients count] [--max-unauth-clients count]
@ -447,7 +447,7 @@ server-update-tls
**Syntax:**
.. code-block::
::
server-update-tls server
@ -474,7 +474,7 @@ client-list
**Syntax:**
.. code-block::
::
client-list server
@ -488,7 +488,7 @@ client-info
**Syntax:**
.. code-block::
::
client-info server client
@ -504,7 +504,7 @@ enabled within daemon).
**Examples:**
.. code-block::
::
# virt-admin client-info libvirtd 1
id : 1
@ -530,7 +530,7 @@ client-disconnect
**Syntax:**
.. code-block::
::
client-disconnect server client

8
docs/manpages/virt-login-shell.rst
View File

@ -29,7 +29,7 @@ configured in ``/etc/libvirt/virt-login-shell.conf``.
The basic structure of most ``virt-login-shell`` usage is:
.. code-block::
::
virt-login-shell
@ -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.
.. code-block::
::
shell = [ "/bin/bash" ]
@ -68,7 +68,7 @@ detect the shell from ``/etc/password`` inside the container. 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.
.. code-block::
::
auto_shell = 1
@ -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.
.. code-block::
::
allowed_users = [ "tom", "dick", "harry" ]

4
docs/manpages/virtlockd.rst
View File

@ -120,14 +120,14 @@ EXAMPLES
To retrieve the version of ``virtlockd``:
.. code-block::
::
# virtlockd --version
virtlockd (libvirt) 1.1.1
To start ``virtlockd``, instructing it to daemonize and create a PID file:
.. code-block::
::
# virtlockd -d
# ls -la @RUNSTATEDIR@/virtlockd.pid

4
docs/manpages/virtlogd.rst
View File

@ -121,14 +121,14 @@ EXAMPLES
To retrieve the version of ``virtlogd``:
.. code-block::
::
# virtlogd --version
virtlogd (libvirt) 1.1.1
To start ``virtlogd``, instructing it to daemonize and create a PID file:
.. code-block::
::
# virtlogd -d
# ls -la @RUNSTATEDIR@/virtlogd.pid