Mercurial > hg > Applications > mh

comparison conf/doc/popi.rf @ 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 441a2190cfae
comparison
equal deleted inserted replaced
-1:000000000000 0:bce86c4163a3
1 .\" @(MHWARNING)
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 @BEGIN: BPOP
13 \%[\-auto] \%[\-noauto]
14 \%[\-mshproc\ program]
15 @END: BPOP
16 \%[\-form\ formatfile]
17 \%[\-format\ string]
18 \%[\-width\ columns]
19 \%[\-help]
20 .DE
21 \fIpopi\fR is an interactive program that implements the client side
22 of the Post Office Protocol (version 3).
23
24 When invoked,
25 \fIpopi\fR establishes a POP connection,
26 and enters a command loop.
27 The user may type most of the normal POP commands,
28 with a couple of additions:
29 The commands that \fIpop\fR currently supports are:
30 .sp 1
31 .in +.5i
32 dele msg
33 .br
34 last
35 .br
36 list [msg]
37 .br
38 noop
39 .br
40 quit
41 .br
42 retr msg
43 .br
44 rset
45 .br
46 scan
47 .br
48 stat
49 .br
50 top
51 @BEGIN: BPOP
52 .br
53 msh
54 @END: BPOP
55 .in -.5i
56 .sp
57 The \fIretr\fR command retrieves a message into the folder specified
58 on the command line.
59 The \fIscan\fR command downloads an MH format-string to the server
60 (as determined from the `\-form\ formatfile' and `\-format switches),
61 so that future invocations of the \fIlist\fR command will include a
62 scan listing.
63 The \fIquit\fR command terminates \fIpopi\fR,
64 as does typing CTRL\-D.
65
66 @BEGIN: BPOP
67 The \fImsh\fR command invokes the \fImshproc\fR.
68 To override the default \fImshproc\fR and the profile entry,
69 use the `\-mshproc\ program' switch.
70 The `\-auto' switch causes \fIpopi\fR to invoke the \fImshproc\fR directly,
71 and thence terminate when the \fImshproc\fR terminates.
72 @END: BPOP
73
74 The `\-host\ host' switch specifies the POP server to use.
75 If the `\-user\ user' switch is not given,
76 then the current username is used.
77 Normally,
78 \fIpopi\fR will prompt for a password to use.
79 However,
80 if the `\-apop' switch is given,
81 \fIpopi\fR will generate authentication credentials to provide
82 for origin authentication and replay protection,
83 but which do not involve sending a password in the clear over the network.
84 Otherwise,
85 if the `\-rpop' switch is given,
86 then \fIpopi\fR will try to use a \*(lqtrusted\*(rq connection
87 (ala the BSD r-commands).
88 .Fi
89 ^$HOME/\&.mh\(ruprofile~^The user profile
90 ^@(MHETCPATH)/mtstailor~^tailor file
91 .Pr
92 ^Path:~^To determine the user's MH directory
93 .Ps
94 ^Msg\-Protect:~^To set mode when creating a new `file'
95 @BEGIN: BPOP
96 .Ps
97 ^mshproc:~^Program to read a given BBoard
98 @END: BPOP
99 .Sa
100 msh(1)
101 .De
102 `+folder' defaults to \*(lqinbox\*(rq
103 .Ds
104 `\-noapop'
105 .Ds
106 `\-norpop'
107 @BEGIN: BPOP
108 .Ds
109 `\-auto'
110 @END: BPOP
111 .Ds
112 `\-format' defaulted as described above
113 .Ds
114 `\-width' defaulted to the width of the terminal
115 .Co
116 The folder into which messages are being incorporated will become the
117 current folder.
118 The current message is unchanged.
119 .Bu
120 The argument to the `\-format' switch must be interpreted as a single token
121 by the shell that invokes \fIinc\fR.
122 Therefore,
123 one must usually place the argument to this switch inside double\-quotes.
124 .En