man pages: howto create a man page ?
Dear all,
can anyone give me a hint what the easiest way could be to create a man page out of some text? Is there a latex to man page converter around? Is it required that I must learn SGML?
Thanks for any hint,
Signature · 6 lines
Lukas Ruf Swiss Federal Institute of Technology Office: ETZ-G61.2 Computer Engineering and Phone: +41/1/632 7312 Networks Laboratory (TIK) Fax: +41/1/632 1035 ETH Zentrum PGP 2.6: ID D20BA2ED; Gloriastr. 35 Fingerprint 6323 B9BC 9C8E 6563 B477 BADD FEA6 E6B7 CH-8092 Zurich
Quoted 3 lines · Lukas Ruf
can anyone give me a hint what the easiest way could be to create a man page out of some text? Is there a latex to man page converter around? Is it required that I must learn SGML?
Old-fashioned man pages are written in *roff.
For example,
.TH example 0 2001-09-14 "" ""
.SH NAME
example \- how to write a man page
.SH SYNOPSIS
how to invoke
.SH DESCRIPTION
what it does
.SH "RETURN VALUE"
what it returns
.SH "CONFORMING TO"
standards
.SH NOTES
interesting tidbits
.SH "SEE ALSO"
related stuff
In man(7) you can read about the macros used. The easiest way to start is to copy some other man page.
These days it is frowned upon if you really use detailed knowledge of *roff. Man pages are produced by conversion from other formats, and conversely other formats are produced by conversion from *roff (e.g., by man2html). Knowing more about *roff than what is documented in man(7) may be bad for you - these automatic converters have only a limited knowledge.