Am Dienstag, den 22.08.2006, 00:03 +0200 schrieb Daniel Leidert:

[resulting manpage]
> Seems I forgot it. Now it is attached too.

Argh. Now it is.

Regards, Daniel
.\"     Title: FOO
.\"    Author: John Doe <[EMAIL PROTECTED]>
.\" Generator: DocBook XSL Stylesheets v1.70.1 <http://docbook.sf.net/>
.\"      Date: 2006.08.17
.\"    Manual: foo User Manual
.\"    Source: foo
.\"
.TH "FOO" "1" "2006\-08\-17" "foo" "foo User Manual"
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
foo \- program to do something
.SH "SYNOPSIS"
.HP 4
\fBfoo\fR \fB\-e\ \fR\fB\fIthis\fR\fR [\fB\-\-example=\fR\fB\fIthat\fR\fR] [{\fB\-e\fR\ |\ \fB\-\-example\fR}\ \fIthis\fR] [{\fB\-e\fR\ |\ \fB\-\-example\fR}\ {\fIthis\fR\ |\ \fIthat\fR}]
.HP 4
\fBfoo\fR [{\fB\-h\fR\ |\ \fB\-\-help\fR} | {\fB\-v\fR\ |\ \fB\-\-version\fR}]
.SH "DESCRIPTION"
.PP
This manual page documents briefly the
\fBfoo\fR
and
\fBbar\fR
commands.
.PP
This manual page was written for the
Debian(TM)
distribution because the original program does not have a manual page. Instead, it has documentation in the
GNU
Info
format; see below.
.PP
\fBfoo\fR
is a program that...
.SH "OPTIONS"
.PP
The program follows the usual
GNU
command line syntax, with long options starting with two dashes (`\-'). A summary of options is included below. For a complete description, see the
Info
files.
.PP
\fB\-e \fR\fB\fIthis\fR\fR, \fB\-\-example=\fR\fB\fIthat\fR\fR
.RS 3n
Does this and that.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 3n
Show summary of options.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 3n
Show version of program.
.RE
.SH "FILES"
.TP 3n
\fI/etc/foo.conf\fR
The system\-wide configuration file to control the behaviour of
foo. See
\fBfoo.conf\fR(5)
for further details.
.TP 3n
\fI${HOME}/.foo.conf\fR
The per\-user configuration file to control the behaviour of
foo. See
\fBfoo.conf\fR(5)
for further details.
.SH "ENVIONMENT"
.TP 3n
\fBFOO_CONF\fR
If used, the defined file is used as configuration file (see also
the section called \(lqFILES\(rq).
.SH "DIAGNOSTICS"
.PP
The following diagnostics may be issued on
\fIstderr\fR:
.TP 3n
Bad configuration file. Exiting.
The configuration file seems to contain a broken configuration line. Use the
\fB\-\-verbose\fR
option, to get more info.
.PP
\fBfoo\fR
provides some return codes, that can be used in scripts:
.\" line length increase to cope w/ tbl weirdness
.ll +(\n(LLu * 62u / 100u)
.TS
ll.
\fICode\fR	\fIDiagnostic\fR
T{
\fB0\fR
T}	T{
Program exited successfully.
T}
T{
\fB1\fR
T}	T{
The configuration file seems to be broken.
T}
.TE
.\" line length decrease back to previous value
.ll -(\n(LLu * 62u / 100u)
.sp
.SH "BUGS"
.PP
The program is currently limited to only work with the
foobar
library.
.PP
The upstreams
BTS
can be found at
\fI\%http://bugzilla.foo.tld\fR.
.SH "SEE ALSO"
.PP
\fBbar\fR(1),
\fBbaz\fR(1),
\fBfoo.conf\fR(5)
.PP
The programs are documented fully by
The Rise and Fall of a Fooish Bar
available via the
Info
system.
.SH "AUTHOR"
.PP
\fBJohn\fR \fBDoe\fR <[EMAIL PROTECTED]>
.sp -1n
.IP "" 3n
Manpage author.
.SH "COPYRIGHT"
Copyright \(co 2006 John Doe
.br
.PP
This manual page was written for the
Debian(TM)
system (but may be used by others).
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the
GNU
General Public License, Version 2 or (at your option) any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in
\fIfile:///usr/share/common\-licenses/GPL\fR.
.br

Reply via email to