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