| Line | |
|---|
| 1 | .TH TEMPLATE 1
|
|---|
| 2 | .SH NAME
|
|---|
| 3 | template, blueprint \- a blueprint for making manual pages
|
|---|
| 4 | .SH SYNOPSIS
|
|---|
| 5 | .B template
|
|---|
| 6 | .RB [ \-az ]
|
|---|
| 7 | .RI [ arguments " ...]"
|
|---|
| 8 | .SH DESCRIPTION
|
|---|
| 9 | .de SP
|
|---|
| 10 | .if t .sp 0.4
|
|---|
| 11 | .if n .sp
|
|---|
| 12 | ..
|
|---|
| 13 | .B Template
|
|---|
| 14 | shows what a manual page should look like. Options for instance:
|
|---|
| 15 | .SH OPTIONS
|
|---|
| 16 | .TP
|
|---|
| 17 | .B \-a
|
|---|
| 18 | Use boldface for characters that have to be typed as is.
|
|---|
| 19 | .TP
|
|---|
| 20 | .B \-z
|
|---|
| 21 | Italics for variable
|
|---|
| 22 | .IR arguments .
|
|---|
| 23 | .SH ENVIRONMENT
|
|---|
| 24 | .TP 15n
|
|---|
| 25 | .B MANPATH
|
|---|
| 26 | The path to knowledge.
|
|---|
| 27 | .SH FILES
|
|---|
| 28 | .TP 25n
|
|---|
| 29 | .B /usr/man/template.1
|
|---|
| 30 | This file.
|
|---|
| 31 | .SH "SEE ALSO"
|
|---|
| 32 | .BR man (7).
|
|---|
| 33 | .SH DIAGNOSTICS
|
|---|
| 34 | man: No manual on template.
|
|---|
| 35 | .SH NOTES
|
|---|
| 36 | Use at your own risk.
|
|---|
| 37 | .SH BUGS
|
|---|
| 38 | A lot. The
|
|---|
| 39 | .BR whatis (5)
|
|---|
| 40 | database is usually generated automatically on most
|
|---|
| 41 | systems. This fails if the "NAME" section has more n/troff fluff than just
|
|---|
| 42 | an "\e" before the '\-', or is more than one line. Apply the KISS
|
|---|
| 43 | principle, try to use a minimum of smart macros, match your .RS and .RE's,
|
|---|
| 44 | etc.
|
|---|
| 45 | .SH AUTHOR
|
|---|
| 46 | Kees J. Bot <kjb@cs.vu.nl>
|
|---|
Note:
See
TracBrowser
for help on using the repository browser.
