s4:heimdal A real fix for bug 6801
[heimdal.git] / appl / popper / popper.8
bloba6515a0cb2ce76914098524ea075f38c3e1d40e2
1 .\" Copyright (c) 2001 - 2004 Kungliga Tekniska Högskolan
2 .\" (Royal Institute of Technology, Stockholm, Sweden). 
3 .\" All rights reserved. 
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without 
6 .\" modification, are permitted provided that the following conditions 
7 .\" are met: 
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright 
10 .\"    notice, this list of conditions and the following disclaimer. 
11 .\"
12 .\" 2. Redistributions in binary form must reproduce the above copyright 
13 .\"    notice, this list of conditions and the following disclaimer in the 
14 .\"    documentation and/or other materials provided with the distribution. 
15 .\"
16 .\" 3. Neither the name of the Institute nor the names of its contributors 
17 .\"    may be used to endorse or promote products derived from this software 
18 .\"    without specific prior written permission. 
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND 
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE 
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
30 .\" SUCH DAMAGE. 
31 .\" 
32 .\" $Id$
33 .\"
34 .Dd July 14, 2004
35 .Dt POPPER 8
36 .Os HEIMDAL
37 .Sh NAME
38 .Nm popper
39 .Nd
40 POP3 server
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl k
44 .Op Fl a Ar plaintext Ns \*(Ba Ns Ar otp Ns \*(Ba Ns Ar sasl
45 .Op Fl t Ar file
46 .Op Fl T Ar seconds
47 .Op Fl d
48 .Op Fl i
49 .Op Fl p Ar port
50 .Op Fl -address-log= Ns Pa file
51 .Sh DESCRIPTION
52 .Nm
53 serves mail via the Post Office Protocol.  Supported options include:
54 .Bl -tag -width Ds
55 .It Fl a Ar plaintext Ns \*(Ba Ns Ar otp Ns \*(Ba Ns Ar sasl
56 Tells
57 .Nm
58 which authentication mode is acceptable, 
59 .Ar sasl
60 enables SASL (RFC2222),  and
61 .Ar otp
62 enables OTP (RFC1938) authentication. Both disable plaintext passwords.
63 .It Fl -address-log= Ns Pa file
64 Logs the addresses (along with a timestamp) of all clients to the
65 specified file. This can be used to implement POP-before-SMTP
66 authentication.
67 .It Fl d
68 Enables more verbose log messages.
69 .It Fl i
70 When not started by inetd, this flag tells
71 .Nm
72 that it has to create a socket by itself.
73 .It Fl k
74 Tells
75 .Nm
76 to use Kerberos for authentication. This is the traditional way of
77 doing Kerberos authentication, and is normally done on a separate port
78 (as it doesn't follow RFC1939), and should be used instead of using
79 SASL.
80 .It Fl p Ar port
81 Port to listen to, in combination with
82 .Fl i .
83 .It Fl t Ar file
84 Trace all commands to file.
85 .It Fl T Ar seconds
86 Set timeout to something other than the default of 120 seconds.
87 .El
88 .\".Sh ENVIRONMENT
89 .\".Sh FILES
90 .\".Sh EXAMPLES
91 .\".Sh DIAGNOSTICS
92 .Sh SEE ALSO
93 .Xr push 8 ,
94 .Xr movemail 8
95 .Sh STANDARDS
96 RFC1939 (Post Office Protocol - Version 3)
97 .\" RFC2449 (POP3 Extension Mechanism)
98 .\".Sh HISTORY
99 .Sh AUTHORS
100 The server was initially developed at the University of California,
101 Berkeley.
103 Many changes have been made as part of the KTH Kerberos distributions.
104 .\".Sh BUGS