summaryrefslogtreecommitdiffstats
path: root/misc/doclifter/README
diff options
context:
space:
mode:
Diffstat (limited to 'misc/doclifter/README')
-rw-r--r--misc/doclifter/README19
1 files changed, 13 insertions, 6 deletions
diff --git a/misc/doclifter/README b/misc/doclifter/README
index be6e5ab4be..acbba9eb69 100644
--- a/misc/doclifter/README
+++ b/misc/doclifter/README
@@ -1,12 +1,19 @@
-doclifter lifts documents in nroff markups to XML-DocBook.
+doclifter (convert nroff markup to XML-DocBook)
This package ships two Python scripts:
-_doclifter translates documents written in troff macros like man pages to
- DocBook, that can then be converted to other formats or translated.
-_manlifter is a mass-conversion script and test harness for doclifter.
- It can find and convert _all_ man pages in your system with one simple
- command, but in a few cases.
+
+- doclifter translates documents written in troff macros (like man
+ pages) to DocBook, that can then be converted to other formats or
+ translated.
+
+- manlifter is a mass-conversion script and test harness for doclifter.
+ It can find and convert _all_ man pages in your system with one simple
+ command.
See the man pages, also in HTML format in /usr/doc/docfilter*/html
docfilter's author is Eric S. Raymond.
+
+Optional runtime dependency: plotutils. This is required for
+converting PIC diagrams to SVG. Not many man pages actually require
+this.