add hint about -synopsis.adoc files
authorDietmar Maurer <dietmar@proxmox.com>
Tue, 5 Jan 2016 11:26:10 +0000 (12:26 +0100)
committerDietmar Maurer <dietmar@proxmox.com>
Tue, 5 Jan 2016 11:26:10 +0000 (12:26 +0100)
README.adoc

index a24c9dcf0eb03538702592687295877068615b06..dbd04106402ccd8e2868dadc0c1f7b4b81b7659b 100644 (file)
@@ -14,6 +14,15 @@ 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').
 
 documents from that. It is also possible to generate printable PDF
 files, or ebook formats ('.ebup').
 
+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.
 
 Copyright
 ---------
 
 Copyright
 ---------