From: Guest section DW <dwguest@win.tue.nl>
To: Lukas Ruf <ruf@tik.ee.ethz.ch>,
Linux Kernel ml <linux-kernel@vger.kernel.org>
Subject: Re: man pages: howto create a man page ?
Date: Fri, 14 Sep 2001 19:36:28 +0200 [thread overview]
Message-ID: <20010914193628.A27889@win.tue.nl> (raw)
In-Reply-To: <20010914161004.C8351@tik.ee.ethz.ch>
In-Reply-To: <20010914161004.C8351@tik.ee.ethz.ch>; from Lukas Ruf on Fri, Sep 14, 2001 at 04:10:04PM +0200
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 "" ""
.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.
prev parent reply other threads:[~2001-09-14 17:36 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2001-09-14 14:10 man pages: howto create a man page ? Lukas Ruf
2001-09-14 17:36 ` Guest section DW [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20010914193628.A27889@win.tue.nl \
--to=dwguest@win.tue.nl \
--cc=linux-kernel@vger.kernel.org \
--cc=ruf@tik.ee.ethz.ch \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).