source: trunk/third/moira/man/moira.1 @ 25198

Revision 25198, 3.4 KB checked in by jdreed, 13 years ago (diff)
In moira: * Snapshot moira@r4042 (6/28/11) * Update version number to include moira revision number
Line 
1.TH MOIRA 1 "29 Nov 1988" "Project Athena"
2\" RCSID: $HeadURL: svn+ssh://svn.mit.edu/moira/trunk/moira/man/moira.1 $ $Id: moira.1 4025 2010-11-30 17:17:02Z zacheiss $
3.SH NAME
4moira, listmaint, usermaint, dcmmaint \- maintain information stored in moira
5.SH SYNOPSIS
6.B moira
7[
8.BI \-nomenu
9|
10.BI \-menu
11] [
12.BI \-db
13.I host:port
14]
15.SH DESCRIPTION
16.I Moira
17administers all of the information stored in Moira, the Athena Service
18Management System database.  When invoked by the name
19.B listmaint, usermaint,
20or
21.B dcmmaint,
22.I moira
23will immediately drop into the appropriate sub-menu.
24
25It a database is specified on the command line, that server will be
26contacted rather than the compiled-in default.  The host and port may
27both be symbolic names or numbers.  If the port is not specified, the
28default Moira server port will be used.  The server chosen will be the
29one specified on the command line, from the environment variable
30MOIRASERVER, from the "moira" sloc entry in hesiod, or the compiled in
31default, in that order of preference.
32
33The option:
34.TP
35.BI \-nomenu
36will cause moira to not take over the screen.  With this option
37specified, the screen
38will be handled like a printing terminal.  Each menu will be displayed
39only once.  Typing '?' will cause a menu to be redisplayed.
40.PP
41When called without options,
42.I moira
43displays a menu in the top half of the screen listing other menus;
44retrievals, appends, updates, or
45deletes to the database; or control actions within the program.
46Each menu consists of several lines containing a single character
47(usually a numeral), a keyword, and a short description.  Menu items
48may be selected by either the single character or the keyword.  Needed
49arguments may be put on the same line -- otherwise, they will be
50prompted for.  It is possible to invoke an option from a sub-menu by
51name while at a higher menu.  The lower half of the screen is a
52dialogue area used to prompt the user and display retrieved information.
53.PP
54The top level menu just lists other menus for each of the types of
55objects stored in the database.  Most menus also list the following
56control options:
57.TP
58.B verbose
59Toggle the verbosity of delete.  This controls whether or not an extra
60confirmation will be required before deleting data from the database.
61.TP
62.B return
63Return to the menu above this one in the menu tree.
64.TP
65.B toggle
66Toggle logging on and off.  When logging is turned on, all output in
67the lower half of the screen will also be written to
68.I /var/tmp/moira-log.XXXX,
69where XXXX is the process-ID of the moira client.
70.TP
71.B quit
72Exits the moira client immediately.  The connection to the Moira server
73will be closed.
74.SH DIAGNOSTICS
75Pay attention to Kerberos diagnostics, as one must be authenticated to
76do most Moira database work. 
77.PP
78As this is a database manipulation application, diagnostics indicate an
79incomplete argument list, an attempt to modify/delete an ambiguous
80entry, or an invalid menu choice.
81.SH ENVIRONMENT
82.TP
83KRBTKFILE
84path name of your Kerberos ticket.  Moira decides who you are and what you
85can do based on your Kerberos tickets, and nothing else.
86.TP
87TERMCAP
88used by curses to control of scrolling and menu display.
89.SH AUTHOR
90Jean Marie Diaz, Mark Roman, Chris Peterson, Mark Rosenstein and a
91cast of thousands
92.SH "SEE ALSO"
93chfn(1), chpobox(1), chsh(1), mailmaint(1), listmaint(1),
94blanche(1), eunice(1), mitch(1), stanley(1), stella(1),
95Moira section of the Project Athena Technical Plan
Note: See TracBrowser for help on using the repository browser.