.TH CHPOBOX 1 "5 Feb 1988" "Project Athena"
\" RCSID: $Header$
.SH NAME
-chpobox \- change where user receives mail
+chpobox \- change address at which user receives mail
.SH SYNOPSIS
-.B chpobox
-[ -d|a address] [-u username]
+.TP 8
+chpobox [ username ]
+.TP 8
+chpobox [ \-s address | \-S address | \-p ] [ \-u username ]
.SH DESCRIPTION
-This command adds a new mailbox, deletes and existing mailbox, or
-lists the mailboxes currently assigned to
-.IR username
-(your own name by default).
-If neither the
-.B -a
-or the
-.B -d
-option is given, the current mailboxes will be displayed.
-The options will attempt to add or delete the specified mailbox.
-A mailbox address is of the form
-.I string@hostname,
-where the string is usually the username, and the hostname is the name
-of the machine the user wishes to receive mail on.
+Your post office box is what determines where you will receive
+mail. It can be of several types:
+.I POP, IMAP, SMTP, SPLIT
+or
+.IR NONE .
+
+In the first use of this command, the post office box of the
+user whose name corresponds to the single argument
+.I username
+(or your own name if
+.I username
+is not specified) is displayed.
+
+In the second use, this command sets the
+actual address that will receive mail sent to
+.I username@MIT.EDU
+(where
+.I username
+is your own name if you have not specified it on the command line).
+It should be used if you want to change where you will
+receive mail.
+
+The
+.I chpobox
+command is used instead of the file
+.I .forward,
+which would be used with standard UNIX mail.
+
+In order to change the address that receives mail sent to
+.I username@MIT.EDU,
+use the
+.B -s
+option. Specifically, to reroute your mail to
+the address
+.I name@host,
+you would issue the command
+
+.nf
+.nj
+chpobox -s name@host
+.fi
+
+To split mail between your local post office box and a remote address,
+use the
+.B -S
+option.
+
+To restore your post office box to its original Athena default,
+use the
+.B -p
+flag. This will set your mailbox to the last POP or IMAP server
+it was using.
.PP
-.B chpobox
-will determine if the mailbox is of type POP, LOCAL, or FOREIGN based
-on information in the SMS database, and then make the appropriate
-change in the SMS database.
-It will not allow a user to have more than one mailbox of type POP,
-and it will not allow a user to delete his last mailbox.
-The actual change will take place a couple of hours later.
-Users may only change their own information unless they are
-SMS database administrators.
-.SH "SEE ALSO"
-usermaint(1),
-SMS Section of the Project Athena Technical Plan.
+
+Only one of
+.B -p
+or
+.B -s
+or
+.B -S
+may be used at a time.
+
+Note that the actual change may take up to a day to
+propogate to the mail hub.
+
+.SH NOTE
+
+When a mailbox is stored in the central database, any host mentioned
+will have its name canonicalized to a standard form. If for some
+reason you don't want to have the hostname canonicalized, put
+.B just the hostname
+in double-quotes. For example, the command
+.nf
+.nj
+ chpobox -s jrhacker@\\"cd.mit.edu\\"
+.fi
+will not be canonicalized to jrhacker@ls.mit.edu, as it would
+otherwise. Also note that the double-quotes were preceded by
+backslashes to get them past the shell.
+
+.SH SEE ALSO
+moira(1),
+
+Moira Section of the Project Athena Technical Plan.
andersk / moira.git / blobdiff