andersk Git - moira.git/blame_incremental

... / ...

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