ref: 64f4cc39a0dec328a7c124ff4d766e0ece2abfa6
parent: 40d36fe28b2d961a962009f54452ba218c6a894c
author: sl <[email protected]>
date: Sat Mar 7 16:20:22 EST 2009
Minmal docs for wman.
--- /dev/null
+++ b/sites/werc.cat-v.org/apps/wman/index.md
@@ -1,0 +1,29 @@
+wman - A Web Interface to Man Pages
+===================================
+
+Wman is an app that allows you to export Unix and Plan 9-style man pages. It
+can do this directly, without need to generate static html versions and will
+automatically pick updates and new man pages.
+
+It is also fairly smart in generating links for man page references.
+
+Configuration
+-------------
+
+To display a collection of man pages in a desired path you can use the following config directive:
+
+ conf_wman_enable /usr/share/man
+
+This will allow you to browse the man pages under /usr/share/man.
+
+Demo
+----
+
+For a demo of this app see [man.cat-v.org](http://man.cat-v.org).
+
+TODO
+----
+
+* We don't handle compressed man pages, but this should be trivial to add.
+* Unix systems might use different macros for their man pages.
+* Search (using keywords? Google? grep?)