summaryrefslogtreecommitdiff
path: root/tools/make-man-rules.py
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2014-03-06 23:24:30 -0500
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2014-03-06 23:24:30 -0500
commitd86dd07d462fb8502b1c7b4a9a4df4fba8318bdd (patch)
tree4642d07201bd9d3c5074868e2397f0a9a11418b3 /tools/make-man-rules.py
parenteffbc8e4f70fc70e4a4a8a1dc77228dd187f9c22 (diff)
build-sys: update intructions for Makefile-man.am regeneration
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}
'''