logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

pts_help - Displays help for pts commands

Description

       The ptshelp command displays the complete online help entry (short description and syntax statement) for
       each command operation code specified by the -topic argument. If the -topic argument is omitted, the
       output includes the first line (name and short description) of the online help entry for every pts
       command.

       To list every pts command whose name or short description includes a specified keyword, use the ptsapropos command.

Examples

       The following command displays the online help entry for the ptsmembership command:

          % pts help membership
          pts membership:  list membership of a user or group
          aliases: groups
          Usage: pts membership -nameorid <user or group name or id>+
          [-cell <cell name>] [-noauth] [-force] [-help]

Name

       pts_help - Displays help for pts commands

Options

-topic <helpstring>+
           Indicates  each command for which to display the complete online help entry. Omit the pts part of the
           command name, providing only  the  operation  code  (for  example,  specify  "membership",  not  "pts
           membership"). If this argument is omitted, the output briefly describes every pts command.

       -help
           Prints the online help for this command. All other valid options are ignored.

Output

       The online help entry for each pts command consists of the following two or three lines:

       •   The first line names the command and briefly describes its function.

       •   The second line lists aliases for the command, if any.

       •   The  final  line, which begins with the string "Usage", lists the command's options in the prescribed
           order. Online help entries use the same symbols (for example, brackets) as  the  reference  pages  in
           this document.

Privilege Required

       None

See Also

pts(1), pts_apropos(1)

Synopsis

ptshelp [-topic <helpstring>+] [-help]

       ptsh [-t <helpstring>+] [-h]

See Also