zephyr/clients/zwrite/zwrite.1

   1 .\"     $Id$
   2 .\"
   3 .\" Copyright 1987,1988 by the Massachusetts Institute of Technology
   4 .\" All rights reserved.  The file /usr/include/zephyr/mit-copyright.h
   5 .\" specifies the terms and conditions for redistribution.
   6 .\"
   7 .\"
   8 .TH ZWRITE 1 "October 26, 1989" "MIT Project Athena"
   9 .ds ]W MIT Project Athena
  10 .SH NAME
  11 zwrite \- write to another user via Zephyr
  12 .SH SYNOPSIS
  13 .B zwrite
  14 [
  15 .BI -a
  16 ] [
  17 .BI -d
  18 ] [
  19 .BI -v
  20 ] [
  21 .BI -q
  22 ] [
  23 .BI -t
  24 ] [
  25 .BI -u
  26 ] [
  27 .BI -o
  28 ] [
  29 .BI -n
  30 ] [
  31 .BI -l
  32 ] [
  33 .BI -C
  34 ] [
  35 .BI -O
  36 opcode ] [
  37 .BI -s
  38 signature ] [
  39 .BI -c
  40 class ] [
  41 .BI -i
  42 instance ] [
  43 .BI -r
  44 realm ] [
  45 .BI -f
  46 arg ] [
  47 .BI user \ ...
  48 ] [
  49 .BI -m
  50 .BI message
  51 ]
  52 .SH DESCRIPTION
  53 .I Zwrite
  54 sends a message from you to another user through the
  55 .I zephyr(1)
  56 notification service.  The user must have subscribed to messages of
  57 the appropriate class and instance using the
  58 .I zctl(1)
  59 program.
  60 .PP
  61 .I Zwrite
  62 understands the following options.
  63 .TP 12
  64 .B \-a
  65 Causes
  66 .I zwrite
  67 to send the message authenticated, using
  68 .I Kerberos
  69 to perform the authentication.  This is the default.
  70 .TP
  71 .B \-d
  72 Causes
  73 .I zwrite
  74 to send the message unauthenticated.
  75 .TP
  76 .B \-v
  77 Causes
  78 .I zwrite
  79 to print what type of message it is sending, and whether or not it was
  80 successful.
  81 .TP
  82 .B \-q
  83 Forces
  84 .I zwrite
  85 to suppress information about whether or not the message was sent.
  86 .TP
  87 .B \-t
  88 Prevents
  89 .I zwrite
  90 from expanding tabs in the message into appropriate spaces.  Normally
  91 .I zwrite
  92 will expand any tabs it finds into the appropriate number of spaces to
  93 maintain separation based on 8-character tab stops.
  94 .TP
  95 .B \-l
  96 Causes
  97 .I zwrite
  98 to ignore `.' on a line by itself in the input and only end a typed
  99 message when the user types the end-of-file character (usually
 100 control-D).  When the input is not a terminal, this is the default action.
 101 .TP
 102 .B \-u
 103 Sends an urgent message.  This changes the
 104 .I zephyr
 105 instance of the message to ``URGENT''.
 106 .TP
 107 .B \-o
 108 Causes
 109 .I zwrite
 110 to ignore the Zephyr variables
 111 .IR zwrite-class ,
 112 .IR zwrite-inst ,
 113 and
 114 .I zwrite-opcode
 115 when picking a default class, instance, and opcode.
 116 .TP
 117 .B \-n
 118 prevents
 119 .I zwrite
 120 from sending a PING message to verify the recipient is subscribing to
 121 messages.  By default,
 122 .I zwrite
 123 will send a notice to the destination class, instance, and recipient,
 124 with opcode ``PING'' before sending the message.  If the PING is sent,
 125 and the server response indicates there are no recipients subscribed to
 126 your message,
 127 .I zwrite
 128 exits without sending a message.
 129 When the
 130 .B \-m
 131 option is used, no PING is sent.
 132 .TP
 133 .B \-C
 134 prepends a "CC:" line to the body of the message indicating the
 135 recipients of the message. This is strictly a convenience: the
 136 presence of a "CC:" line at the top of a zephyr body does not
 137 necessarily indicate that this option was used, or that the message
 138 really was sent to the listed users, and its lack doesn't indicate
 139 that the message was not sent to multiple users.
 140 .TP
 141 .B \-s \fIsignature\fR
 142 sets the signature to be included in the message.  This overrides both
 143 the user's name (as found in the password file) and any
 144 setting of the Zephyr variable
 145 .IR zwrite-signature .
 146 .I signature
 147 must
 148 be a single argument, hence when using a shell it should be quoted with
 149 double quotes.  A
 150 .I signature
 151 argument of "" leaves the signature in
 152 the message empty.
 153 .TP
 154 .B \-c \fIclass\fR
 155 Allows a user to specify a different class for the message.  This allows
 156 a message to be sent to a large group of people with some degree of
 157 security.  See
 158 .I zephyr(1)
 159 and
 160 .I zephyrd(8)
 161 for a description of how to restrict access to classes.  When this option
 162 is specified, the message is sent to recipient "*" unless an additional
 163 list of recipients is specified.
 164 .br
 165 This argument may not be used in conjunction with the -f option.
 166 .TP
 167 .B \-i \fIinstance\fR
 168 Allows a user to specify a different instance than the default.
 169 When this option is used, the message is sent to recipient "*" unless an
 170 additional list of recipients is specified.  This allows a message to be
 171 sent to a large group of people (e.g. a development group) just by having
 172 the members subscribe to messages of class "MESSAGE", the specified instance,
 173 and recipient "*".
 174 .br
 175 This argument may not be used in conjunction with the -f option.
 176 .TP
 177 .B \-r \fIrealm\fR
 178 Allows a user to specify a different realm for the message, if the
 179 server supports interrealm Zephyr.
 180 .TP
 181 .B \-F \fIformat\fR
 182 Allows a user to specify a different default format for the message.
 183 .TP
 184 .B \-O \fIopcode\fR
 185 Allows a user to specify a different opcode for the message.
 186 Some Zephyr notice display programs may use the opcode to decide how
 187 to display a notice.
 188 .TP
 189 .B \-f \fIarg\fR
 190 Allows a user to specify an argument to be interpreted as a filesystem
 191 specification.  The class is set to
 192 .BR FILSRV .
 193 he instance is set
 194 to
 195 .I arg
 196 as modified:
 197 If
 198 .I arg
 199 contains no colons (`:'), it is assumed to
 200 be a host name, and it is converted into an official host name via
 201 .I gethostbyname(3).
 202 If
 203 .I arg
 204 contains a colon, the portion preceding the colon is
 205 treated as a host name, and the colon and any trailing characters are
 206 appended to the offical host name returned by
 207 .I gethostbyname.
 208 If the name fails to resolve into an official host name, the instance is
 209 set to
 210 .I arg
 211 unmodified.
 212 .br
 213 This option may not be used in conjunction with the -c or -i option.
 214 .TP
 215 .B \-m
 216 .I Zwrite
 217 sends the remaining arguments on the command line as the message.
 218 .PP
 219 If the
 220 .I \-m
 221 option is not specified, the user is prompted for the message to be
 222 sent.  The message may be terminated by typing ^D or ``.'' on a line
 223 by itself.
 224 .PP
 225 The default class for messages is ``MESSAGE'', the default instance
 226 is ``PERSONAL'', andthe default opcode is ``'' (an empty string).
 227 These defaults can be overridden by setting the Zephyr
 228 variables
 229 .IR zwrite-class ,
 230 .IR zwrite-inst ,
 231 and
 232 .IR zwrite-opcode ,
 233 respectively.
 234 Command-line options can override the defaults.
 235 .PP
 236 If the class is ``MESSAGE'' and the instance is either ``PERSONAL'' or
 237 ``URGENT'', a recipient must be specified.  These comparisons are
 238 case-sensitive.
 239 .PP
 240 Unless the
 241 .B \-s
 242 option is used, the contents of the Zephyr variable
 243 .I zwrite-signature
 244 are used to augment the user's username in the
 245 message.  If
 246 .I zwrite-signature
 247 is not set and the
 248 .B \-s
 249 option is not specified, the user's full name (as specified in the
 250 password file) is used instead.
 251 .SH BUGS
 252 Tab expansion should really be done by the receiver of the message.
 253 .br
 254 The \-u option is provided for compatibility with old versions of
 255 .I zwrite
 256 and is not necessarily useful for sending messages to users who do not
 257 have old subscription files.
 258 .SH SEE ALSO
 259 kerberosintro(1), zctl(1), zephyr(1), zwgc(1), zhm(8), zephyrd(8),
 260 gethostbyname(3)
 261 .br
 262 Project Athena Technical Plan Section E.4.1, `Zephyr Notification
 263 Service'
 264 .SH FILES
 265 /etc/passwd
 266 .br
 267 $ZEPHYR_VARS or $HOME/.zephyr.vars
 268 .SH AUTHOR
 269 .PP
 270 .br
 271 Robert S. French (MIT-Project Athena)
 272 .SH RESTRICTIONS
 273 Copyright (c) 1987,1988 by the Massachusetts Institute of Technology.
 274 All Rights Reserved.
 275 .br
 276 .I zephyr(1)
 277 specifies the terms and conditions for redistribution.