[moira.git] / man / dcm.8

.TH DCM 8 "30 Nov 1988" "Project Athena"
\" RCSID: $Header$
.SH NAME
dcm \- build config files from SMS database and update servers
.br
startdcm \- start a dcm running, capturing log files
.SH SYNOPSIS
.B dcm
[-d level]
.br
.B startdcm
.SH DESCRIPTION
The
.B dcm
must be run periodically on the SMS server.  It is usually run every
15 minutes by the
.I cron
daemon.  Rather than invoke
.B dcm
directly, cron runs
.B startdcm,
which starts the dcm running in the proper working directory and
captures logging messages.
.PP
The
.B dcm
may be disabled by the presence of the file
.I /etc/nodcm
or by setting the value of
.I dcm_enable
to zero in the SMS database.  Debug mode may be enabled in the dcm by
specifying an integer on the command line or by setting the
environment variable
.B DEBUG.
The command line value will override the environment variable.  Three
bits are currently defined in the debug value: DBG_PLAIN = 01,
DBG_VERBOSE = 02, DBG_TRACE = 04.  Logging is done to standard output.
If critical errors are detected, they are logged to
.B /u1/sms/critical.log
and in a zephyrgram to class
.B SMS
instance
.B DCM
in addition to standard output.
For the
.B dcm
to function properly,
.I root
must both be authorized to access each of the tables by RTI Ingres,
and on the query acls for each of the queries the 
.B dcm
will execute.
.PP
For the actual generation of config files, the
.B dcm
will for off generator programs of the form
.B /u1/sms/bin/\fIservice\fB.gen.
Each generator takes as an argument the name of the output file to
produce.  Many of them also require working directories in
.B /u1/sms/dcm/\fIservice\fB.
A generator exits with a status code defined in
.I <sms_et.h>.
In particular,
.B SMS_NO_CHANGE
is a common exit status if the database hasn't changed since the last
time this generator was run.
.PP
.B startdcm
sets its working directory to the root, disconnects from the terminal
and puts itself in the background.  It then starts
.B /u1/sms/bin/dcm,
and will capture lines the dcm writes to standard output and log them
in
.B /u1/sms/dcm.log
along with a timestamp.
.B startdcm
will also log the exit status of the
.B dcm
if it is non-zero.
.SH FILES
/u1/sms/dcm.log
.br
/u1/sms/critical.log
.br
/u1/sms/dcm/locks/* \- empty files will be created here for advisory locks.
.br
/u1/sms/bin/*.gen \- service file generators will be searched for
here.
.br
/tmp/tkt_dcm \- temporary Kerberos ticket storage.
.br
/etc/srvtab \- The dcm must be able to get Kerberos tickets for "sms"
(null instance).
.SH "SEE ALSO"
The Project Athena Technical Plan section on SMS.
Commit	Line	Data
5834a392	1	.TH DCM 8 "30 Nov 1988" "Project Athena"
	2	\" RCSID: $Header$
	3	.SH NAME
	4	dcm \- build config files from SMS database and update servers
	5	.br
	6	startdcm \- start a dcm running, capturing log files
	7	.SH SYNOPSIS
	8	.B dcm
	9	[-d level]
	10	.br
	11	.B startdcm
	12	.SH DESCRIPTION
	13	The
	14	.B dcm
	15	must be run periodically on the SMS server. It is usually run every
	16	15 minutes by the
	17	.I cron
	18	daemon. Rather than invoke
	19	.B dcm
	20	directly, cron runs
	21	.B startdcm,
	22	which starts the dcm running in the proper working directory and
	23	captures logging messages.
	24	.PP
	25	The
	26	.B dcm
	27	may be disabled by the presence of the file
	28	.I /etc/nodcm
	29	or by setting the value of
	30	.I dcm_enable
	31	to zero in the SMS database. Debug mode may be enabled in the dcm by
	32	specifying an integer on the command line or by setting the
	33	environment variable
	34	.B DEBUG.
	35	The command line value will override the environment variable. Three
	36	bits are currently defined in the debug value: DBG_PLAIN = 01,
	37	DBG_VERBOSE = 02, DBG_TRACE = 04. Logging is done to standard output.
	38	If critical errors are detected, they are logged to
	39	.B /u1/sms/critical.log
	40	and in a zephyrgram to class
	41	.B SMS
	42	instance
	43	.B DCM
	44	in addition to standard output.
8d655ac7	45	For the
	46	.B dcm
	47	to function properly,
	48	.I root
	49	must both be authorized to access each of the tables by RTI Ingres,
	50	and on the query acls for each of the queries the
	51	.B dcm
	52	will execute.
	53	.PP
5834a392	54	For the actual generation of config files, the
	55	.B dcm
	56	will for off generator programs of the form
	57	.B /u1/sms/bin/\fIservice\fB.gen.
	58	Each generator takes as an argument the name of the output file to
	59	produce. Many of them also require working directories in
	60	.B /u1/sms/dcm/\fIservice\fB.
	61	A generator exits with a status code defined in
	62	.I <sms_et.h>.
	63	In particular,
	64	.B SMS_NO_CHANGE
	65	is a common exit status if the database hasn't changed since the last
	66	time this generator was run.
	67	.PP
	68	.B startdcm
	69	sets its working directory to the root, disconnects from the terminal
	70	and puts itself in the background. It then starts
	71	.B /u1/sms/bin/dcm,
	72	and will capture lines the dcm writes to standard output and log them
	73	in
	74	.B /u1/sms/dcm.log
	75	along with a timestamp.
	76	.B startdcm
	77	will also log the exit status of the
	78	.B dcm
	79	if it is non-zero.
	80	.SH FILES
	81	/u1/sms/dcm.log
	82	.br
	83	/u1/sms/critical.log
	84	.br
	85	/u1/sms/dcm/locks/* \- empty files will be created here for advisory locks.
	86	.br
	87	/u1/sms/bin/*.gen \- service file generators will be searched for
	88	here.
	89	.br
34e7a903	90	/tmp/tkt_dcm \- temporary Kerberos ticket storage.
	91	.br
	92	/etc/srvtab \- The dcm must be able to get Kerberos tickets for "sms"
	93	(null instance).
5834a392	94	.SH "SEE ALSO"
5834a392	95	The Project Athena Technical Plan section on SMS.