aboutsummaryrefslogtreecommitdiff
path: root/system/mandoc/README
diff options
context:
space:
mode:
authorLEVAI Daniel <leva@ecentrum.hu>2018-05-23 07:16:52 +0700
committerWilly Sudiarto Raharjo <willysr@slackbuilds.org>2018-05-23 07:16:52 +0700
commit28740cdccd206506496bc19086fe8be292004abb (patch)
treed24e02860e06559dea8011a08d9a1f8cf1fbc84b /system/mandoc/README
parentf963dff46357e094aa1de271f18f463e49e6a1b7 (diff)
system/mandoc: Added (UNIX manpage compiler).
Signed-off-by: Willy Sudiarto Raharjo <willysr@slackbuilds.org>
Diffstat (limited to 'system/mandoc/README')
-rw-r--r--system/mandoc/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/system/mandoc/README b/system/mandoc/README
new file mode 100644
index 0000000000000..4d7be3acbc125
--- /dev/null
+++ b/system/mandoc/README
@@ -0,0 +1,20 @@
+mandoc is a suite of tools compiling mandoc, the roff macro package of choice for
+BSD manual pages, and man, the predominant historical package for UNIX manuals.
+It is small, ISO C, ISC-licensed, and quite fast.
+
+The tool set features mandoc, based on the libmandoc validating compiler, to
+format output for UNIX terminals (with support for wide-character locales),
+XHTML, HTML, PostScript, and PDF. It also includes preconv, for recoding
+multibyte manuals; demandoc, for emitting only text parts of manuals; mandocdb,
+for indexing manuals; and apropos, whatis, and man.cgi (via catman) for
+semantic search of manual content.
+
+There is an environment variable called REPLACE_MAN, that if set to a non-empty
+string, will instruct the slackbuild script to replace the stock man package
+(you should remove(pkg) it first, though).
+
+After installing, make sure to (re)create the mandoc specific "whatis"
+database(s) in your manpath(s), eg.:
+# mandocdb /usr/man /usr/local/man
+... or, if you've chosen to replace man, then:
+# makewhatis /usr/man /usr/local/man