md2roff - converts markdown documents to roff (man, mdoc, mm, mom).
md2roff [OPTION]... [FILE]...
md2roff converts the input files to groff (with man package) format
and prints the result to stdout. If the FILE is - then it reads
from stdin.
displays a short-help text and exits
displays the program version, copyright and license information and exists.
use man package (linux man pages, default), see groff_man 7
use mm package, see groff_mm 7
use mdoc package (BSD man pages), see groff_mdoc 7
use mom package, see groff_mom 7
- If the documents starts with
#then creates the TH command with this; otherwise there will be a default TH with the file-name. Actually only the title (name) and section are required.
# title section date source manual
- If you write man page, use
####for each option to automatically convert the section to '.TP' as in GNU's manuals. - Use special link type (man) to link man pages.
A lot. Fix and send.
View a markdown as console man page:
$ md2roff mytext.md | groff -Tutf8 -man | $PAGER
View a markdown as postscript man page:
$ md2roff mytext.md | groff -Tps -man | okular -
This document is example, its written in markdown and produce a nice man page.
Copyright (C) 2017 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later (http://gnu.org/licenses/gpl.html). This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.
Written by Nicholas Christopoulos ([email protected]).
groff_man 7, man-pages 7, groff_man 7, groff_mdoc 7, groff_mm 7, groff_mom 7.