From 5834a39261d0820c9b69aa687b766a6bcfff8d43 Mon Sep 17 00:00:00 2001 From: mar Date: Wed, 30 Nov 1988 13:18:58 +0000 Subject: [PATCH] Initial revision --- man/dcm.8 | 83 +++++++++++++++++++++++++++++++++++++++++++++ man/moirad.8 | 67 ++++++++++++++++++++++++++++++++++++ man/reg_svr.8 | 64 ++++++++++++++++++++++++++++++++++ man/startdcm.8 | 1 + man/startmoira.8 | 1 + man/startreg.8 | 1 + man/update_server.8 | 18 ++++++++++ man/userreg.1 | 47 +++++++++++++++++++++++++ 8 files changed, 282 insertions(+) create mode 100644 man/dcm.8 create mode 100644 man/moirad.8 create mode 100644 man/reg_svr.8 create mode 100644 man/startdcm.8 create mode 100644 man/startmoira.8 create mode 100644 man/startreg.8 create mode 100644 man/update_server.8 create mode 100644 man/userreg.1 diff --git a/man/dcm.8 b/man/dcm.8 new file mode 100644 index 00000000..3413222d --- /dev/null +++ b/man/dcm.8 @@ -0,0 +1,83 @@ +.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 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 . +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 +/etc/srvtab \- The dcm must be able to get Kerberos tickets for "rcmd.sms". +.SH "SEE ALSO" +The Project Athena Technical Plan section on SMS. diff --git a/man/moirad.8 b/man/moirad.8 new file mode 100644 index 00000000..e29f3345 --- /dev/null +++ b/man/moirad.8 @@ -0,0 +1,67 @@ +.TH SMSD 8 "30 Nov 1988" "Project Athena" +\" RCSID: $Header$ +.SH NAME +smsd \- SMS query daemon +.br +startsms \- start the SMS daemon running, capturing log files +.SH SYNOPSIS +.B smsd +.br +.B startsms +.SH DESCRIPTION +The SMS server +must be running on the machine hosting the SMS database for any of the +SMS clients to function. Rather than invoke +.B smsd +directly, it is started by +.B startsms, +which starts the daemon running in the proper working directory and +captures logging messages. +.PP +Logging is done to standard output. +How much gets logged by +.B smsd +is controlled by the variable +.I log_flags +which is compiled into the file +.I sms_srvdata.c. +If critical errors are detected, they are logged to +.B /u1/sms/critical.log +and in a zephyrgram to class +.B SMS +instance +.B SMS +in addition to standard output. +Also, a journal file is kept in +.B /u1/sms/journal +logging every successful change of the database in a format that can +be replayed by +.I smstest(8). +For the server to be able to function properly, if must be run as root +and root must have access to the tables through RTI Ingres. +.PP +.B startsms +sets its working directory to the root, disconnects from the terminal +and puts itself in the background. It then starts +.B /u1/sms/bin/smsd, +and will capture lines the server writes to standard output and log them +in +.B /u1/sms/sms.log +along with a timestamp. +.B startsms +will also log the exit status of the +.B smsd +if it is non-zero. +.SH FILES +/u1/sms/sms.log +.br +/u1/sms/critical.log +.br +/u1/sms/journal +.br +.br +/tmp/tkt_dcm \- temporary Kerberos ticket storage. +.br +/etc/srvtab \- The dcm must be able to get Kerberos tickets for "sms.sms". +.SH "SEE ALSO" +The Project Athena Technical Plan section on SMS. diff --git a/man/reg_svr.8 b/man/reg_svr.8 new file mode 100644 index 00000000..374a8278 --- /dev/null +++ b/man/reg_svr.8 @@ -0,0 +1,64 @@ +.TH REG_SVR 8 "30 Nov 1988" "Project Athena" +\" RCSID: $Header$ +.SH NAME +reg_svr \- SMS account registration server +.br +startreg \- start the registration server running, capturing log files +.SH SYNOPSIS +.B reg_svr +.br +.B startreg +.SH DESCRIPTION +The registration server +must be running on the machine hosting the SMS database for the +.I userreg +program to function. Rather than invoke +.B reg_svr +directly, it is started by +.B startreg, +which starts the daemon running in the proper working directory and +captures logging messages. +.PP +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 REG_SVR +in addition to standard output. +Also, a journal file is kept in +.B /u1/sms/journal.reg +logging every successful change of the database in a format that can +be replayed by +.I smstest(8). +For the server to be able to function properly, if must be run as root +and root must have access to the tables through RTI Ingres. Also, +Kerberos principal "register.sms" must have permission to create new +Kerberos principals and set their passwords. +.PP +.B startreg +sets its working directory to the root, disconnects from the terminal +and puts itself in the background. It then starts +.B /u1/sms/bin/reg_svr, +and will capture lines the server writes to standard output and log them +in +.B /u1/sms/reg_svr.log +along with a timestamp. +.B startreg +will also log the exit status of the +.B reg_svr +if it is non-zero. +.SH FILES +/u1/sms/reg_svr.log +.br +/u1/sms/critical.log +.br +/u1/sms/journal.reg +.br +.br +/tmp/tkt_ureg \- temporary Kerberos ticket storage. +.br +/etc/srvtab \- The dcm must be able to get Kerberos tickets for "register.sms". +.SH "SEE ALSO" +The Project Athena Technical Plan section on SMS. diff --git a/man/startdcm.8 b/man/startdcm.8 new file mode 100644 index 00000000..60f826f9 --- /dev/null +++ b/man/startdcm.8 @@ -0,0 +1 @@ +.so man8/dcm.8 diff --git a/man/startmoira.8 b/man/startmoira.8 new file mode 100644 index 00000000..0020d7db --- /dev/null +++ b/man/startmoira.8 @@ -0,0 +1 @@ +.so man8/smsd.8 diff --git a/man/startreg.8 b/man/startreg.8 new file mode 100644 index 00000000..381bc01e --- /dev/null +++ b/man/startreg.8 @@ -0,0 +1 @@ +.so man8/reg_svr.8 diff --git a/man/update_server.8 b/man/update_server.8 new file mode 100644 index 00000000..60f530b8 --- /dev/null +++ b/man/update_server.8 @@ -0,0 +1,18 @@ +.TH UPDATE_SERVER 8 "30 Nov 1988" "Project Athena" +\" RCSID: $Header$ +.SH NAME +update_server \- daemon which accepts config files from SMS +.SH SYNOPSIS +.B update_server +.SH DESCRIPTION +An +.B update_server +must be started at boot time on each server that is to be updated by +SMS. It should be run as root. It takes no arguments, and will +detach from the tty and put itself in background. It attempts to log +its actions to stdout, so the output should be directed to a file if +it is needed. +.SH FILES +/etc/srvtab \- It must be able to get rcmd Kerberos tickets. +.SH "SEE ALSO" +The Project Athena Technical Plan section on SMS. diff --git a/man/userreg.1 b/man/userreg.1 new file mode 100644 index 00000000..fcffce8d --- /dev/null +++ b/man/userreg.1 @@ -0,0 +1,47 @@ +.TH USERREG 8 "30 Nov 1988" "Project Athena" +\" RCSID: $Header$ +.SH NAME +userreg \- create an account for a person known to SMS +.SH SYNOPSIS +.B userreg +.SH DESCRIPTION +.B userreg +will take over the terminal, and in a user friendly way ask for the +user's full name and ID number, then allow them to chose a login name +and a password and create their account. All access to the SMS +database and Kerberos server is through the +.B reg_svr +running on the SMS server machine. Many of the screens of helpful +text that are displayed for the user are contained in text files in +the working directory of +.B userreg. +.PP +When +.B userreg +first starts, it checks the file +.B disabled.times +to determine if it is allowed to register people now. This file +contains lines in +.I crontab +format indicating times when users are not allowed to register. The +command field of these lines contain a text message that is displayed +if there is a match for the time interval on that line. +.SH FILES +disabled.times +.br +/mit/register/welcome +.br +/mit/register/network_down +.br +/mit/register/username_blurb +.br +/mit/register/password_blurb +.br +/mit/register/deleted_acct +.br +/mit/register/not_allowed +.br +/mit/register/improper_reg +.SH SEE ALSO +reg_svr(8), +The Project Athena Technical Plan section on SMS -- 2.45.2