From 76cd4baec8f5c266c8047cc88981f84701e1fc7a Mon Sep 17 00:00:00 2001 From: Jeffrey Hutzelman Date: Thu, 21 Feb 2013 19:25:18 -0500 Subject: Substitute paths into man pages Generate the man pages for zwgc, zctl, zhm, and zephyrd at build time, so they can refer to the paths actually used instead of whatever was used on Athena in the 1980's. --- server/Makefile.in | 13 +++++- server/zephyrd.8 | 126 -------------------------------------------------- server/zephyrd.8.in | 129 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 141 insertions(+), 127 deletions(-) delete mode 100644 server/zephyrd.8 create mode 100644 server/zephyrd.8.in (limited to 'server') diff --git a/server/Makefile.in b/server/Makefile.in index 7d244be..dc51a96 100644 --- a/server/Makefile.in +++ b/server/Makefile.in @@ -21,6 +21,12 @@ LIBTOOL=@LIBTOOL@ CC=@CC@ INSTALL=@INSTALL@ +editman = sed \ + -e 's|@datadir[@]|${datadir}|g' \ + -e 's|@sysconfdir[@]|${sysconfdir}|g' \ + -e 's|@sbindir[@]|${sbindir}|g' \ + -e 's|@lsbindir[@]|${lsbindir}|g' + LIBZEPHYR=${BUILDTOP}/lib/libzephyr.la CPPFLAGS=@CPPFLAGS@ CFLAGS=@CFLAGS@ @@ -34,7 +40,7 @@ OBJS= zsrv_err.o access.o acl_files.o bdump.o class.o client.o common.o \ dispatch.o kstuff.o main.o server.o subscr.o timer.o uloc.o \ zstring.o realm.o version.o utf8proc.o -all: zephyrd +all: zephyrd zephyrd.8 zephyrd: ${OBJS} ${LIBZEPHYR} ${LIBTOOL} --mode=link ${CC} ${LDFLAGS} -o $@ ${OBJS} ${LIBS} ${HESIOD_LIBS} @@ -46,6 +52,10 @@ zsrv_err.c: zsrv_err.et .c.o: ${CC} -c ${ALL_CFLAGS} $< +zephyrd.8: ${srcdir}/zephyrd.8.in Makefile + ${editman} ${srcdir}/$@.in > $@.tmp + mv $@.tmp $@ + check: # No dependency on zephyrd, to avoid rebuilding version.o. @@ -59,6 +69,7 @@ install: clean: ${LIBTOOL} --mode=clean rm -f zephyrd rm -f ${OBJS} zsrv_err.[ch] + rm -f zephyrd.8 ${OBJS}: zserver.h zsrv_err.h timer.h zsrv_conf.h zstring.h access.h acl.h ${OBJS}: ${top_srcdir}/h/internal.h ${top_srcdir}/h/sysdep.h diff --git a/server/zephyrd.8 b/server/zephyrd.8 deleted file mode 100644 index abd1d6b..0000000 --- a/server/zephyrd.8 +++ /dev/null @@ -1,126 +0,0 @@ -.\" $Id$ -.\" -.\" Copyright 1987 by the Massachusetts Institute of Technology -.\" All rights reserved. The file /usr/include/zephyr/mit-copyright.h -.\" specifies the terms and conditions for redistribution. -.\" -.TH ZEPHYRD 8 "July 1, 1988" "MIT Project Athena" -.ds ]W MIT Project Athena -.SH NAME -zephyrd \- Zephyr server daemon -.SH SYNOPSIS -.I /usr/etc/zephyrd -[ -.BI \-d -] -.SH DESCRIPTION -.I zephyrd -is the central server for the Zephyr Notification System. -It maintains a location database of all currently logged-in users, and a -subscription database for each user's Zephyr clients. -.PP -.I zephyrd -communicates with daemons running on other Zephyr server hosts, to -provide a reliable service. -.PP -While running, any unusual conditions are recorded via -.I syslog(3) -to facility local6 at various levels. -The -.BI \-d -option enables logging of additional debugging information. -.PP -When a -.B zephyrd -is executed, it requests a list of server machines from Hesiod and -initializes its state from any -\fIzephyrd\fRs executing on the other known servers. This initialization -is only performed after the \fIzephyrd\fRs have authenticated themselves -to each other via Kerberos. -The server then enters a dispatch loop, servicing requests from clients and -other servers. -.SH SIGNALS -.B SIGUSR1 -enables logging of additional debugging information. -.br -.B SIGUSR2 -disables the logging of additional debugging information. -.br -.B SIGHUP -causes -.I zephyrd -to re-read the default subscription file and to re-query Hesiod about -valid peers. Any peers which are not responding and no longer -mentioned in Hesiod are flushed; any peers not previously named by -Hesiod are added. -.br -.B SIGINT \fRand\fB SIGTERM -cause -.I zephyrd -to gracefully shut down. -.br -.B SIGFPE -causes -.I zephyrd -to dump the location and subscription databases to -.I /var/tmp/zephyr.db -in an ASCII format. -.SH ACCESS CONTROL -Certain notice classes are restricted by the Zephyr server. Each such -class has access control lists enumerating who may transmit (xmt-*.acl) or -subscribe to that particular class. Subscriptions may be -restricted either absolutely (sub-*.acl files), or by instance restrictions. -iws-*.acl files control subscriptions to wildcarded instances. -iui-*.acl files control subscriptions to instances which are not the -Kerberos principal identity of the subscriber. -If an access control list of a given type is absent, there is no -restriction of that type on the class, except that any notices of the -class must be authenticated. -The class registry lists all classes which are restricted. -.SH FILES -.TP 10 -.I /etc/zephyr/acl/class-registry.acl: -List of classes which are restricted -.TP -.I /etc/zephyr/acl/iws-*.acl: -Access Control Lists for instance-wildcard restrictions -.TP -.I /etc/zephyr/acl/iui-*.acl: -Access Control Lists for instance-identity restrictions -.TP -.I /etc/zephyr/acl/sub-*.acl: -Access Control Lists for subscribing -.TP -.I /etc/zephyr/acl/xmt-*.acl: -Access Control Lists for transmitting -.TP -.I /etc/zephyr/srvtab: -Kerberos 4 Service keys -.TP -.I /etc/zephyr/krb5.keytab: -Kerberos V Service keys -.TP -.I /etc/zephyr/ztkts: -Current Kerberos tickets for exchange with other servers -.TP -.I /var/tmp/zephyr.db: -File containing an ASCII dump of the database. -.SH BUGS -The current implementation of the Zephyr server (\fIzephyrd(8)\fR) makes -no distinction between realm-announced, net-visible and net-announced -exposure levels. -.SH SEE ALSO -zephyr(1), zhm(8), kerberosintro(1), hesiod(3), access_control_lists(?), -syslog(3) -.br -Athena Technical Plan, Sections E.4.1 (Zephyr Notification Service) and -E.2.1 (Kerberos Authentication and Authorization System) -.SH AUTHOR -.PP -John T. Kohl, MIT Project Athena and Digital Equipment Corporation -.SH RESTRICTIONS -Copyright (c) 1987,1988 by the Massachusetts Institute of Technology. -All Rights Reserved. -.br -.I zephyr(1) -specifies the terms and conditions for redistribution. diff --git a/server/zephyrd.8.in b/server/zephyrd.8.in new file mode 100644 index 0000000..eef9780 --- /dev/null +++ b/server/zephyrd.8.in @@ -0,0 +1,129 @@ +.\" $Id$ +.\" +.\" Copyright 1987 by the Massachusetts Institute of Technology +.\" All rights reserved. The file /usr/include/zephyr/mit-copyright.h +.\" specifies the terms and conditions for redistribution. +.\" +.TH ZEPHYRD 8 "July 1, 1988" "MIT Project Athena" +.ds ]W MIT Project Athena +.SH NAME +zephyrd \- Zephyr server daemon +.SH SYNOPSIS +.I @sbindir@/zephyrd +[ +.BI \-d +] +.SH DESCRIPTION +.I zephyrd +is the central server for the Zephyr Notification System. +It maintains a location database of all currently logged-in users, and a +subscription database for each user's Zephyr clients. +.PP +.I zephyrd +communicates with daemons running on other Zephyr server hosts, to +provide a reliable service. +.PP +While running, any unusual conditions are recorded via +.I syslog(3) +to facility local6 at various levels. +The +.BI \-d +option enables logging of additional debugging information. +.PP +When a +.B zephyrd +is executed, it requests a list of server machines from Hesiod and +initializes its state from any +\fIzephyrd\fRs executing on the other known servers. This initialization +is only performed after the \fIzephyrd\fRs have authenticated themselves +to each other via Kerberos. +The server then enters a dispatch loop, servicing requests from clients and +other servers. +.SH SIGNALS +.B SIGUSR1 +enables logging of additional debugging information. +.br +.B SIGUSR2 +disables the logging of additional debugging information. +.br +.B SIGHUP +causes +.I zephyrd +to re-read the default subscription file and to re-query Hesiod about +valid peers. Any peers which are not responding and no longer +mentioned in Hesiod are flushed; any peers not previously named by +Hesiod are added. +.br +.B SIGINT \fRand\fB SIGTERM +cause +.I zephyrd +to gracefully shut down. +.br +.B SIGFPE +causes +.I zephyrd +to dump the location and subscription databases to +.I /var/tmp/zephyr.db +in an ASCII format. +.SH ACCESS CONTROL +Certain notice classes are restricted by the Zephyr server. Each such +class has access control lists enumerating who may transmit (xmt-*.acl) or +subscribe to that particular class. Subscriptions may be +restricted either absolutely (sub-*.acl files), or by instance restrictions. +iws-*.acl files control subscriptions to wildcarded instances. +iui-*.acl files control subscriptions to instances which are not the +Kerberos principal identity of the subscriber. +If an access control list of a given type is absent, there is no +restriction of that type on the class, except that any notices of the +class must be authenticated. +The class registry lists all classes which are restricted. +.SH FILES +.TP 10 +.I @sysconfdir@/zephyr/acl/class-registry.acl: +List of classes which are restricted +.TP +.I @sysconfdir@/zephyr/acl/iws-*.acl: +Access Control Lists for instance-wildcard restrictions +.TP +.I @sysconfdir@/zephyr/acl/iui-*.acl: +Access Control Lists for instance-identity restrictions +.TP +.I @sysconfdir@/zephyr/acl/sub-*.acl: +Access Control Lists for subscribing +.TP +.I @sysconfdir@/zephyr/acl/xmt-*.acl: +Access Control Lists for transmitting +.TP +.I @sysconfdir@/zephyr/srvtab: +Kerberos 4 Service keys +.TP +.I @sysconfdir@/zephyr/krb5.keytab: +Kerberos V Service keys +.TP +.I /var/run/zephyrd.tkt4: +Current Kerberos 4 tickets for exchange with other servers +.TP +.I /var/run/zephyrd.tkt: +Current Kerberos 5 tickets for exchange with other servers +.TP +.I /var/tmp/zephyr.db: +File containing an ASCII dump of the database. +.SH BUGS +The current implementation of the Zephyr server (\fIzephyrd(8)\fR) makes +no distinction between realm-announced, net-visible and net-announced +exposure levels. +.SH SEE ALSO +zephyr(1), zhm(8), kerberosintro(1), hesiod(3), access_control_lists(?), +syslog(3) +.br +Athena Technical Plan, Sections E.4.1 (Zephyr Notification Service) and +E.2.1 (Kerberos Authentication and Authorization System) +.SH AUTHOR +.PP +John T. Kohl, MIT Project Athena and Digital Equipment Corporation +.SH RESTRICTIONS +Copyright (c) 1987,1988 by the Massachusetts Institute of Technology. +All Rights Reserved. +.br +.I zephyr(1) +specifies the terms and conditions for redistribution. -- cgit v1.2.3