.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PURE-FTPD-WRAPPER 8"
.TH PURE-FTPD-WRAPPER 8 2024-01-11 "Debian GNU/Linux trixie/sid" "Debian GNU/Linux Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
pure\-ftpd\-wrapper \- configures and starts Pure\-FTPd daemon
.SH SYNOPSIS
.IX Header "SYNOPSIS"
pure-ftpd-wrapper
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBpure-ftpd-wrapper\fR reads the configuration for the Pure-FTPd daemon
from files in the directory \fI/etc/pure\-ftpd/conf\fR. Each file in this
directory is related to a command line option. No more than one
line with configuration values is allowed. Empty lines or lines
starting with the comment character \f(CW\*(C`#\*(C'\fR are discarded.
.PP
The Pure-FTPd daemon allows one to use different authentication methods
together. The authentication methods are tried in the order they are
specified on the command line. In order to achieve the same flexibility
with files in the \fI/etc/pure\-ftpd\fR directory, \fBpure-ftpd-wrapper\fR
checks all valid symbolic links within the directory \fI/etc/pure\-ftpd/auth\fR
in alphabetical order. E.g., a link in this directory pointing to
\&\fI/etc/pure\-ftpd/conf/PureDB\fR would enable authentication against
a PureDB database.
.PP
There are no means to configure the \fIPIDFile\fR setting, it is hardwired
to /var/run/pure\-ftpd/pure\-ftpd.pid in this script.
.PP
You can display the Pure-FTPd commandline options with \f(CW\*(C`\-s\*(C'\fR or
\&\f(CW\*(C`\-\-show\-options\*(C'\fR:
.PP
.Vb 1
\&    pure\-ftpd\-wrapper \-\-show\-options
.Ve
.SH CONFIGURATION
.IX Header "CONFIGURATION"
.SS "Boolean values"
.IX Subsection "Boolean values"
The strings \f(CW\*(C`Yes\*(C'\fR,\f(CW1\fR,\f(CW\*(C`On\*(C'\fR enable the corresponding commandline option
(case doesn't matter). To disable the option use \f(CW\*(C`No\*(C'\fR,\f(CW0\fR or \f(CW\*(C`Off\*(C'\fR.
.PP
Configuration files containing boolean values are \f(CW\*(C`AllowAnonymousFXP\*(C'\fR,
\&\f(CW\*(C`AllowDotFiles\*(C'\fR, \f(CW\*(C`AllowUserFXP\*(C'\fR, \f(CW\*(C`AnonymousCanCreateDirs\*(C'\fR,
\&\f(CW\*(C`AnonymousCantUpload\*(C'\fR, \f(CW\*(C`AnonymousOnly\*(C'\fR, \f(CW\*(C`AntiWarez\*(C'\fR, \f(CW\*(C`AutoRename\*(C'\fR,
\&\f(CW\*(C`BrokenClientsCompatibility\*(C'\fR, \f(CW\*(C`CallUploadScript\*(C'\fR, \f(CW\*(C`ChrootEveryone\*(C'\fR,
\&\f(CW\*(C`CreateHomeDir\*(C'\fR, \f(CW\*(C`CustomerProof\*(C'\fR, \f(CW\*(C`Daemonize\*(C'\fR, \f(CW\*(C`DisplayDotFiles\*(C'\fR,
\&\f(CW\*(C`DontResolve\*(C'\fR, \f(CW\*(C`IPV4Only\*(C'\fR, \f(CW\*(C`IPV6Only\*(C'\fR, \f(CW\*(C`KeepAllFiles\*(C'\fR, \f(CW\*(C`LogPID\*(C'\fR,
\&\f(CW\*(C`NATmode\*(C'\fR, \f(CW\*(C`NoAnonymous\*(C'\fR, \f(CW\*(C`NoChmod\*(C'\fR, \f(CW\*(C`NoRename\*(C'\fR, \f(CW\*(C`NoTruncate\*(C'\fR,
\&\f(CW\*(C`PAMAuthentication\*(C'\fR, \f(CW\*(C`ProhibitDotFilesRead\*(C'\fR, \f(CW\*(C`ProhibitDotFilesWrite\*(C'\fR,
\&\f(CW\*(C`UnixAuthentication\*(C'\fR and \f(CW\*(C`VerboseLog\*(C'\fR.
.SS "Numerical values"
.IX Subsection "Numerical values"
There are several types of numerical values (one number, two numbers,
one or two numbers, two octal numbers).
.IP "One number" 4
.IX Item "One number"
\&\f(CW\*(C`MaxClientsNumber\*(C'\fR, \f(CW\*(C`MaxClientsPerIP\*(C'\fR, \f(CW\*(C`MaxDiskUsage\*(C'\fR, \f(CW\*(C`MaxIdleTime\*(C'\fR,
\&\f(CW\*(C`MaxLoad\*(C'\fR, \f(CW\*(C`MinUID\*(C'\fR, \f(CW\*(C`TLS\*(C'\fR, \f(CW\*(C`TrustedGID\*(C'\fR.
.IP "Two numbers" 4
.IX Item "Two numbers"
\&\f(CW\*(C`AnonymousRatio\*(C'\fR, \f(CW\*(C`LimitRecursion\*(C'\fR, \f(CW\*(C`PassivePortRange\*(C'\fR, 
\&\f(CW\*(C`PerUserLimits\*(C'\fR, \f(CW\*(C`Quota\*(C'\fR, \f(CW\*(C`UserRatio\*(C'\fR.
.IP "Two numbers (with unlimited value)" 4
.IX Item "Two numbers (with unlimited value)"
This allows \-1 in addition to positive numbers indicating an unlimited
values.
.Sp
\&\f(CW\*(C`LimitRecursion\*(C'\fR.
.IP "One or two numbers" 4
.IX Item "One or two numbers"
\&\f(CW\*(C`AnonymousBandwidth\*(C'\fR, \f(CW\*(C`UserBandwidth\*(C'\fR.
.IP "Two octal numbers" 4
.IX Item "Two octal numbers"
\&\f(CW\*(C`Umask\*(C'\fR.
.SS "String values"
.IX Subsection "String values"
.IP "Arbritrary strings" 4
.IX Item "Arbritrary strings"
\&\f(CW\*(C`AltLog\*(C'\fR, \f(CW\*(C`Bind\*(C'\fR, \f(CW\*(C`ForcePassiveIP\*(C'\fR.
.IP Words 4
.IX Item "Words"
\&\f(CW\*(C`SyslogFacility\*(C'\fR.
.SS "Character Sets"
.IX Subsection "Character Sets"
\&\f(CW\*(C`FSCharset\*(C'\fR, \f(CW\*(C`ClientCharset\*(C'\fR.
.PP
These options were removed from PureFTPd in release 1.0.48 and will be ignored by the wrapper.
.SS "IP values"
.IX Subsection "IP values"
\&\f(CW\*(C`TrustedIP\*(C'\fR.
.SS "File values"
.IX Subsection "File values"
These values designate an existing file or socket.
.IP File 4
.IX Item "File"
\&\f(CW\*(C`FortunesFile\*(C'\fR, \f(CW\*(C`LDAPConfigFile\*(C'\fR, \f(CW\*(C`MySQLConfigFile\*(C'\fR, \f(CW\*(C`PGSQLConfigFile\*(C'\fR, \f(CW\*(C`PureDB\*(C'\fR.
.IP Socket 4
.IX Item "Socket"
\&\f(CW\*(C`ExtAuth\*(C'\fR.
.SH AUTHOR
.IX Header "AUTHOR"
This manual page was written by Stefan Hornburg (Racke) <racke@linuxia.de>
for the Debian GNU/Linux system.