]>
Commit | Line | Data |
---|---|---|
646e07cf | 1 | *no_more_help |
2 | Sorry, no further help is available. | |
3 | *show_user | |
4 | This will display information about a user in the database. The user | |
5 | may or may not have an active account. | |
6 | ||
7 | Users may be retrieved in four ways: | |
8 | + by login name (may use wildcards) | |
9 | + by Unix UID (must match exactly) | |
10 | + by first and/or last names (may use wildcards) | |
11 | + by class (please do not specify a class with too many people in it) | |
12 | ||
13 | Fill in the desired field(s), mouse on "OK", and moira will retrieve | |
14 | any matching users. Moira will look to see which field(s) you | |
15 | filled in, and perform one of the for retrievals mentioned above. | |
16 | *add_user | |
17 | Specify all of the information to add a new user to the database. The | |
18 | user need not have an active useraccount. | |
19 | ||
20 | + specify a login name of 3 to 8 characters, or the special value | |
21 | "create unique login" to have moira choose one for you | |
22 | + specify a number for the UID, or the special value "create unique UID" | |
23 | to have moira choose one for you. | |
24 | + Moira has a set of standard capitalization rules it uses on users' | |
25 | real names. If you attempt to enter names capitalized differently, | |
26 | Moira will complain. You may override this, but if you do so, the | |
27 | register program may not work for that user. | |
28 | + the ID number will be one-way encrypted before being stored in the | |
29 | database. If you wish to enter the encrypted ID directly, enclose | |
30 | it in double-quotes. | |
31 | + to create a fully active user account, enter a user here as status | |
32 | "Registerable", then use the "register" option on the "user" menu to | |
33 | complete the user account. | |
34 | *register_user | |
35 | This will turn an entry for a user in the database to a fully | |
36 | functioning account. The user may be selected in two ways: | |
37 | ||
38 | + specify the real name of the user (with wildcards allowed) in the | |
39 | first name and last name fields. This must match only one user in | |
40 | the database. | |
41 | + specify the unix UID of the desired user. | |
42 | ||
43 | Be sure to fill in a login name which is not in use. The suggested | |
44 | name is | |
45 | first initial, middle initial, first six characters of last name | |
46 | but must be eight or fewer characters long. | |
47 | *select_user | |
48 | Specify the login name of the user to be modified. Wildcards may | |
49 | be used, but your specification must match exactly one user. | |
50 | *mod_user | |
51 | Change any fields desired, then mouse on "OK" to modify the user | |
52 | entry. You may even change the login name. | |
53 | ||
54 | + You may change the UID to the special value "create unique UID" | |
55 | to have moira choose another one for you. | |
56 | + Moira has a set of standard capitalization rules it uses on users' | |
57 | real names. If you attempt to enter names capitalized differently, | |
58 | Moira will complain. You may override this, but if you do so, the | |
59 | register program may not work for that user. | |
60 | + the ID number will be one-way encrypted before being stored in the | |
61 | database. To enter an already encrypted ID, type double-quotes (") | |
62 | around it. | |
63 | + If you are just changing the account status, in the future remember | |
64 | that the "deactivate" choice of the "user" menu is a quick way to | |
65 | set the status to "3 - Deleted". | |
66 | *deactivate_user | |
67 | Specify the login name of the user to be deactivated. | |
68 | ||
69 | Deactivating a user makes their account no longer usable. They will | |
70 | show up with an account status of "3 - Marked for Deletion". However, | |
71 | all of their information will still be in the database so that the | |
72 | account can be turned back on if necessary. Since they are still in | |
73 | the database, their login name and UID may not be re-used. You may | |
74 | wish to make the user's group list no longer active and deny access to | |
75 | their locker at the same time. | |
76 | ||
77 | At some point in the future, deactivated accounts should be expunged, | |
78 | either in bulk or with the "expunge" option of the "user" menu. | |
79 | *expunge_user | |
80 | Specify the login name of the user to be expunged. | |
81 | ||
82 | This will remove the user's record from the Moira database (but not | |
83 | from Kerberos). Once this is done, the login name and UID may be | |
84 | reused. It is a good idea to leave users in the deactivated state for | |
85 | a while before expunging them so that the name and ID are not reused | |
86 | right away, and the account can be reactivated if necessary. | |
87 | ||
88 | At Project Athena, we have decided that expunging individual accounts | |
89 | is a bad idea, so any account which has ever been active may not be | |
90 | expunged this way. These accounts must be removed in bulk by the | |
91 | Moira administrator. | |
92 | *show_finger | |
93 | Specify a login name to select a user whose finger information will be | |
94 | displayed. This information will exist for users whose accounts are | |
95 | not yet active, as it is loaded at the same time as the users | |
96 | themselves. | |
97 | *select_finger | |
98 | Specify the login name of the user whose finger information is to be | |
99 | modified. Wildcards may be used, but your specification must match | |
100 | exactly one user. | |
101 | *mod_finger | |
102 | Enter the new information about the user. This information will | |
103 | appear where the finger program can see it. | |
104 | ||
105 | You may set your name as it appears to other users to anything you | |
106 | want. Please keep it something resembling your real name. Our | |
107 | operations staff can find out the real name of the owner of an | |
108 | account. | |
109 | ||
110 | The rest of the information is optional, and is initialized to | |
111 | information from the administration. If you do not want this | |
112 | information to appear for you, type spaces over it. Please do not | |
113 | enter incorrect information. | |
114 | ||
115 | Note that commas (,) and colons (:) are not allowed in these | |
116 | responses. This is due to how the information is manipulated later. | |
117 | We suggest that you use a semicolon (;) to separate parts of your | |
118 | address. | |
119 | *select_pobox | |
120 | Enter the login name of a user to see what that user's P. O. Box or | |
121 | mail forwarding is set to. | |
122 | *set_pobox | |
123 | This allows you to set where a user receives their mail. Specify the | |
124 | login name to select a user. | |
125 | ||
126 | + If the type is POP, then the user will receive their mail on a post | |
127 | office (POP) server. Select one of the POP servers listed below. | |
128 | + If the type is SMTP, then the user will have their mail forwarded | |
129 | somewhere else. Type the destination address in the "SMTP Address" | |
130 | field. | |
131 | + If the type is NONE, the user will be unable to recieve mail. This | |
132 | is the same as deleting the P. O. Box. | |
133 | ||
134 | Note that if the user has had their mail forwarded, and wants to | |
135 | recieve it locally again, you should not use this form; select the | |
136 | "reset" option from the "pobox" menu to select the same POP server | |
137 | that they previously used. | |
138 | ||
139 | To add new POP servers to the list, add them as POP servers in the | |
140 | servers submenu of the updates menu. | |
141 | *reset_pobox | |
142 | This option will change a user's mail setting to receiving on a local | |
143 | POP server. The server chosen will be the same one that the user has | |
144 | used in the past. If the user is already receiving their mail | |
145 | locally, or has never had a POP box, then you will get an error. Use | |
146 | the "set" option of the "pobox" menu for more general mail | |
147 | manipulation. | |
148 | *del_pobox | |
149 | If you delete a user's P. O. Box, they will not be able to receive | |
150 | mail. This normally should not be done. To go ahead and delete a | |
151 | users mailbox, enter their login name. | |
152 | *show_krbmap | |
153 | This will display user to kerberos principal mappings. You may | |
154 | specify the mappings to be displayed by entering a login name, a | |
155 | principal name, or both. Either field may contain wildcards. | |
156 | *add_krbmap | |
157 | This will add a new user to kerberos mapping to the database. You | |
158 | must fill in both fields, entering a login name and a kerberos | |
159 | principal. | |
160 | ||
161 | Note that the principal is case sensitive, and should be entered with | |
162 | the realm in uppercase. If the principal name contains a periods or | |
163 | at-signs other than as separators between the name, instance and | |
164 | realm, be sure to escape them with backslashes (\). | |
165 | *del_krbmap | |
166 | This will remove a mapping from the database. You must fill in both | |
167 | fields, exactly matching an existing kerberos mapping. | |
168 | ||
169 | Note that the principal is case sensitive, and should be entered with | |
170 | the realm in uppercase. If the principal name contains a periods or | |
171 | at-signs other than as separators between the name, instance and | |
172 | realm, be sure to escape them with backslashes (\). | |
173 | *show_machine | |
174 | This will show you the information about one or more machines (hosts) | |
175 | in the database. Wildcards may be used in the name. If no wildcards | |
176 | are used, the name you type will be canonicalized by the domain name | |
177 | system before being looked up in the database. To bypass this | |
178 | canonicalization, put the name inside a pair of double-quotes. All | |
179 | machine name comparisons are case-insensitive. | |
180 | *add_machine | |
181 | This will add a new machine (host) to the database. The name you type | |
182 | will be canonicalized by the domain name system. To bypass this | |
183 | canonicalization, put the name inside a pair of double-quotes. Each | |
184 | machine must be of one of the defined types. | |
185 | ||
186 | Note that type "AFS" is used with pseudo-machines that are used as AFS | |
187 | cellname indicators. | |
188 | *select_machine | |
189 | Enter the name of the machine (host) to modify or delete. Wildcards | |
190 | may be used in the name. If no wildcards are used, the name you type | |
191 | will be canonicalized by the domain name system before being looked up | |
192 | in the database. To bypass this canonicalization, put the name inside | |
193 | a pair of double-quotes. All machine name comparisons are | |
194 | case-insensitive. | |
195 | *mod_machine | |
196 | You may change the name and/or type of the machine. The name you type | |
197 | will be canonicalized by the domain name system. To bypass this | |
198 | canonicalization, put the name inside a pair of double-quotes. Each | |
199 | machine must be of one of the defined types. | |
200 | ||
201 | Note that type "AFS" is used with pseudo-machines that are used as AFS | |
202 | cellname indicators. | |
203 | *authors | |
204 | This moira client was written by Mark Rosenstein and Andy Oakland of | |
205 | MIT Project Athena. | |
206 | *about_moira | |
207 | Moira is a system configuration manager for distributed systems. This | |
208 | program is the user interface part of the system, and allows you to | |
209 | manipulate everything moira knows about. | |
210 | ||
211 | The top menu bar lists the kinds of things moira knows about, and | |
212 | clicking the mouse on one of them will display a menu of operations | |
213 | supported for that kind of object. Some of these menus have submenus | |
214 | for related objects. | |
215 | ||
216 | When you select a menu item, a form will be displayed. Fill out any | |
217 | desired parts of the form: | |
218 | + put the correct value in any text fields | |
219 | + click on the appropriate choice in keyword fields | |
220 | + click on the value to toggle booleans between True and False | |
221 | + typing TAB will forward you to the next field | |
222 | When you are done, click the mouse on "OK". If you are retrieving | |
223 | information from the database, the results will be displayed in the | |
224 | window underneath the form. Each form has a help message specific to | |
225 | that form that you can see by clicking the mouse on "HELP". If you | |
226 | click on "CANCEL", the form will disappear without doing anything. | |
227 | *add_new_value | |
228 | This will allow you to add a new keyword which can be specified for | |
229 | the field in the previous form. Moira type fields are checked against | |
230 | a list of legal values, but this list itself can easily be changed. | |
231 | However, this should not be done lightly. Be sure you know what you | |
232 | are doing and really want this new value before adding it. | |
233 | ||
234 | To have a keyword value removed, ask the Moira system administrator. | |
235 | *wildcards | |
236 | Wildcards are allowed in most fields when looking things up in the | |
237 | database. Asterisk "*" will match zero or more characters, so that | |
238 | "Rose*" will match "Rose", "Rosen", "Rosenberg" or "Rosenstein". | |
239 | ||
240 | Be careful about using wildcards where your query will match too much | |
241 | data in the database. You probably do not want to retrieve 1000 | |
242 | items, and doing so will cause the server to take a long time and | |
243 | possibly require more resources than are available. | |
244 | *del_all_member | |
245 | This will allow you to remove a particular member from all lists that | |
246 | member belongs to. You may specify any type of member, but must | |
247 | exactly match that member without wildcards. | |
248 | ||
249 | This program can prompt you for each deletion, or simply do them all. | |
250 | *del_mem_confirm | |
251 | If you answer yes, this member will be deleted from the named list. | |
252 | Answer no to avoid the deletion. In either case, you will continue to | |
253 | be prompted with the other lists the member belongs to. | |
254 | *mouse | |
255 | You may also retrieve or modify objects by using the mouse to click on | |
256 | them where they appear in the log window. Regular mouse clicks will | |
257 | do selections as they do in most X applications. But if you hold down | |
258 | SHIFT and click the first moust button, it will retrieve the | |
259 | referenced object. And if you hold down SHIFT and click the second | |
260 | mouse button, it will pull up the window to modify the referenced | |
261 | object. If you click the mouse on something the program doesn't | |
262 | recognize as an object, it will beep at you. | |
263 | ||
264 | For example, when you show information about a filesystem, a paragraph | |
265 | is added to the log that starts with "Filesystem: foo". If you click | |
266 | on the name (foo in the example), it will reference that filesystem | |
267 | again. The paragraph about the filesystem also mentions a machine, a | |
268 | user (the owner), a group (the owners), and another user (who last | |
269 | modified the info). You can click on any of these names to select the | |
270 | object being referred to. | |
271 | *keyboard | |
272 | There are keyboard accelerators for many of the mouse actions. | |
273 | ||
274 | For chosing items from the menubar, if you hold down META and type the | |
275 | letter which is underlined in each word, you will select that menu. | |
276 | Then typing the letter underlined in any of the items in the menu will | |
277 | select that item. | |
278 | ||
279 | When you are filling out a form, ENTER will advance you to the next | |
280 | field if there is more than one field in the form. If there is only | |
281 | one field, ENTER is equivalent to mousing on OK. ^C in a form is the | |
282 | same as mousing on CANCEL. | |
283 | *bugs | |
284 | Please report bugs in this program by sending email to: | |
285 | bug-moira@mit.edu | |
286 | Please be sure to mention what kind of computer you were running it | |
287 | on, and any other necessary information so that we can repeat the bug | |
288 | before we fix it. | |
289 | *save_log | |
290 | Enter a file name here, and the current contents of the log file will | |
291 | be written out to that file. | |
292 | *fixcase | |
293 | It is important that names in the Moira database all follow the same | |
294 | capitalization style so that the register program can find users. So | |
295 | even though for a few names it may not look right, we strongly suggest | |
296 | that you follow what this program suggests. | |
297 | *confirm_del_all | |
298 | If you answer yes, this member will be deleted from the named list.\n\ | |
299 | Answer no to avoid the deletion. In either case, you will continue to\n\ | |
300 | be prompted with the other lists the member belongs to. | |
301 | *show_filsys | |
302 | This will display information about a filesystem. The filesystem may | |
303 | be of any protocol type and may be a filesystem group or multiple | |
304 | filesystem entry as well. | |
305 | ||
306 | Filesystems may be retireved in any of four ways: | |
307 | + by the name of the filesystem (may use wildcards) | |
308 | + by the name of the fileserver (machine) (must match exactly) | |
309 | + by the actual partition of an NFS server (specify machine and | |
310 | partition, both must match exactly) | |
311 | + by the owning group of the filesystem (must match exactly) | |
312 | ||
313 | Fill in the desired field(s), click on "OK", and moira will retrieve | |
314 | any matching filesystems. Moira will look to see which field(s) you | |
315 | filled in, and perform one of the for retrievals mentioned above. |