werc-1.5.0-tweaks

Tweaks for the werc website builder created by the mad architect Uriel
Log | Files | Refs | README

index.md (1179B)


      1 wman - A Web Interface to Man Pages
      2 ===================================
      3 
      4 Wman is an app that allows you to export Unix and Plan 9-style man pages. It
      5 can do this directly, without need to generate static html versions and will
      6 automatically pick updates and new man pages.
      7 
      8 It is also fairly smart in generating links for man page references.
      9 
     10 Configuration
     11 -------------
     12 
     13 To display a collection of man pages in a desired path you can use the following config directive:
     14 
     15     conf_enable_wman /usr/share/man
     16 
     17 This will allow you to browse the man pages under /usr/share/man.
     18 
     19 For man pages organized in the traditional unix structure `manN/foo.N` where N is the section number, set in your config file:
     20 
     21     wman_unix_mode=1
     22 
     23 Demo
     24 ----
     25 
     26 For a demo of this app see [man.cat-v.org](http://man.cat-v.org).
     27 
     28 TODO
     29 ----
     30 
     31 * We don't handle compressed man pages, but this should be trivial to add.
     32 * Unix systems might use different macros for their man pages.
     33 * Search (using keywords? Google? grep?)
     34 * Inferno contains man pages named like 'foo-0intro', which are refered as foo-intro(X), should automatically add (or remove) the extra '0' (Examples: sys-intro(2) and draw-intro(2)).