[[PageOutline(2-5,Contents,pullout)]] = 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 [t:#7067 new enhancement to Trac], it is currently hosted on trac-hacks. == Bugs/Feature Requests Existing bugs and feature requests for ManPageRendererPlugin are [report:9?COMPONENT=ManPageRendererPlugin here]. If you have any issues, create a [/newticket?component=ManPageRendererPlugin new ticket]. [[TicketQuery(component=ManPageRendererPlugin&group=type,format=progress)]] == Download Download the zipped source from [export:manpagerendererplugin here]. == Source You can check out ManPageRendererPlugin from [/svn/manpagerendererplugin here] using Subversion, or [source:manpagerendererplugin browse the source] with Trac. == Installation The simplest way to install it is using `easy_install`: {{{#!sh 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: {{{#!ini groff_path = /your_path/groff }}} You will also need to enable this plugin in your `trac.ini` file: {{{#!ini [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: {{{#!ini [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. == Recent Changes [[ChangeLog(manpagerendererplugin, 3)]] == Author/Contributors '''Author:''' Piers O'Hanlon [[BR]] '''Maintainer:''' [[Maintainer]] [[BR]] '''Contributors:'''