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