summaryrefslogtreecommitdiff
path: root/tools/make-man-rules.py
diff options
context:
space:
mode:
Diffstat (limited to 'tools/make-man-rules.py')
-rw-r--r--tools/make-man-rules.py12
1 files changed, 10 insertions, 2 deletions
diff --git a/tools/make-man-rules.py b/tools/make-man-rules.py
index 6224de3cc0..9f46f7b889 100644
--- a/tools/make-man-rules.py
+++ b/tools/make-man-rules.py
@@ -42,8 +42,14 @@ endif
HEADER = '''\
# Do not edit. Generated by make-man-rules.py.
-# Regenerate with 'make all update-man-list'.
-
+# To regenerate:
+# 1. Create, update, or remove source .xml files in man/
+# 2. Run 'make update-man-list'
+# 3. Run 'make man' to generate manpages
+#
+# To make a man page conditional on a configure switch add
+# attribute conditional="ENABLE_WHAT" or conditional="WITH_WHAT"
+# to <refentry> element.
'''
HTML_ALIAS_RULE = '''\
@@ -53,6 +59,8 @@ HTML_ALIAS_RULE = '''\
FOOTER = '''\
+# Really, do not edit this file.
+
EXTRA_DIST += \\
{files}
'''