SpecialManPage: Difference between revisions
from HTYP, the free directory anyone can edit if they can prove to me that they're not a spambot
|
|
| Line 1: |
Line 1: |
| <hide>
| | {{to wooz|MWX/ManPage}} |
| [[page type::article]]
| |
| [[page type::project]]
| |
| [[thing type::software]]
| |
| [[thing type::MediaWiki extension]]
| |
| [[license::open source]]
| |
| [[platform::MediaWiki]]
| |
| [[author::User:Woozle]]
| |
| </hide>
| |
| ==About==
| |
| [[SpecialManPage]] is a simple extension for [[MediaWiki]] which allows any [[manpage]] (of those installed on the web site's server) to be displayed within the wiki as a Special page, which is often more readable than the standard terminal-based display. It makes use of the "{{l/manpage|man}}" command's "--html" option which displays output in [[HTML]] instead of fixed-pitch [[plaintext]]. The page to display is requested within the URL.
| |
| | |
| '''Requires''': [[groff]] (see [[#Troubleshooting]], below)
| |
| | |
| Some examples:
| |
| * {{l/manpage|cat}}
| |
| * {{l/manpage|ssh}}
| |
| * {{l/manpage|telnet}}
| |
| | |
| Manpage contents can also be transcluded, but this may not be particularly useful until some features are added for extracting partial content of manpages rather than returning the entire thing.
| |
| ==Links==
| |
| * [https://github.com/woozalia/Special-ManPage GitHub repository]
| |
| ==Troubleshooting==
| |
| If you get a blank page (no errors but no manpage either), make sure [[groff]] is installed. The {{l/linux/cmd|man}} command uses groff for HTML formatting.
| |
| ==Future==
| |
| Planned features:
| |
| * option to return just a summary
| |
| * search manpages by topic or content
| |
| * list available manpages
| |
| * support for crosslinks to other manpages (not sure this is possible)
| |
| * [[texinfo]] support
| |
Latest revision as of 00:57, 17 April 2022
