2016-01-05 09:32:41 +01:00
Proxmox VE Documentation
========================
What is this?
-------------
This is an experimental project, trying to generate high quality
2016-01-05 12:15:13 +01:00
documentation for http://www.proxmox.com[Proxmox VE]. We choose to use
http://www.methods.co.nz/asciidoc/[AsciiDoc] as base format.
One idea is to generate high quality manual pages, and assemble them
into a complete book, called link:pve-admin-guide.adoc[Proxmox VE
Administration Guide]. So we have one source, and generate several
documents from that. It is also possible to generate printable PDF
files, or ebook formats ('.ebup').
2016-01-05 09:32:41 +01:00
2016-01-05 12:26:10 +01:00
Autogenerated CLI Command Synopsis
----------------------------------
We generate the command line synopsis for all manual pages
automatically. We can do that, because we have a full declarative
definition of the {pve} API. I added those generated files
('*-synopsis.adoc') to the git repository, so that it is possible to
build the documentation without having a fully installed {pve}
development environment.
2016-01-05 09:32:41 +01:00
Copyright
---------
2016-01-05 16:47:42 +01:00
Copyright (C) 2016 Proxmox Server Solutions Gmbh
2016-01-05 09:32:41 +01:00
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
2016-01-05 16:21:17 +01:00
Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
copy of the license is included in the link:LICENSE[LICENSE] file.
