Specifications

Version 2.0
223
Appendix B UEFI Help Manual
Page Syntax
The manual page files are standard text files with title and section heading
information embedded using commands which begin with a ‘.’. The following two
macros are supported:
.TH command-name 0 “short-description”
Title header. When printing multi-page help, this will appear at the top of each
page.
.SH section-name
Sub-header. Specifies one of several standard sub-headings.
Table 30 Subheadings and descriptions
Sub-Heading
Name
Description
NAME The name of the function or command, along with a one-line summary.
SYNOPISIS Usage of the command
DESCRIPTION General description
OPTIONS Description of all options and parameters.
RETURN
VALUES
Values returned.
ENVIRONMENT
VARIABLES
Environment variables used
FILES Files associated with the subject.
EXAMPLES Examples and suggestions.
ERRORS Errors reported by the command.
STANDARDS Conformance to applicable standards.
BUGS Errors and caveats.
CATEGORY The comma-delimited list of categories to which this command belongs.
Category names must follow normal file naming conventions. Category
names which begin with ‘_’ will not be used in the specification. See section
TBD (“Command-Line Help”) for more information on how this category is
used when installing new commands.
other Other sections added by the help author.