Merge 1.8.0~pre4 packaging into master
[pkg-k5-afs_openafs.git] / doc / man-pages / pod8 / kas_create.pod
blob4f7491d515569d52da08d360ef05e3dad851b584
1 =head1 NAME
3 kas_create - Creates an entry in the Authentication Database
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<kas create> S<<< B<-name> <I<name of user>> >>>
11     S<<< [B<-initial_password> <I<initial password>>] >>>
12     S<<< [B<-admin_username> <I<admin principal to use for authentication>>] >>>
13     S<<< [B<-password_for_admin> <I<admin password>>] >>> S<<< [B<-cell> <I<cell name>>] >>>
14     S<<< [B<-servers> <I<explicit list of authentication servers>>+] >>>
15     [B<-noauth>] [B<-help>]
17 B<kas c> S<<< B<-na> <I<name of user>> >>> S<<< [B<-i> <I<initial password>>] >>>
18     S<<< [B<-a> <I<admin principal to use for authentication>>] >>>
19     S<<< [B<-p> <I<admin password>>] >>> S<<< [B<-c> <I<cell name>>] >>>
20     S<<< [B<-s> <I<explicit list of authentication servers>>+] >>> [B<-no>] [B<-h>]
22 =for html
23 </div>
25 =head1 DESCRIPTION
27 The B<kas create> command creates an entry in the Authentication Database
28 for the user named by the B<-name> argument.
30 To avoid having the account's initial password echo visibly at the shell
31 prompt, omit the B<-initial_password> argument; the command interpreter
32 prompts for the password and does not echo it visibly.  Whether or not
33 B<-initial_password> is omitted, the Authentication Server converts the
34 password into a form suitable for use as an encryption key, and records it
35 in the entry's key field.
37 To alter settings in an Authentication Database entry, use the B<kas
38 setfields> command. To examine an entry, use the B<kas examine>
39 command. To list every entry in the database, use the B<kas list> command.
41 =head1 OPTIONS
43 =over 4
45 =item B<-name> <I<name of user>>
47 Names the new Authentication Database entry. Because it is the name under
48 which the user logs in, it must obey the restrictions that many operating
49 systems impose on user names (usually, to contain no more than eight
50 lowercase letters).
52 =item B<-initial_password> <I<initial password>>
54 Sets the user's password; provide a character string that can include
55 uppercase and lowercase letters, numerals and punctuation. The
56 Authentication Server scrambles the string into an octal string suitable
57 for use as an encryption key before placing it in the entry's key
58 field. If this argument is omitted, the command interpreter prompts for
59 the string and does not echo it visibly.
61 =item B<-admin_username> <I<admin principal>>
63 Specifies the user identity under which to authenticate with the
64 Authentication Server for execution of the command. For more details,
65 see L<kas(8)>.
67 =item B<-password_for_admin> <I<admin password>>
69 Specifies the password of the command's issuer. If it is omitted (as
70 recommended), the B<kas> command interpreter prompts for it and does not
71 echo it visibly. For more details, see L<kas(8)>.
73 =item B<-cell> <I<cell name>>
75 Names the cell in which to run the command. For more details, see
76 L<kas(8)>.
78 =item B<-servers> <I<authentication servers>>
80 Names each machine running an Authentication Server with which to
81 establish a connection. For more details, see L<kas(8)>.
83 =item B<-noauth>
85 Assigns the unprivileged identity C<anonymous> to the issuer. For more
86 details, see L<kas(8)>.
88 =item B<-help>
90 Prints the online help for this command. All other valid options are
91 ignored.
93 =back
95 =head1 EXAMPLES
97 The following example shows the prompts that appear when an administrator
98 logged in as C<admin> creates an Authentication Database entry for the
99 user C<smith>, and does not include either the B<-initial_password> or
100 B<-password_for_admin> arguments.
102    % kas create smith
103    Password for admin:
104    initial_password:
105    Verifying, please re-enter initial_password:
107 =head1 PRIVILEGE REQUIRED
109 The issuer must have the C<ADMIN> flag set on his or her Authentication
110 Database entry.
112 =head1 SEE ALSO
114 L<kas(8)>,
115 L<kas_examine(8)>,
116 L<kas_list(8)>,
117 L<kas_setfields(8)>
119 =head1 COPYRIGHT
121 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
123 This documentation is covered by the IBM Public License Version 1.0.  It was
124 converted from HTML to POD by software written by Chas Williams and Russ
125 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.