Changes between Version 1 and Version 2 of ManPageRendererPlugin

Timestamp:

Aug 7, 2009, 5:33:50 PM (15 years ago)

Author:

Piers O'Hanlon

Comment:

--

ManPageRendererPlugin

@@ -3 +3 @@
 == Description ==
 
-A mimeviewer plugin for rendering unix (nroff) man pages to HTML so they're human readable when browsing source.
+A plugin for rendering unix manual pages to HTML so they're human readable when browsing the repository. 
+
+Specifically it extends the IHTMLPreviewRenderer component of the mimeviewer to pass the nroff man page through groff which generates an HTML version of the page.
 
 == Bugs/Feature Requests == 
@@ -21 +23 @@
 You can check out ManPageRendererPlugin from [http://trac-hacks.org/svn/manpagerendererplugin here] using Subversion, or [source:manpagerendererplugin browse the source] with Trac.
 
+== Install ==
+
+The simplest way to install it is using easy_install:
+{{{
+easy_install http://trac-hacks.org/svn/ldapplugin/0.11/
+}}}
+This 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:
+{{{
+groff_path = /your_path/groff
+}}}
+You will need to enable it in trac.ini:
+{{{
+manpagerenderer.* = enabled
+}}}
+It 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:
+{{{
+mime_map = application/x-troff-man:1
+}}}
 == Example ==
 
-It's installed on our trac site:
-https://frostie.cs.ucl.ac.uk/nets/mmedia/browser/rat/trunk/man/man1/rat.1
+See it working on our trac site:
+http://frostie.cs.ucl.ac.uk/nets/mmedia/browser/rat/trunk/man/man1/rat.1
 
 == Recent Changes ==