summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar John Kohl <jtkohl@mit.edu>1988-12-12 04:34:26 +0000
committerGravatar John Kohl <jtkohl@mit.edu>1988-12-12 04:34:26 +0000
commit91ad3644dca6b7ad607eeeecf52275a856e06430 (patch)
treeb901ca7b9d9da22def9f0714d4a93052eec8d39e
parentde822e871e7f8973595e0329af4b8865a63dae2d (diff)
fix some confusion about what recipients are valid
-rw-r--r--clients/zctl/zctl.126
1 files changed, 17 insertions, 9 deletions
diff --git a/clients/zctl/zctl.1 b/clients/zctl/zctl.1
index 8e04512..3e29e20 100644
--- a/clients/zctl/zctl.1
+++ b/clients/zctl/zctl.1
@@ -12,7 +12,8 @@
.SH NAME
zctl \- zephyr control program
.SH SYNOPSIS
-.B zctl [
+.B zctl
+[
.I options
]
.SH DESCRIPTION
@@ -31,6 +32,13 @@ The commands may be typed on the command line, or may be entered
interactively by just typing
.I zctl
and then typing commands to the prompt.
+.br
+.B NOTE:
+For all commands accepting an optional \fIrecipient\fR argument, the
+\fIrecipient\fR defaults to your Kerberos principal. You may also
+subscribe to recipient ``\fI*\fR''. Any other recipient is silently converted
+to ``\fI*\fR''.
+.br
The commands are as follows:
.TP 15
.B add \fIclass instance\fR [ \fIrecipient\fR ]
@@ -157,10 +165,8 @@ notices until a wg_startup command is issued.
.B wg_startup
Tell the WindowGram client to start accepting notices again; useful
after a wg_shutdown command has been issued.
-.PP
-The \fIrecipient\fR field defaults to your Kerberos principal. You
-may also subscribe to recipient ``*''. Any other recipient is silently
-converted to ``*''. There are three macros,
+.SH MACROS and SUBSCRIPTION FILES
+There are three macros,
.I %host%, %canon%, \fRand\fI %me%. %host%
is converted to the current hostname, \fI%canon%\fR is converted to the
official hostname as returned by
@@ -168,8 +174,10 @@ official hostname as returned by
and \fI%me%\fR is converted to your Kerberos principal. These macros can be
used in your \fI$HOME/.zephyr.subs\fR file or as arguments to commands
to specify the
-.I class, instance, \fRor\fI recipient
-fields. A sample file might contain the following:
+.I class
+or
+.I instance
+fields. A sample \fI$HOME/.zephyr.subs\fR file might contain the following:
.PP
.nf
message,urgent,%me%
@@ -179,8 +187,8 @@ fields. A sample file might contain the following:
.PP
.I Zctl
reads the environment variable \fBWGFILE\fR, to find the name of the
-file where the windowgram port resides. If \fBWGFILE\fR does not
-exist, the file defaults to /tmp/wg.\fIuid\fR, where \fIuid\fR is the
+file where the windowgram port resides. If \fBWGFILE\fR is not set,
+the file name defaults to /tmp/wg.\fIuid\fR, where \fIuid\fR is the
user's UNIX uid.
.SH UN-SUBSCRIPTIONS
The zephyr server,