Update README with description of --generate-manpage.

1 files changed, 20 insertions, 0 deletions

diff --git a/README b/README
index 6a69374..240ed98 100644
--- a/README
+++ b/README
@@ -67,6 +67,26 @@ It can also run the rest of the code under the Python profiler,
 if the appropriate environment variable is set.
 
 
+Manual pages
+------------
+
+A high quality manual page probably needs to be written from
+scratch. For example, the description of each option in a manual
+page should usually be longer than what is suitable for
+`--help` output. However, it is tedious to write option
+descriptions many times.
+
+`cliapp` provides a way to fill in a manual page template, in
+**troff**(1) format, with information about all options. This
+allows you to write the rest of the manual page without having
+to remember to update all options. This is a compromise between
+ease-of-development and manual page quality.
+
+To use this, use the `--generate-manpage=TEMPLATE` option,
+where `TEMPLATE` is the name of the template file. See
+`example.1` for an example.
+
+
 Legalese
 --------