]>
Commit | Line | Data |
---|---|---|
15e9ffdd | 1 | .TH ADDUSR 1 "29 Nov 2007" "Project Athena" |
93d0b3bf | 2 | \" RCSID: $Header$ |
3 | .SH NAME | |
4 | addusr \- add and/or register users in Moira | |
5 | .SH SYNOPSIS | |
15e9ffdd | 6 | .B addusr [options] |
93d0b3bf | 7 | .SH DESCRIPTION |
8 | .I Addusr | |
9 | is a tool for adding users in bulk to the moira database and | |
10 | registering them for accounts. It reads the users from a file (or | |
11 | stdin) rather than the menu-oriented regular moira client. | |
12 | ||
13 | The users are entered in one of two formats, depending on whether or | |
14 | not they will be registered. When users are only being added to the | |
15 | database, the format is: | |
16 | .nf | |
17 | lastname, firstname middlename idnumber | |
18 | .fi | |
19 | The lastname may have spaces in it, as it will continue up until the | |
20 | first comma on the line. The firstname also may have spaces, as it | |
21 | will take up everything but the last two tokens on the line. If only | |
22 | 3 tokens are on the line, the middlename will be assumed to be the | |
23 | empty string. The middlename cannot have spaces in it. The idnumber | |
24 | also cannot have spaces, although it may have hyphens in it. The | |
25 | capitalization of the names is not important as it will be corrected | |
45e57a3e | 26 | before entering into the database, unless the \fB-n\fR flag has been |
27 | specified. If the operation specified for | |
93d0b3bf | 28 | .B addusr |
38018b28 | 29 | includes registering users, then there is one additional token on |
93d0b3bf | 30 | the end of the line: |
31 | .nf | |
38018b28 | 32 | lastname, firstname middlename idnumber loginname |
93d0b3bf | 33 | .fi |
93d0b3bf | 34 | .SH OPTIONS |
35 | .IP \fB-file\ \fIfilename\ \fRor\ \fB-f\ \fIfilename\fR: | |
36 | This specifies the file that will be read for the list of users to | |
37 | operate on. If not specifed, standard input will be used. The file | |
38 | format is described above. | |
39 | .IP \fB-class\ \fIclass\ \fRor\ \fB-c\ \fIclass\fR: | |
40 | This specifies the account class that will be used for all users added | |
41 | in this invocation. If not specified, \fITEMP\fR will be used. | |
42 | .IP \fB-comment\ \fI"comment"\ \fRor\ \fB-C\ \fI"comment"\fR: | |
43 | This specifies the comment that will be stored for all users added | |
44 | in this invocation. If not specified, the comment field will be left | |
45 | blank. Note that the double-quotes are not required by \fBaddusr\fR, | |
46 | but will be parsed out by the shell and are only needed to specify | |
47 | comments with spaces in them. | |
48 | .IP \fB-status\ \fIstatus\ \fRor\ \fB-s\ \fIstatus\fR: | |
49 | This specifies the account status that will be used for all users added | |
50 | in this invocation. If not specified, \fI0 (registerable)\fR will be used. | |
51 | .IP \fB-shell\ \fIshell\ \fRor\ \fB-h\ \fIshell\fR: | |
52 | This specifies the login shell that will be stored for all users added | |
967b62f5 | 53 | in this invocation. If not specified, a default will be used. At MIT |
78364700 | 54 | Athena the default is \fI/bin/athena/bash\fR, elsewhere it is likely to be |
55 | \fI/bin/bash\fR. | |
15e9ffdd | 56 | .IP \fB-winshell\ \fIshell\ \fRor\ \fB-w\ \fIshell\fR: |
57 | This specifies the Windows console shell that will be used for all users | |
58 | added in this invocation. If not specified, a default value of | |
59 | \fIcmd\fR will be used. | |
60 | .IP \fB-sponsor\ \fIsponsor\ \fRor\ \fB-sp\ \fIsponsor\fR: | |
61 | This specifies the USER, LIST, or KERBEROS that will be listed as the | |
62 | sponsor for all users added in this invocation. This is intended for | |
63 | use with accounts in the GUEST and VOUCH classes. | |
64 | .IP \fB-expiration\ \fIdate\ \fRor\ \fB-e\ \fIdate\fR: | |
65 | This specified the expiration date that will be recorded for all users | |
66 | added in this invocation. This is intended for use with accounts in the | |
67 | GUEST or VOUCH classes. | |
93d0b3bf | 68 | .IP \fB-register\ \fRor\ \fB-R\fR: |
69 | This instructs \fBaddusr\fR to both add the users to the database and | |
38018b28 | 70 | then to immediately register them. The users will be left |
71 | "half-registered", meaning that they have everything but a Kerberos | |
72 | principal. | |
93d0b3bf | 73 | .IP \fB-reg_only\ \fRor\ \fB-r\fR: |
38018b28 | 74 | This instructs \fBaddusr\fR to (half-) register the users without |
75 | attempting to add them to the database. They must already exist in the | |
76 | database. | |
93d0b3bf | 77 | .IP \fB-verbose\ \fRor\ \fB-v\fR: |
78 | This causes \fBaddusr\fR to print messages about each operation as it | |
79 | performs it. | |
80 | .IP \fB-nodupcheck\ \fRor\ \fB-d\fR: | |
81 | Do not attempt to check the database for duplicates before adding | |
82 | users. Normally \fBaddusr\fR will check the database for users with | |
83 | the same name. If it finds any who match in both name and ID number, | |
84 | the user will not be added. If it finds a name match with a different | |
85 | ID number, it will print a warning and add the user anyway. | |
45e57a3e | 86 | .IP \fB-nocaps\ \fRor\ \fB-n\fR: |
87 | Do not attempt to normalize the capitalization of first, middle, and | |
88 | last names before adding users. Normally, \fBaddusr\fR will update the | |
89 | capitalization of names based on a set of heuristics. This flag can be | |
90 | used to suppress this behavior if it is inappropriate for certain names. | |
bbf9216c | 91 | .IP \fB-database\ \fIhost:port\ \fRor\ \fB-db\ \fIhost:port\fR: |
93d0b3bf | 92 | Use the specified host and port to contact the Moira server instead of |
93 | the default server. Both may be symbolic names or numbers. If the | |
94 | port is left off, the default Moira server port will be assumed. The | |
95 | server chosen will be the one specified on the command line, specified | |
96 | in the MOIRASERVER environment variable, the hesiod "moira" sloc entry, | |
97 | or the compiled in default, in that order or preference. | |
00988715 | 98 | .IP \fB-secure\ \fRor\ \fB-6\fR: |
99 | This specifies that users added in this invocation will need a secure | |
100 | "Account Coupon" containing additional verification information beyond | |
101 | name and ID number to be allowed to register. | |
93d0b3bf | 102 | |
103 | .SH AUTHOR | |
104 | Mark Rosenstein | |
105 | .SH SEE ALSO | |
106 | moira(1), userreg(1) |