view conf/doc/popi.rf @ 0:bce86c4163a3

Initial revision
author kono
date Mon, 18 Apr 2005 23:46:02 +0900
parents
children 441a2190cfae
line wrap: on
line source

.\"	@(MHWARNING)
.\" @(#)$Id$
.SC POPI 1
.NA
popi \- POP initiator
.SY
popi
\%[+folder]
\%[\-host\ host] \%[\-user\ user]
\%[\-apop] \%[\-noapop]
\%[\-rpop] \%[\-norpop]
@BEGIN: BPOP
\%[\-auto] \%[\-noauto]
\%[\-mshproc\ program]
@END: BPOP
\%[\-form\ formatfile]
\%[\-format\ string]
\%[\-width\ columns]
\%[\-help]
.DE
\fIpopi\fR is an interactive program that implements the client side
of the Post Office Protocol (version 3).

When invoked,
\fIpopi\fR establishes a POP connection,
and enters a command loop.
The user may type most of the normal POP commands,
with a couple of additions:
The commands that \fIpop\fR currently supports are:
.sp 1
.in +.5i
dele msg 
.br
last
.br
list [msg]
.br
noop
.br
quit
.br
retr msg
.br
rset
.br
scan
.br
stat
.br
top
@BEGIN: BPOP
.br
msh
@END: BPOP
.in -.5i
.sp
The \fIretr\fR command retrieves a message into the folder specified
on the command line.
The \fIscan\fR command downloads an MH format-string to the server
(as determined from the `\-form\ formatfile' and `\-format switches),
so that future invocations of the \fIlist\fR command will include a
scan listing.
The \fIquit\fR command terminates \fIpopi\fR,
as does typing CTRL\-D.

@BEGIN: BPOP
The \fImsh\fR command invokes the \fImshproc\fR.
To override the default \fImshproc\fR and the profile entry,
use the `\-mshproc\ program' switch.
The `\-auto' switch causes \fIpopi\fR to invoke the \fImshproc\fR directly,
and thence terminate when the \fImshproc\fR terminates.
@END: BPOP

The `\-host\ host' switch specifies the POP server to use.
If the `\-user\ user' switch is not given,
then the current username is used.
Normally,
\fIpopi\fR will prompt for a password to use.
However,
if the `\-apop' switch is given,
\fIpopi\fR will generate authentication credentials to provide
for origin authentication and replay protection,
but which do not involve sending a password in the clear over the network.
Otherwise,
if the `\-rpop' switch is given,
then \fIpopi\fR will try to use a \*(lqtrusted\*(rq connection
(ala the BSD r-commands).
.Fi
^$HOME/\&.mh\(ruprofile~^The user profile
^@(MHETCPATH)/mtstailor~^tailor file
.Pr
^Path:~^To determine the user's MH directory
.Ps
^Msg\-Protect:~^To set mode when creating a new `file'
@BEGIN: BPOP
.Ps
^mshproc:~^Program to read a given BBoard
@END: BPOP
.Sa
msh(1)
.De
`+folder' defaults to \*(lqinbox\*(rq
.Ds
`\-noapop'
.Ds
`\-norpop'
@BEGIN: BPOP
.Ds
`\-auto'
@END: BPOP
.Ds
`\-format' defaulted as described above
.Ds
`\-width' defaulted to the width of the terminal
.Co
The folder into which messages are being incorporated will become the
current folder.
The current message is unchanged.
.Bu
The argument to the `\-format' switch must be interpreted as a single token
by the shell that invokes \fIinc\fR.
Therefore,
one must usually place the argument to this switch inside double\-quotes.
.En