annotate doc/popi.me @ 0:bce86c4163a3

Initial revision
author kono
date Mon, 18 Apr 2005 23:46:02 +0900
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
1 .\" This file is automatically generated. Do not edit!
bce86c4163a3 Initial revision
kono
parents:
diff changeset
2 .\" @(#)$Id$
bce86c4163a3 Initial revision
kono
parents:
diff changeset
3 .SC POPI 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 popi \- POP initiator
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 popi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[+folder]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-host\ host] \%[\-user\ user]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 \%[\-apop] \%[\-noapop]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 \%[\-rpop] \%[\-norpop]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 \%[\-form\ formatfile]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 \%[\-format\ string]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 \%[\-width\ columns]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 \%[\-help]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 .DE
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 \fIpopi\fR is an interactive program that implements the client side
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 of the Post Office Protocol (version 3).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20 When invoked,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 \fIpopi\fR establishes a POP connection,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 and enters a command loop.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 The user may type most of the normal POP commands,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 with a couple of additions:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 The commands that \fIpop\fR currently supports are:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26 .sp 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 .in +.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 dele msg
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30 last
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 list [msg]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 noop
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 quit
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38 retr msg
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40 rset
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 scan
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44 stat
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 top
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47 .in -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48 .sp
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49 The \fIretr\fR command retrieves a message into the folder specified
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 on the command line.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51 The \fIscan\fR command downloads an MH format-string to the server
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 (as determined from the `\-form\ formatfile' and `\-format switches),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53 so that future invocations of the \fIlist\fR command will include a
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54 scan listing.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 The \fIquit\fR command terminates \fIpopi\fR,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56 as does typing CTRL\-D.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 The `\-host\ host' switch specifies the POP server to use.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 If the `\-user\ user' switch is not given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 then the current username is used.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 Normally,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 \fIpopi\fR will prompt for a password to use.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64 However,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 if the `\-apop' switch is given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 \fIpopi\fR will generate authentication credentials to provide
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 for origin authentication and replay protection,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 but which do not involve sending a password in the clear over the network.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69 Otherwise,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 if the `\-rpop' switch is given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71 then \fIpopi\fR will try to use a \*(lqtrusted\*(rq connection
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 (ala the BSD r-commands).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 ^/usr/local/mh/lib/mtstailor~^tailor file
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77 ^Path:~^To determine the user's MH directory
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 ^Msg\-Protect:~^To set mode when creating a new `file'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81 msh(1)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
82 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
83 `+folder' defaults to \*(lqinbox\*(rq
bce86c4163a3 Initial revision
kono
parents:
diff changeset
84 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
85 `\-noapop'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
86 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
87 `\-norpop'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
88 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
89 `\-format' defaulted as described above
bce86c4163a3 Initial revision
kono
parents:
diff changeset
90 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
91 `\-width' defaulted to the width of the terminal
bce86c4163a3 Initial revision
kono
parents:
diff changeset
92 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
93 The folder into which messages are being incorporated will become the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
94 current folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
95 The current message is unchanged.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
96 .Bu
bce86c4163a3 Initial revision
kono
parents:
diff changeset
97 The argument to the `\-format' switch must be interpreted as a single token
bce86c4163a3 Initial revision
kono
parents:
diff changeset
98 by the shell that invokes \fIinc\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
99 Therefore,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
100 one must usually place the argument to this switch inside double\-quotes.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
101 .En