External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-11-05 12:51:12 +00:00
Code Issues Packages Projects Releases Wiki Activity
1429542725
libvirt/tools/virt-xml-validate.pod

112 lines
2.4 KiB
Plaintext
Raw Normal View History

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 18:32:33 +00:00
=head1 NAME
man: Fix NAME section podchecker(1) complained about these, eg. *** WARNING: Verbatim paragraph in NAME section at line 3 in file tools/virt-host-validate.pod
2016-04-13 17:34:01 +00:00
virt-xml-validate - 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 18:32:33 +00:00
=head1 SYNOPSIS
man: Fix SYNOPSIS section Format the text properly.
2016-04-13 17:57:37 +00:00
B<virt-xml-validate> I<XML-FILE> [I<SCHEMA-NAME>]
B<virt-xml-validate> I<OPTION>
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 18:32:33 +00:00
=head1 DESCRIPTION
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
=over 4
=item C<domainsnapshot>
The schema for the XML format used by domain snapshot configuration
=item C<domain>
The schema for the XML format used by guest domains configuration
=item C<network>
The schema for the XML format used by virtual network configuration
=item C<storagepool>
The schema for the XML format used by storage pool configuration
=item C<storagevol>
The schema for the XML format used by storage volume descriptions
=item C<nodedev>
The schema for the XML format used by node device descriptions
=item C<capability>
The schema for the XML format used to declare driver capabilities
=item C<nwfilter>
The schema for the XML format used by network traffic filters
=item C<secret>
The schema for the XML format used by secrets descriptions
=item C<interface>
The schema for the XML format used by physical host interfaces
=back
=head1 OPTIONS
=over
=item B<-h, --help>
Display command line help usage then exit.
=item B<-V, --version>
Display version information then exit.
=back
=head1 EXIT STATUS
Upon successful validation, an exit status of 0 will be set. Upon
failure a non-zero status will be set.
=head1 AUTHOR
Daniel P.Berrange
=head1 BUGS
Report any bugs discovered to the libvirt community via the
man: Fix links Use L<> instead of C<> for URLs and man pages.
2016-04-13 17:46:06 +00:00
mailing list L<http://libvirt.org/contact.html> or bug tracker
L<http://libvirt.org/bugs.html>.
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 18:32:33 +00:00
Alternatively report bugs to your software distributor / vendor.
=head1 COPYRIGHT
Copyright (C) 2009-2013 by Red Hat, Inc.
Copyright (C) 2009 by Daniel P. Berrange
=head1 LICENSE
virt-xml-validate is distributed under the terms of the GNU GPL v2+.
This is free software; see the source for copying conditions. There
is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE
=head1 SEE ALSO
man: Fix links Use L<> instead of C<> for URLs and man pages.
2016-04-13 17:46:06 +00:00
L<virsh(1)>, online XML format descriptions L<http://libvirt.org/format.html>
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 18:32:33 +00:00
=cut
Reference in New Issue Copy Permalink