Changes between Version 1 and Version 2 of ManPageRendererPlugin


Ignore:
Timestamp:
Aug 7, 2009, 7:33:50 PM (5 years ago)
Author:
pierz
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ManPageRendererPlugin

    v1 v2  
    33== Description ==
    44
    5 A mimeviewer plugin for rendering unix (nroff) man pages to HTML so they're human readable when browsing source.
     5A plugin for rendering unix manual pages to HTML so they're human readable when browsing the repository.
     6
     7Specifically it extends the IHTMLPreviewRenderer component of the mimeviewer to pass the nroff man page through groff which generates an HTML version of the page.
    68
    79== Bugs/Feature Requests ==
     
    2123You can check out ManPageRendererPlugin from [http://trac-hacks.org/svn/manpagerendererplugin here] using Subversion, or [source:manpagerendererplugin browse the source] with Trac.
    2224
     25== Install ==
     26
     27The simplest way to install it is using easy_install:
     28{{{
     29easy_install http://trac-hacks.org/svn/ldapplugin/0.11/
     30}}}
     31This plugin uses groff so it needs to be installed on your machine (it usually is installed on most unixes) and if it is not in the usual place of /usr/bin/groff you can specify its location in the trac.ini file:
     32{{{
     33groff_path = /your_path/groff
     34}}}
     35You will need to enable it in trac.ini:
     36{{{
     37manpagerenderer.* = enabled
     38}}}
     39It will automatically render pages ending .man but if you want it to render man pages that end in .1 (or something else) then add this to [mimeviewer] section:
     40{{{
     41mime_map = application/x-troff-man:1
     42}}}
    2343== Example ==
    2444
    25 It's installed on our trac site:
    26 https://frostie.cs.ucl.ac.uk/nets/mmedia/browser/rat/trunk/man/man1/rat.1
     45See it working on our trac site:
     46http://frostie.cs.ucl.ac.uk/nets/mmedia/browser/rat/trunk/man/man1/rat.1
    2747
    2848== Recent Changes ==