doc/man-pages/pod1/pts_help.pod

   1 =head1 NAME
   2
   3 pts help - Displays the syntax of specified pts commands or lists
   4 functional descriptions for all B<pts> commands
   5
   6 =head1 SYNOPSIS
   7
   8 B<pts help> [B<-topic> <I<help string>>+]  [-help]
   9
  10 B<pts h> [B<-t> <I<help string>>+]  [-h]
  11
  12 =head1 DESCRIPTION
  13
  14 The pts help command displays the complete online help entry
  15 (short description and syntax statement) for each command operation code
  16 specified by the B<-topic> argument. If the B<-topic>
  17 argument is omitted, the output includes the first line (name and short
  18 description) of the online help entry for every B<pts> command.
  19
  20 To list every pts command whose name or short description
  21 includes a specified keyword, use the B<pts apropos> command.
  22
  23 =head1 OPTIONS
  24
  25 =over 4
  26
  27 =item -topic
  28
  29 Indicates each command for which to display the complete online help
  30 entry. Omit the B<pts> part of the command name, providing only
  31 the operation code (for example, specify B<membership>, not B<pts
  32 membership>). If this argument is omitted, the output briefly
  33 describes every B<pts> command.
  34
  35 =item -help
  36
  37 Prints the online help for this command. All other valid options
  38 are ignored.
  39
  40 =back
  41
  42 =head1 OUTPUT
  43
  44 The online help entry for each pts command consists of the
  45 following two or three lines:
  46
  47 =over 4
  48
  49 =item *
  50
  51 The first line names the command and briefly describes its
  52 function.
  53
  54
  55 =item *
  56
  57 The second line lists aliases for the command, if any.
  58
  59
  60 =item *
  61
  62 The final line, which begins with the string C<Usage>, lists the
  63 command's options in the prescribed order. Online help entries use
  64 the same symbols (for example, brackets) as the reference pages in this
  65 document.
  66
  67
  68 =back
  69
  70 =head1 EXAMPLES
  71
  72 The following command displays the online help entry for the pts
  73 membership command:
  74
  75    % pts help membership
  76    pts membership:  list membership of a user or group
  77    aliases: groups
  78    Usage: pts membership -nameorid <user or group name or id>+
  79    [-cell <cell name>] [-noauth] [-force] [-help]
  80
  81 =head1 PRIVILEGE REQUIRED
  82
  83 None
  84
  85 =head1 SEE ALSO
  86
  87 L<pts(1)>,
  88 L<pts_apropos(1)>
  89
  90 =head1 COPYRIGHT
  91
  92 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
  93
  94 This documentation is covered by the IBM Public License Version 1.0.  It was
  95 converted from HTML to POD by software written by Chas Williams and Russ
  96 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.