From 578a3111a34e7f1bec5bdccec7819619d9ebb83c Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Tue, 5 Jan 2016 12:26:10 +0100 Subject: [PATCH] add hint about -synopsis.adoc files --- README.adoc | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.adoc b/README.adoc index a24c9dc..dbd0410 100644 --- a/README.adoc +++ b/README.adoc @@ -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'). +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 --------- -- 2.39.2