.TH SPF-MILTER 8 2024-06-13 "SPF Milter 0.7.0-alpha.1"
.SH NAME
spf-milter \- milter for SPF verification
.SH SYNOPSIS
.SY spf-milter
.OP \-c path
.OP \-L level
.OP \-l target
.OP \-n
.OP \-p socket
.OP \-s name
.YS
.SH DESCRIPTION
.B spf-milter
is a milter application that verifies email senders using the
.I Sender Policy Framework
protocol (RFC\~7208).
.PP
The
.B spf-milter
program reads configuration parameters from the file
.I /etc/spf-milter.conf
at startup.
The default location of the configuration file may be overridden using the
.B \-\-config-file
option.
Command-line options take precedence over the corresponding parameters in the
configuration file.
Setting parameters in the configuration file is generally preferred over using
the command-line options.
.PP
Invoking
.B spf-milter
starts the milter in the foreground.
While it is running, the milter will process connections from the MTA according
to the configuration settings.
The milter can be shut down by sending it a termination signal.
.PP
During operation,
.B spf-milter
logs status messages to syslog by default.
In addition to errors and warnings, the SPF result for each verified identity is
logged at the informational level.
.SH OPTIONS
.TP
.BR \-c " \fIpath\fR, " \-\-config-file " \fIpath\fR"
Path to configuration file.
See
.BR spf-milter.conf (5)
for the reference documentation for SPF Milter configuration files.
If this option is not used, configuration parameters are read from the default
configuration file
.IR /etc/spf-milter.conf .
.TP
.BR \-n ", " \-\-dry-run
Process messages normally, but do not take action or apply modifications.
Corresponds to parameter
.B dry_run
in the configuration file.
.TP
.BR \-h ", " \-\-help
Print usage information and exit.
.TP
.BR \-l " \fItarget\fR, " \-\-log-destination " \fItarget\fR"
Destination for log messages.
Supported destinations are
.BR syslog ,
to write log messages to the system logger, and
.BR stderr ,
to write log messages to standard error.
Corresponds to parameter
.B log_destination
in the configuration file.
.TP
.BR \-L " \fIlevel\fR, " \-\-log-level " \fIlevel\fR"
Minimum severity of messages to log.
The supported log levels are
.BR error ,
.BR warn ,
.BR info ,
and
.BR debug .
Corresponds to parameter
.B log_level
in the configuration file.
.TP
.BR \-p " \fIsocket\fR, " \-\-socket " \fIsocket\fR"
Listening socket of the milter.
The given socket specification string describes the socket that the milter
should open for the connection from the MTA.
See
.BR spf-milter.conf (5)
for a description of the format.
Corresponds to parameter
.B socket
in the configuration file.
.TP
.BR \-s " \fIname\fR, " \-\-syslog-facility " \fIname\fR"
Facility to use for syslog messages.
Acceptable names are any of the named facilities defined by syslog (in lower
case minus the
.B LOG_
prefix).
Corresponds to parameter
.B syslog_facility
in the configuration file.
.TP
.BR \-V ", " \-\-version
Print version information and exit.
.SH FILES
.I /etc/spf-milter.conf
.SH SEE ALSO
.BR spf-milter.conf (5)