~ubuntu-branches/debian/wheezy/courier/wheezy

« back to all changes in this revision

Viewing changes to imap/courierpop3d.8.in

  • Committer: Bazaar Package Importer
  • Author(s): Stefan Hornburg (Racke)
  • Date: 2009-03-08 16:42:08 UTC
  • mfrom: (1.2.1 upstream) (4.1.1 sid)
  • Revision ID: james.westby@ubuntu.com-20090308164208-nlve2wtx9bbrulmd
Tags: 0.61.2-1
* New upstream release.
* Lintian:
  - fix chown in courier-webadmin postinst
  - removed courier-base preinst
  - added debhelper token to courier-mta.preinst
  - removed *.conffiles

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
.\"  <!-- distribution information. -->
4
4
.\"     Title: courierpop3d
5
5
.\"    Author: 
6
 
.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
7
 
.\"      Date: 04/22/2007
 
6
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
 
7
.\"      Date: 08/24/2008
8
8
.\"    Manual: Double Precision, Inc.
9
9
.\"    Source: Double Precision, Inc.
10
10
.\"
11
 
.TH "COURIERPOP3D" "8" "04/22/2007" "Double Precision, Inc." "Double Precision, Inc."
 
11
.TH "COURIERPOP3D" "8" "08/24/2008" "Double Precision, Inc." "Double Precision, Inc."
12
12
.\" disable hyphenation
13
13
.nh
14
14
.\" disable justification (adjust text to left margin only)
15
15
.ad l
16
16
.SH "NAME"
17
 
courierpop3d \- Courier POP3 server
 
17
courierpop3d - Courier POP3 server
18
18
.SH "SYNOPSIS"
19
19
.HP 22
20
 
\fB@sbindir@/couriertcpd\fR {\-nodnslookup} {\-stderr=syslog} {110} {@libexecdir@/courier/courierpop3login} [\fImodules\fR...] {@libexecdir@/courier/courierpop3d} {./Maildir}
 
20
\fB@sbindir@/couriertcpd\fR {\-nodnslookup} {\-stderr=syslog} {110} {@libexecdir@/courier/courierpop3login} [\fImodules\fR...] {@libexecdir@/courier/courierpop3d} {\./Maildir}
21
21
.SH "DESCRIPTION"
22
22
.PP
23
 
This is a simple POP3 server for Maildirs.
 
23
This is a simple POP3 server for Maildirs\.
24
24
.sp
25
25
.it 1 an-trap
26
26
.nr an-no-space-flag 1
27
27
.nr an-break-flag 1
28
28
.br
29
 
\fBNote\fR
 
29
Note
30
30
.PP
31
31
The
32
32
\fBcouriertcpd\fR,
33
33
\fBcourierpop3login\fR, and
34
34
\fBcourierpop3d\fR
35
 
modules may be installed elsewhere than indicated here.
 
35
modules may be installed elsewhere than indicated here\.
36
36
.PP
37
37
 
38
38
\fBcourierpop3login\fR
39
39
is usually started by
40
 
\fBcouriertcpd\fR. It already expects that a POP3 client is connected to standard input and output, presumably via a network socket.
 
40
\fBcouriertcpd\fR\. It already expects that a POP3 client is connected to standard input and output, presumably via a network socket\.
41
41
\fBcourierpop3login\fR
42
42
reads the POP3 userid and password, then runs the authentication
43
 
modules. The remaining arguments are passed along as arguments to
44
 
modules.
 
43
modules\. The remaining arguments are passed along as arguments to
 
44
modules\.
45
45
.PP
46
46
 
47
47
modules
48
48
is one or more authentication modules (see the
49
49
\fI\fBauthlib\fR(7) \fR\&[1]
50
 
manual page).
 
50
manual page)\.
51
51
.PP
52
 
Each authentication modules runs the program specified by its first argument, allowing the authentication modules to be chained. The last program in the chain is
 
52
Each authentication modules runs the program specified by its first argument, allowing the authentication modules to be chained\. The last program in the chain is
53
53
\fBcourierpop3d\fR
54
 
, which provides the actual POP3 service. In accordance with the authentication protocol, as described in
 
54
, which provides the actual POP3 service\. In accordance with the authentication protocol, as described in
55
55
\fI\fBauthlib\fR(7) \fR\&[1]
56
56
\fBcourierpop3d\fR
57
 
reads file descriptor 3 to see if the userid/password has been succesfully validated. If not,
 
57
reads file descriptor 3 to see if the userid/password has been succesfully validated\. If not,
58
58
\fBcourierpop3d\fR
59
 
terminates.
 
59
terminates\.
60
60
.PP
61
61
Otherwise,
62
62
\fBcourierpop3d\fR
63
 
expects to be already running under the appropriate user and group id, with its current directory set to the account's home directory.
 
63
expects to be already running under the appropriate user and group id, with its current directory set to the account\'s home directory\.
64
64
.PP
65
 
The first order of business is to find the account's Maildir. If the environment variable
66
 
\fBMAILDIR\fR
67
 
is set, that's where we go. That should be the pathname to the account's Maildir. The environment variable
68
 
\fBMAILDIR\fR
69
 
may be set by the authentication module. If
 
65
The first order of business is to find the account\'s Maildir\. If the environment variable
 
66
\fBMAILDIR\fR
 
67
is set, that\'s where we go\. That should be the pathname to the account\'s Maildir\. The environment variable
 
68
\fBMAILDIR\fR
 
69
may be set by the authentication module\. If
70
70
\fBMAILDIR\fR
71
71
is not set,
72
72
\fBcourierpop3d\fR
73
 
uses its first argument. Usually, the default maildir is
 
73
uses its first argument\. Usually, the default maildir is
74
74
\fI$HOME/Maildir\fR, therefore the first argument to
75
75
\fBcourierpop3d\fR
76
 
is "./Maildir".
 
76
is "\./Maildir"\.
77
77
.SH "SEE ALSO"
78
78
.PP
79
79
 
80
80
\fI\fBauthlib\fR(7) \fR\&[1],
81
 
\fI\fBuserdb\fR(8) \fR\&[2].
82
 
.SH "REFERENCES"
 
81
\fI\fBuserdb\fR(8) \fR\&[2]\.
 
82
.SH "NOTES"
83
83
.IP " 1." 4
84
84
\fBauthlib\fR(7)
85
85
.RS 4