add hint about -synopsis.adoc files
[pve-docs.git] / README.adoc
CommitLineData
22b0b166
DM
1Proxmox VE Documentation
2========================
3
4What is this?
5-------------
6
7This is an experimental project, trying to generate high quality
a1ada598
DM
8documentation for http://www.proxmox.com[Proxmox VE]. We choose to use
9http://www.methods.co.nz/asciidoc/[AsciiDoc] as base format.
10
11One idea is to generate high quality manual pages, and assemble them
12into a complete book, called link:pve-admin-guide.adoc[Proxmox VE
13Administration Guide]. So we have one source, and generate several
14documents from that. It is also possible to generate printable PDF
15files, or ebook formats ('.ebup').
22b0b166 16
578a3111
DM
17Autogenerated CLI Command Synopsis
18----------------------------------
19
20We generate the command line synopsis for all manual pages
21automatically. We can do that, because we have a full declarative
22definition of the {pve} API. I added those generated files
23('*-synopsis.adoc') to the git repository, so that it is possible to
24build the documentation without having a fully installed {pve}
25development environment.
22b0b166
DM
26
27Copyright
28---------
29
30Copyright (C) Proxmox Server Solutions Gmbh
31
32Permission is granted to copy, distribute and/or modify this document
33under the terms of the GNU Free Documentation License, Version 1.3 or
34any later version published by the Free Software Foundation; with no
35Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
36copy of the license is included in the section entitled "GNU Free
37Documentation License".