shaba/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-06 17:17:56 +03:00
Code Releases Activity
2f4f381871
libvirt/docs/manpages/virt-xml-validate.rst

165 lines
3.2 KiB
ReStructuredText
Raw Normal View History

docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
=================
virt-xml-validate
=================
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
-------------------------------------------
validate libvirt XML files against a schema
-------------------------------------------
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
:Manual section: 1
:Manual group: Virtualization Support
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
.. contents::
man: Fix SYNOPSIS section Format the text properly.
2016-04-13 20:57:37 +03:00
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
SYNOPSIS
========
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
``virt-xml-validate`` *XML-FILE* [*SCHEMA-NAME*]
``virt-xml-validate`` *OPTION*
DESCRIPTION
===========
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
Validates a libvirt XML for compliance with the published schema.
The first compulsory argument is the path to the XML file to be
validated. The optional second argument is the name of the schema
to validate against. If omitted, the schema name will be inferred
from the name of the root element in the XML document.
Valid schema names currently include
virt-xml-validate: Add more XML formats support Add these XML formats validation in manpage or script: cpu, domainbackup, domaincaps, domaincheckpoint, networkport, storagepoolcaps. Signed-off-by: Han Han <hhan@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com> Signed-off-by: Ján Tomko <jtomko@redhat.com>
2022-05-11 09:18:32 +03:00
- ``cpu``
The schema for the XML format of cpu
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
- ``domainsnapshot``
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
The schema for the XML format used by domain snapshot configuration
virt-xml-validate: Add more XML formats support Add these XML formats validation in manpage or script: cpu, domainbackup, domaincaps, domaincheckpoint, networkport, storagepoolcaps. Signed-off-by: Han Han <hhan@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com> Signed-off-by: Ján Tomko <jtomko@redhat.com>
2022-05-11 09:18:32 +03:00
- ``domaincheckpoint``
The schema for the XML format used by domain checkpoint configuration
- ``domainbackup``
The schema for the XML format used by domain backup configuration
- ``domaincaps``
The schema for the XML format of domain capabilities
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
- ``domain``
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
The schema for the XML format used by guest domains configuration
virt-xml-validate: Add more XML formats support Add these XML formats validation in manpage or script: cpu, domainbackup, domaincaps, domaincheckpoint, networkport, storagepoolcaps. Signed-off-by: Han Han <hhan@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com> Signed-off-by: Ján Tomko <jtomko@redhat.com>
2022-05-11 09:18:32 +03:00
- ``networkport``
The schema for the XML format used by network port configuration
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
- ``network``
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
The schema for the XML format used by virtual network configuration
virt-xml-validate: Add more XML formats support Add these XML formats validation in manpage or script: cpu, domainbackup, domaincaps, domaincheckpoint, networkport, storagepoolcaps. Signed-off-by: Han Han <hhan@redhat.com> Reviewed-by: Ján Tomko <jtomko@redhat.com> Signed-off-by: Ján Tomko <jtomko@redhat.com>
2022-05-11 09:18:32 +03:00
- ``storagepoolcaps``
The schema for the XML format of storage pool capabilities
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
- ``storagepool``
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
The schema for the XML format used by storage pool configuration
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
- ``storagevol``
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
The schema for the XML format used by storage volume descriptions
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
- ``nodedev``
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
The schema for the XML format used by node device descriptions
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
- ``capability``
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
The schema for the XML format used to declare driver capabilities
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
- ``nwfilter``
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
The schema for the XML format used by network traffic filters
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
- ``nwfilterbinding``
virt-xml-validate: Add schema for nwfilterbinding https://bugzilla.redhat.com/show_bug.cgi?id=1600330 Add nwfilterbinding schema in virt-xml-validate for autoprobing. Add document of nwfilterbinding schema in tools/virt-xml-validate.pod. Signed-off-by: Han Han <hhan@redhat.com> Reviewed-by: John Ferlan <jferlan@redhat.com>
2018-07-13 04:39:29 +03:00
The schema for XML format used by network filter bindings.
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
- ``secret``
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
The schema for the XML format used by secrets descriptions
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
- ``interface``
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
The schema for the XML format used by physical host interfaces
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
OPTIONS
=======
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
``-h``, ``--help``
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
Display command line help usage then exit.
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
``-V``, ``--version``
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
Display version information then exit.
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
EXIT STATUS
===========
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
Upon successful validation, an exit status of 0 will be set. Upon
failure a non-zero status will be set.
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
AUTHOR
======
Daniel P. Berrangé
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
BUGS
====
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
Please report all bugs you discover. This should be done via either:
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
#. the mailing list
`https://libvirt.org/contact.html <https://libvirt.org/contact.html>`_
#. the bug tracker
`https://libvirt.org/bugs.html <https://libvirt.org/bugs.html>`_
Alternatively, you may report bugs to your software distributor / vendor.
COPYRIGHT
=========
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
Copyright (C) 2009-2013 by Red Hat, Inc.
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
Copyright (C) 2009 by Daniel P. Berrangé
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
LICENSE
=======
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
``virt-xml-validate`` is distributed under the terms of the GNU GPL v2+.
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
This is free software; see the source for copying conditions. There
is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
SEE ALSO
========
build: Extract pod from source files Instead of embedding the pod information inside the respective source files, store them in separate files. This allows us to reduce the number of custom build rules as most of the information can be inferred for the file name; moreover, text editors are more likely to use proper syntax highlighting for standalone pod files.
2016-04-12 21:32:33 +03:00
docs: convert virt-xml-validate man page from pod to rst This was a semi-automated conversion. First it was run through pod2rst, and then it was manually editted to use a rst structure that matches expectations of rst2man. Reviewed-by: Cole Robinson <crobinso@redhat.com> Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2019-10-18 17:29:47 +03:00
virsh(1), `online XML format descriptions <https://libvirt.org/format.html>`_,
`https://libvirt.org/ <https://libvirt.org/>`_
Copy Permalink