| Version 7 (modified by , 9 years ago) (diff) |
|---|
Contents
Unix Manual page renderer
Description
A plugin for rendering unix manual pages to HTML, so they are 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.
Originally submitted as a new enhancement to Trac, but currently hosted on trac-hacks.
Bugs/Feature Requests
Existing bugs and feature requests for ManPageRendererPlugin are here.
If you have any issues, create a new ticket.
Download
Download the zipped source from [download:manpagerendererplugin here].
Source
You can check out ManPageRendererPlugin from here using Subversion, or browse the source with Trac.
Installation
The simplest way to install it is using easy_install:
easy_install http://trac-hacks.org/svn/manpagerendererplugin/0.11/
This plugin uses groff, so it needs to be installed on your machine, usually installed as a standard on most unixes. If it is not in the usual place of /usr/bin/groff, you can specify its location in your trac.ini file:
groff_path = /your_path/groff
You will need also to enable this plugin in your trac.ini file:
[components] 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:
[mimeviewer] mime_map = application/x-troff-man:1
You can set svn:mime-type property to application/x-troff-man for specific files you want to have rendered by the plugin.
Example
See it working on our Trac site: http://frostie.cs.ucl.ac.uk/nets/mmedia/browser/rat/trunk/man/man1/rat.1
Recent Changes
Author/Contributors
Author: Piers O'Hanlon
Maintainer: Piers O'Hanlon
Contributors:
