Sample Document

The output of this sample document is shown in Figure 18-1.

    .TH WHIZPROG 1 "April 1, 2007"
    .SH NAME
    whizprog \- do amazing things
    .SH SYNOPSIS
    .B whizprog
    [
    .I options
    ] [
    .I files
    \&... ]
    .SH DESCRIPTION
    .I Whizprog
    is the next generation of really
    .B cool
    do-it-all programs. ...
    .SH OPTIONS
    .PP
    .I Whizprog
    accepts the following options.
    .TP \w'\fB\-\^\-level\fP'u+3n
    .PD 0
    .B \-h
    .TP
    .PD
    .B \-\^\-help
    Print a helpful message and exit.
    .TP
    .BI \-\^\-level " level"
    Set the level for the
    .B \-\^\-stun
    option.
    .TP
    .B \-\^\-stun
    Stun the competition, or other beings, as needed. ...
    .SH SEE ALSO
    .IR "Whizprog \- The Be All and End All Program" ,
    by J. Programmer.
    .PP
    .IR wimpprog (1)
    .SH FILES
    .B /dev/phaser
    .br
    .B /dev/telepath
    .SH CAVEATS
    .PP
    There are a number of important points to remember.
    .RS
    .IP 1.
    Use
    .B \-\^\-help
    to get help.
    .IP 2.
    Use
    .B \-\^\-stun
    with care.  ...
    .RE
    Forget these at your own risk!
    .SH BUGS
    The
    .B \-\^\-stun
    option currently always uses
    .BR "\-\^\-level 10" ,
    making it rather dangerous.
    .SH AUTHOR
    J. Programmer,
    .B jp@wizard-corp.com
Output of sample document
Figure 18-1. Output of sample document

Get Unix in a Nutshell, 4th Edition now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.

Start your free trial