git.marmaro.de Git - mmh/blob - docs/historical/mh-6.8.5/conf/doc/RCS/popi.rf,v

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