IBM NFS/DFS Secure Gateway manual Dfsgw help Purpose, $ dfsgw help list

dfsgw help

Purpose

Shows syntax of specified dfsgw commands or lists functional descriptions of all dfsgw commands

Synopsis

dfsgw help [-topic string] [-help]

Options

-topic string

Specifies each command whose syntax is to be displayed. Provide only the second part of the command name (for example, list, not dfsgw list). If this option is omitted, the output provides short descriptions of all dfsgw commands.

-helpDisplays the online help for this command. All other valid options specified with this option are ignored.

Description

The dfsgw help command displays the first line (name and short description) of the online help entry for every dfsgw command if the -topicoption is not provided. For each command name specified with the -topicoption, the output lists the entire help entry.

Use the dfsgw apropos command to show each help entry that contains a specified string.

Privilege Required

No privileges are required.

Output

The online help entry for each dfsgw command consists of the following two lines:

vThe first line names the command and briefly describes its function.

vThe second line, which begins with Usage:, lists the command options in the prescribed order.

Examples

The following command displays the online help entry for the dfsgw list command:

$ dfsgw help list

Chapter 5. Configuration File and Command Reference 37