[moira.git] / man / moira.1

.TH SMS 1 "29 Nov 1988" "Project Athena"
\" RCSID: $Header$
.SH NAME
sms, listmaint, usermaint, dcmmaint \- maintain information stored in SMS
.SH SYNOPSIS
.B sms
[
.BI \-nomenu
]
.SH DESCRIPTION
.I sms
administers all of the information stored in the SMS database.  When
invoked by the name
.B listmaint, usermaint,
or
.B dcmmaint,
.I sms
will immediately drop into the appropriate sub-menu.
There is only one option:
.TP
.BI \-nomenu
Do not take over the screen.  With this option specified, the screen
will be handled like a printing terminal.  Each menu will be displayed
only once.  Typing '?' will cause a menu to be redisplayed.
.PP
When called without options,
.I sms
displays a menu in the top half of the screen listing other menus;
retrievals, appends, updates, or 
deletes to the database; or control actions within the program.
Each menu consists of several lines containing a single character
(usually a numeral), a keyword, and a short description.  Menu items
may be selected by either the single character or the keyword.  Needed
arguments may be put on the same line -- otherwise, they will be 
prompted for.  It is possible to invoke an option from a sub-menu by
name while at a higher menu.  The lower half of the screen is a
dialoge area used to prompt the user and display retrieved information.
.PP
The top level menu just lists other menus for each of the types of
objects stored in the database.  Most menus also list the following
control options:
.TP
.B verbose
Toggle the verosity of delete.  This controls whether or not an extra
confirmation will be required before deleting data from the database.
.TP
.B return
Return to the menu above this one in the menu tree.
.TP
.B toggle
Toggle logging on and off.  When logging is turned on, all output in
the lower half of the screen will also be written to
.I /usr/tmp/sms-log.XXXX,
where XXXX is the process-ID of the sms client.
.TP
.B quit
Exits the sms client immediately.  The connection to the SMS server
will be closed.
.SH DIAGNOSTICS
Pay attention to Kerberos diagnostics, as one must be authenticated to
do most SMS database work.  
.PP
As this is a database manipulation application, diagnostics indicate an
incomplete argument list, an attempt to modify/delete an ambiguous
entry, or an invalid menu choice.
.SH ENVIRONMENT
.TP
KRBTKFILE
path name of your Kerberos ticket.  SMS decides who you are and what you
can do based on your Kerberos tickets, and nothing else.
.TP
TERMCAP
used by curses to control of scrolling and menu display.
.SH AUTHOR
Jean Marie Diaz, Mark Roman, Chris Peterson, Mark Rosenstein and a
cast of thousands
.SH "SEE ALSO"
chfn(1), chpobox(1), chsh(1), mailmaint(1), smslist(1),
SMS section of the Project Athena Technical Plan
.SH NOTES
SMS is Project Athena's Service Management System.
Commit	Line	Data
9d6ddf4b	1	.TH SMS 1 "29 Nov 1988" "Project Athena"
	2	\" RCSID: $Header$
	3	.SH NAME
	4	sms, listmaint, usermaint, dcmmaint \- maintain information stored in SMS
	5	.SH SYNOPSIS
	6	.B sms
	7	[
	8	.BI \-nomenu
	9	]
	10	.SH DESCRIPTION
	11	.I sms
	12	administers all of the information stored in the SMS database. When
	13	invoked by the name
	14	.B listmaint, usermaint,
	15	or
	16	.B dcmmaint,
	17	.I sms
	18	will immediately drop into the appropriate sub-menu.
	19	There is only one option:
	20	.TP
	21	.BI \-nomenu
	22	Do not take over the screen. With this option specified, the screen
	23	will be handled like a printing terminal. Each menu will be displayed
	24	only once. Typing '?' will cause a menu to be redisplayed.
	25	.PP
	26	When called without options,
	27	.I sms
	28	displays a menu in the top half of the screen listing other menus;
	29	retrievals, appends, updates, or
	30	deletes to the database; or control actions within the program.
	31	Each menu consists of several lines containing a single character
	32	(usually a numeral), a keyword, and a short description. Menu items
	33	may be selected by either the single character or the keyword. Needed
	34	arguments may be put on the same line -- otherwise, they will be
	35	prompted for. It is possible to invoke an option from a sub-menu by
	36	name while at a higher menu. The lower half of the screen is a
	37	dialoge area used to prompt the user and display retrieved information.
	38	.PP
	39	The top level menu just lists other menus for each of the types of
	40	objects stored in the database. Most menus also list the following
	41	control options:
	42	.TP
	43	.B verbose
	44	Toggle the verosity of delete. This controls whether or not an extra
	45	confirmation will be required before deleting data from the database.
	46	.TP
	47	.B return
	48	Return to the menu above this one in the menu tree.
	49	.TP
	50	.B toggle
	51	Toggle logging on and off. When logging is turned on, all output in
	52	the lower half of the screen will also be written to
	53	.I /usr/tmp/sms-log.XXXX,
	54	where XXXX is the process-ID of the sms client.
	55	.TP
	56	.B quit
	57	Exits the sms client immediately. The connection to the SMS server
	58	will be closed.
	59	.SH DIAGNOSTICS
	60	Pay attention to Kerberos diagnostics, as one must be authenticated to
	61	do most SMS database work.
	62	.PP
	63	As this is a database manipulation application, diagnostics indicate an
	64	incomplete argument list, an attempt to modify/delete an ambiguous
65	entry, or an invalid menu choice.
66	.SH ENVIRONMENT
67	.TP
68	KRBTKFILE
69	path name of your Kerberos ticket. SMS decides who you are and what you
70	can do based on your Kerberos tickets, and nothing else.
71	.TP
72	TERMCAP
73	used by curses to control of scrolling and menu display.
74	.SH AUTHOR
75	Jean Marie Diaz, Mark Roman, Chris Peterson, Mark Rosenstein and a
76	cast of thousands
77	.SH "SEE ALSO"
78	chfn(1), chpobox(1), chsh(1), mailmaint(1), smslist(1),
79	SMS section of the Project Athena Technical Plan
80	.SH NOTES
81	SMS is Project Athena's Service Management System.