Put Nd argument after Nd macro.
[heimdal.git] / appl / popper / popper.8
blob9d2d865f373d0ea2976996e7d9b0696411104dad
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 POP3 server
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl k
43 .Op Fl a Ar plaintext Ns \*(Ba Ns Ar otp Ns \*(Ba Ns Ar sasl
44 .Op Fl t Ar file
45 .Op Fl T Ar seconds
46 .Op Fl d
47 .Op Fl i
48 .Op Fl p Ar port
49 .Op Fl Fl address-log= Ns Pa file
50 .Sh DESCRIPTION
51 .Nm
52 serves mail via the Post Office Protocol.  Supported options include:
53 .Bl -tag -width Ds
54 .It Fl a Ar plaintext Ns \*(Ba Ns Ar otp Ns \*(Ba Ns Ar sasl
55 Tells
56 .Nm
57 which authentication mode is acceptable, 
58 .Ar sasl
59 enables SASL (RFC2222),  and
60 .Ar otp
61 enables OTP (RFC1938) authentication. Both disable plaintext passwords.
62 .It Fl Fl address-log= Ns Pa file
63 Logs the addresses (along with a timestamp) of all clients to the
64 specified file. This can be used to implement POP-before-SMTP
65 authentication.
66 .It Fl d
67 Enables more verbose log messages.
68 .It Fl i
69 When not started by inetd, this flag tells
70 .Nm
71 that it has to create a socket by itself.
72 .It Fl k
73 Tells
74 .Nm
75 to use Kerberos for authentication. This is the traditional way of
76 doing Kerberos authentication, and is normally done on a separate port
77 (as it doesn't follow RFC1939), and should be used instead of using
78 SASL.
79 .It Fl p Ar port
80 Port to listen to, in combination with
81 .Fl i .
82 .It Fl t Ar file
83 Trace all commands to file.
84 .It Fl T Ar seconds
85 Set timeout to something other than the default of 120 seconds.
86 .El
87 .\".Sh ENVIRONMENT
88 .\".Sh FILES
89 .\".Sh EXAMPLES
90 .\".Sh DIAGNOSTICS
91 .Sh SEE ALSO
92 .Xr push 8 ,
93 .Xr movemail 8
94 .Sh STANDARDS
95 RFC1939 (Post Office Protocol - Version 3)
96 .\" RFC2449 (POP3 Extension Mechanism)
97 .\".Sh HISTORY
98 .Sh AUTHORS
99 The server was initially developed at the University of California,
100 Berkeley.
102 Many changes have been made as part of the KTH Kerberos distributions.
103 .\".Sh BUGS