Specifications

Version 2.0
137
help
Summary
Displays the list of commands that are built into the UEFI Shell.
Usage
help [cmd | pattern | special] [-usage] [-verbose] [-section
sectionname][-b]
Options
cmd
Command to display help about.
pattern
Pattern which describes the commands to be displayed.
special
Displays a list of the special characters used in the shell command line.
-usage
Display the usage information for the command. The same as specifying –
section:NAME and –section:SYNOPSIS
-section sectionname
Display the specified section of the help information. Standard section names can
be found in Appendix B.
Description
The help command displays information about one or more shell commands.
If no other options are specified, each command will be displayed along with a brief
description of its function. If –verbose is specified, then all help information for the
specified commands. If –section is specified, only the help section specified will be
displayed (see below). If –usage is specified, then the command, a brief description
and the usage will be displayed.
The help text is gathered from UCS-2 text files found in the directory where the shell
or shell command executable was located. The files have the name command-
name.man, where command-name is the name of the shell command. The files follow
a sub-set of the MAN page format, as described below.
If no option is specified, then only the NAME section of the page is reproduced.
Status Codes Returned
0 The help was displayed
1 No command help was displayed