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
5b7e88322d
libvirt/docs/virshcmdref.html.in

76 lines
2.7 KiB
HTML
Raw Normal View History

Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
<?xml version="1.0" encoding="UTF-8"?>
docs: switch to using HTML5 doctype declaration The HTML5 doctype is simply <!DOCTYPE html> no DTD is present because HTML5 is no longer defined as an extension of SGML. XSL has no way to natively output a doctype without a public or system identifier, so we have to use an <xsl:text> hack instead. See also https://dev.w3.org/html5/html-author/#doctype-declaration Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 17:01:25 +00:00
<!DOCTYPE html>
Fix multiple formatting problems in HTML docs The rule generating the HTML docs passing the --html flag to xsltproc. This makes it use the legacy HTML parser, which either ignores or tries to fix all sorts of broken XML tags. There's no reason why we should be writing broken XML in the first place, so removing --html and adding the XHTML doctype to all files forces us to create good XML. This adds the XHTML doc type and fixes many, many XML tag problems it exposes. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-05-03 14:25:37 +00:00
<html xmlns="http://www.w3.org/1999/xhtml">
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
<body>
<h1>Virsh Command Reference</h1>
<ul id="toc"></ul>
docs: switch to using 'id' attribute instead of 'name' for links The 'name' attribute on <a...> elements is deprecated in favour of the 'id' attribute which is allowed on any element. HTML5 drops 'name' support entirely. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 14:52:42 +00:00
<h2><a id="description">Description</a></h2>
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
<p>
The new <b>Virsh Command Reference</b>, for documenting the commands
in virsh, has recently been started. Only covering the Virtual
Networking commands initially, it will expand to cover all virsh
commands over time.
</p>
<p>
If you would like to assist, content contributions are gladly accepted.
Please email <a href="mailto:jclift@redhat.com">Justin Clift</a>
directly, or get in contact through any of the
<a href="contact.html">official libvirt mailing lists</a>.
</p>
docs: switch to using 'id' attribute instead of 'name' for links The 'name' attribute on <a...> elements is deprecated in favour of the 'id' attribute which is allowed on any element. HTML5 drops 'name' support entirely. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 14:52:42 +00:00
<h2><a id="viewing">Viewing Online</a></h2>
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
<p>
The latest version can be viewed directly online:
</p>
<ul>
<li>
Use https:// links for most sites This adds a rule to require https links for the libvirt, qemu and kvm websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-10-13 15:30:41 +00:00
<a href="https://libvirt.org/sources/virshcmdref/html/">Standard HTML format, multiple pages</a>
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
</li>
<li>
Use https:// links for most sites This adds a rule to require https links for the libvirt, qemu and kvm websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-10-13 15:30:41 +00:00
<a href="https://libvirt.org/sources/virshcmdref/html-single/">HTML format, one long page</a>
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
</li>
</ul>
docs: switch to using 'id' attribute instead of 'name' for links The 'name' attribute on <a...> elements is deprecated in favour of the 'id' attribute which is allowed on any element. HTML5 drops 'name' support entirely. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 14:52:42 +00:00
<h2><a id="downloading">Downloading</a></h2>
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
<p>
docs: trivial typo fix
2010-11-12 17:34:26 +00:00
The latest version of the Virsh Command Reference can be downloaded:
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
</p>
<ul>
<li>
Standard HTML format, multiple pages
Use https:// links for most sites This adds a rule to require https links for the libvirt, qemu and kvm websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-10-13 15:30:41 +00:00
(<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1-html-multi-page.tar.gz">.tar.gz</a>)
(<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1-html-multi-page.tar.bz2">.tar.bz2</a>)
(<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1-html-multi-page.zip">.zip</a>)
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
</li>
<li>
HTML format, one long page
Use https:// links for most sites This adds a rule to require https links for the libvirt, qemu and kvm websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-10-13 15:30:41 +00:00
(<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1-html-single.tar.gz">.tar.gz</a>)
(<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1-html-single.tar.bz2">.tar.bz2</a>)
(<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1-html-single.zip">.zip</a>)
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
</li>
<li>
Use https:// links for most sites This adds a rule to require https links for the libvirt, qemu and kvm websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-10-13 15:30:41 +00:00
<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1.pdf">PDF format</a>
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
</li>
<li>
Use https:// links for most sites This adds a rule to require https links for the libvirt, qemu and kvm websites. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-10-13 15:30:41 +00:00
<a href="https://libvirt.org/sources/virshcmdref/Virsh_Command_Reference-0.8.7-1.epub">ePub format</a>
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
</li>
</ul>
docs: switch to using 'id' attribute instead of 'name' for links The 'name' attribute on <a...> elements is deprecated in favour of the 'id' attribute which is allowed on any element. HTML5 drops 'name' support entirely. Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2017-07-26 14:52:42 +00:00
<h2><a id="git">DocBook source GIT repository</a></h2>
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
<p>
docs: virshcmdref: change repo URL to GitLab Also note that it's archived, because it's definitely not maintained anymore. Signed-off-by: Ján Tomko <jtomko@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-06-03 10:40:09 +00:00
The DocBook source is archived in a <a
Prefer https: everywhere where possible Use https: links for websites that support them. The URIs which are used as namespace identifiers are left alone. Signed-off-by: Ján Tomko <jtomko@redhat.com> Reviewed-by: Erik Skultety <eskultet@redhat.com> Reviewed-by: Neal Gompa <ngompa13@gmail.com>
2020-08-25 22:44:00 +00:00
href="https://git-scm.com/">git</a> repository available on
docs: virshcmdref: change repo URL to GitLab Also note that it's archived, because it's definitely not maintained anymore. Signed-off-by: Ján Tomko <jtomko@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
2020-06-03 10:40:09 +00:00
<a href="https://gitlab.com/libvirt/libvirt-virshcmdref">gitlab.com</a>.
docs: added virsh command reference page. Using temporary location links for the moment, until we get a proper place to store the files on the libvirt.org server.
2010-11-12 16:40:38 +00:00
</p>
</body>
</html>
Reference in New Issue Copy Permalink