stand.1

   1 .TH STAND 1
   2 .\"
   3 .\" stand.1: manual page for stand
   4 .\"
   5 .\" Copyright Mark Longair (c) 2002, 2005, 2008 Reuben Thomas (c) 2005-2007. All rights reserved.
   6 .\"
   7 .\" Version 0.9
   8 .\"
   9
  10 .\" Text begins
  11 .SH NAME
  12 stand \- A simple POP3 client
  13 .SH SYNOPSIS
  14 .B stand
  15 [\fIOPTION\fR]...
  16 .SH DESCRIPTION
  17 .PP
  18 This is a simple POP3 client that will fetch messages from POP3
  19 servers and deliver then to a local delivery agent (LDA) such as
  20 procmail or maildrop.  This client supports APOP and
  21 SSL/TLS-wrapped POP3.  UIDL caching is implemented to avoid
  22 downloading the same message multiple times.
  23 .SH OPTIONS
  24 .TP
  25 \fB\-h\fR, \fB\-\-help\fR
  26 Display a usage message and exit.
  27 .TP
  28 \fB\-k\fR, \fB\-\-keep\fR
  29 Don't delete messages on server.
  30 .TP
  31 \fB\-n\fR, \fB\-\-no\-ssl\-verify\fR
  32 Don't verify the peer's certificate when using SSL.
  33 .TP
  34 \fB\-f\fR \fIFILENAME\fR, \fB\-\-configuration\-file\fR=\fIFILENAME\fR
  35 Specify the configuration file to use. (default: ~/.stand.yaml)
  36 .TP
  37 \fB\-r\fR \fISECONDS\fR, \fB\-\-reconnect\-after\fR=\fISECONDS\fR
  38 Reconnect to the server if SECONDS seconds has elapsed since
  39 the last connection.  This is useful if you are using a slow or
  40 unreliable connection and downloading many messages, since the
  41 remote mailspool will be updated on each reconnection.
  42 .SH FILES
  43 .TP
  44 .B ~/.stand.yaml
  45 This is the configuration file for stand, which contains details
  46 of the POP3 accounts to be checked, and the LDA (Local Delivery
  47 Agent) to be used for each.  This file is in YAML format and
  48 consists of a sequence of mappings.  The details for each
  49 account must be separated by a line with a single '-', and the
  50 settings for each account must be consistently indented with one
  51 or more spaces.  An example is given below:
  52 .nf
  53
  54    # The 'Host', 'User' and 'Pass' lines are required.  The
  55    # 'SSL' option defaults to "no", the 'APOP' option defaults
  56    # to "no" and 'Command' defaults to "procmail -f-".  'Port'
  57    # defaults to 110 (or 995 when SSL is turned on).
  58    -
  59      Host: secure.mythic-beasts.com
  60      SSL: yes
  61      User: mark
  62      Pass: not-my-password
  63      Command: procmail -f-
  64    -
  65      Host: localhost
  66      User: a@b.c
  67      Pass: not-my-password-either
  68      Command: procmail -f-
  69      APOP: yes
  70 .fi
  71 .TP
  72 .B ~/.stand-uidls
  73 This file is an SQLite database which stores UIDLs of messages
  74 that have been downloaded from POP3 servers by stand, but which
  75 have not yet been deleted.
  76 .SH AUTHOR
  77 Mark Longair <mhl@pobox.com>, Reuben Thomas <rrt@sc3d.org>
  78 .SH VERSION
  79 Version 0.9
  80 .SH COPYING
  81 .PP
  82 This program is free software: you can redistribute it and/or modify
  83 it under the terms of the GNU General Public License as published by
  84 the Free Software Foundation, either version 3 of the License, or
  85 (at your option) any later version.
  86 .PP
  87 This program is distributed in the hope that it will be useful,
  88 but WITHOUT ANY WARRANTY; without even the implied warranty of
  89 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  90 GNU General Public License for more details.
  91 .PP
  92 You should have received a copy of the GNU General Public License
  93 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  94 .PP
  95 On Debian systems, the complete text of the GNU General
  96 Public License version 3 can be found in `/usr/share/common-licenses/GPL'.
  97 .PP
  98 The Debian packaging is (C) 2008, Mark Longair <mhl@pobox.com> and
  99 is licensed under the GPL, see above.