Mercurial > hg > Applications > mh

comparison doc/popi.me @ 0:bce86c4163a3

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