[lkml]   [2001]   [Sep]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
Messages in this thread
SubjectRe: man pages: howto create a man page ?
On Fri, Sep 14, 2001 at 04:10:04PM +0200, Lukas Ruf wrote:

> 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 "" ""
example \- how to write a man page
how to invoke
what it does
what it returns
interesting tidbits
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.

To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to
More majordomo info at
Please read the FAQ at

 \ /
  Last update: 2005-03-22 13:03    [W:0.049 / U:2.456 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site