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. --- zhm/Makefile.in | 13 ++++++- zhm/zhm.8 | 106 -------------------------------------------------------- zhm/zhm.8.in | 106 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 118 insertions(+), 107 deletions(-) delete mode 100644 zhm/zhm.8 create mode 100644 zhm/zhm.8.in (limited to 'zhm') diff --git a/zhm/Makefile.in b/zhm/Makefile.in index 801575d..cbaf6ab 100644 --- a/zhm/Makefile.in +++ b/zhm/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@ @@ -30,11 +36,15 @@ HESIOD_LIBS=@HESIOD_LIBS@ OBJS= timer.o queue.o zhm.o zhm_client.o zhm_server.o -all: zhm +all: zhm zhm.8 zhm: ${OBJS} ${LIBZEPHYR} ${LIBTOOL} --mode=link ${CC} ${LDFLAGS} -o $@ ${OBJS} ${LIBZEPHYR} ${HESIOD_LIBS} -lcom_err +zhm.8: ${srcdir}/zhm.8.in Makefile + ${editman} ${srcdir}/$@.in > $@.tmp + mv $@.tmp $@ + .c.o: ${CC} -c ${ALL_CFLAGS} $< @@ -47,6 +57,7 @@ install: zhm clean: ${LIBTOOL} --mode=clean rm -f zhm rm -f ${OBJS} + rm -f zhm.8 ${OBJS}: zhm.h timer.h ${top_srcdir}/h/internal.h ${top_srcdir}/h/sysdep.h ${OBJS}: ${BUILDTOP}/h/config.h ${BUILDTOP}/h/zephyr/zephyr.h diff --git a/zhm/zhm.8 b/zhm/zhm.8 deleted file mode 100644 index 6610e3f..0000000 --- a/zhm/zhm.8 +++ /dev/null @@ -1,106 +0,0 @@ -.\" $Id$ -.\" -.\" Copyright 1987, 1988 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 ZHM 8 "November 1, 1988" "MIT Project Athena" -.ds ]W MIT Project Athena -.SH NAME -zhm \- Zephyr HostManager -.SH SYNOPSIS -.B /usr/sbin/zhm -[ -.BI -d -] [ -.BI -n -] [ -.BI -h -] [ -.BI -r -] [ -.BI -i -] [ -.BI -f -] [ -.BI -N -] [ -.BI server -.BI ... -] -.SH DESCRIPTION -.I Zhm -is the link between a client machine and the zephyr server. All -notices sent from programs on the client are funneled through -.I zhm. -This allows all client programs to be much simpler in function, since -the HostManager is responsible for handling errors, retransmitting -lost notices, and holding all notices until they are acknowledged. -.PP -The -.I -d -option turns on debugging mode, and sends its information to syslog -LOG_DAEMON messages. -.PP -The -.I -n -option causes zhm to not attempt to put itself in the background. -.PP -The -.I -h -option causes -.I zhm -to send a shutdown message and exit upon delivery of a SIGHUP signal. -The normal action on SIGHUP is to send a flush notice to the zephyr server. -.PP -The -.I -r -option causes -.I zhm -to send a boot notice to the server and exit when the notice is acknowledged. -.PP -The -.I -i -option indicates that -.I zhm -is being started by -.I inetd(8). -When this option is specified, -.I zhm -assumes that file descriptor zero (0) is bound to the UDP datagram port -designated for hostmanager use. In this mode, SIGHUP is handled as if the -.I -h -option were specified. -.PP -The -.I -f -option disables the "flush" operation which allows any client to flush -all subscriptions for the host. -.PP -The -.I -N -option supresses the initial "boot" message that flushes all subscriptions -for the host, which is useful if you're restarting zhm on a host that -people are using. -.PP -The optional -.I server -arguments are used to replace the set of server names supplied by -the -.I hesiod(3) -name server. -.SH SEE ALSO -zephyr(1), zephyrd(8), inetd(8) -.br -Project Athena Technical Plan Section E.4.1, `Zephyr Notification -Service' -.SH AUTHOR -.PP -David C. Jedlinsky, MIT Project Athena -.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/zhm/zhm.8.in b/zhm/zhm.8.in new file mode 100644 index 0000000..15961dd --- /dev/null +++ b/zhm/zhm.8.in @@ -0,0 +1,106 @@ +.\" $Id$ +.\" +.\" Copyright 1987, 1988 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 ZHM 8 "November 1, 1988" "MIT Project Athena" +.ds ]W MIT Project Athena +.SH NAME +zhm \- Zephyr HostManager +.SH SYNOPSIS +.B @lsbindir@/zhm +[ +.BI -d +] [ +.BI -n +] [ +.BI -h +] [ +.BI -r +] [ +.BI -i +] [ +.BI -f +] [ +.BI -N +] [ +.BI server +.BI ... +] +.SH DESCRIPTION +.I Zhm +is the link between a client machine and the zephyr server. All +notices sent from programs on the client are funneled through +.I zhm. +This allows all client programs to be much simpler in function, since +the HostManager is responsible for handling errors, retransmitting +lost notices, and holding all notices until they are acknowledged. +.PP +The +.I -d +option turns on debugging mode, and sends its information to syslog +LOG_DAEMON messages. +.PP +The +.I -n +option causes zhm to not attempt to put itself in the background. +.PP +The +.I -h +option causes +.I zhm +to send a shutdown message and exit upon delivery of a SIGHUP signal. +The normal action on SIGHUP is to send a flush notice to the zephyr server. +.PP +The +.I -r +option causes +.I zhm +to send a boot notice to the server and exit when the notice is acknowledged. +.PP +The +.I -i +option indicates that +.I zhm +is being started by +.I inetd(8). +When this option is specified, +.I zhm +assumes that file descriptor zero (0) is bound to the UDP datagram port +designated for hostmanager use. In this mode, SIGHUP is handled as if the +.I -h +option were specified. +.PP +The +.I -f +option disables the "flush" operation which allows any client to flush +all subscriptions for the host. +.PP +The +.I -N +option supresses the initial "boot" message that flushes all subscriptions +for the host, which is useful if you're restarting zhm on a host that +people are using. +.PP +The optional +.I server +arguments are used to replace the set of server names supplied by +the +.I hesiod(3) +name server. +.SH SEE ALSO +zephyr(1), zephyrd(8), inetd(8) +.br +Project Athena Technical Plan Section E.4.1, `Zephyr Notification +Service' +.SH AUTHOR +.PP +David C. Jedlinsky, MIT Project Athena +.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