wiki:ManPageRendererPlugin

Unix Manual page renderer

Description

This is 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, it is 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 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 https://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 also need to enable this plugin in your trac.ini file:

[components]
manpagerenderer.* = enabled

It will automatically render pages ending in .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

6358 by pierz on 2009-08-11 11:58:54
Added url entry to point to homepage http://trac-hacks.org/wiki/ManPageRendererPlugin
6347 by pierz on 2009-08-07 19:10:20
Commit of initial revision - tested ok on 0.9.4 system
6346 by pierz on 2009-08-07 18:53:36
Check in of intial version
(more)

Author/Contributors

Author: Piers O'Hanlon
Maintainer: Piers O'Hanlon
Contributors:

Last modified 4 months ago Last modified on Mar 25, 2016, 3:24:36 PM