NetBSD/gnu/dist/postfix/man/man1/postfix.1

112 lines
3.3 KiB
Groff

.TH POSTFIX 1
.ad
.fi
.SH NAME
postfix
\-
Postfix control program
.SH SYNOPSIS
.na
.nf
.fi
\fBpostfix\fR [\fB-c \fIconfig_dir\fR] [\fB-D\fR] [\fB-v\fR]
\fIcommand\fR
.SH DESCRIPTION
.ad
.fi
The \fBpostfix\fR command controls the operation of the Postfix
mail system: start or stop the \fBmaster\fR daemon, do a health
check, and other maintenance. The command sets up a standardized
environment and runs the \fBpostfix-script\fR shell script to
do the actual work.
The following commands are implemented:
.IP \fBcheck\fR
Validate the Postfix mail system configuration. Warn about bad
directory/file ownership or permissions, and create missing
directories.
.IP \fBstart\fR
Start the Postfix mail system. This also runs the configuration
check described above.
.IP \fBstop\fR
Stop the Postfix mail system in an orderly fashion. Running processes
are allowed to terminate at their earliest convenience.
.sp
Note: in order to refresh the Postfix mail system after a
configuration change, do not use the \fBstart\fR and \fBstop\fR
commands in succession. Use the \fBreload\fR command instead.
.IP \fBabort\fR
Stop the Postfix mail system abruptly. Running processes are
signaled to stop immediately.
.IP \fBflush\fR
Force delivery: attempt to deliver every message in the deferred
mail queue. Normally, attempts to deliver delayed mail happen at
regular intervals, the interval doubling after each failed attempt.
.IP \fBreload\fR
Re-read configuration files. Running processes terminate at their
earliest convenience.
.PP
The following options are implemented:
.IP "\fB-c \fIconfig_dir\fR"
Read the \fBmain.cf\fR and \fBmaster.cf\fR configuration files in
the named directory instead of the default configuration directory.
Use this to distinguish between multiple Postfix instances on the
same host.
.IP "\fB-D\fR (with \fBpostfix start\fR only)"
Run each Postfix daemon under control of a debugger as specified
via the \fBdebugger_command\fR configuration parameter.
.IP \fB-v\fR
Enable verbose logging for debugging purposes. Multiple \fB-v\fR
options make the software increasingly verbose.
.SH ENVIRONMENT
.na
.nf
.ad
.fi
The \fBpostfix\fR command sets the following environment
variables:
.IP \fBMAIL_CONFIG\fR
Directory with Postfix configuration files.
.IP \fBMAIL_VERBOSE\fR
This is set when the -v command-line option is present.
.IP \fBMAIL_DEBUG\fR
This is set when the -D command-line option is present.
.PP
The following configuration parameters are made available
as process environment variables with the same names:
.IP \fBcommand_directory\fR
Directory with Postfix support commands (default:
\fB$program_directory\fR).
.IP \fBdaemon_directory\fR
Directory with Postfix daemon programs (default:
\fB$program_directory\fR).
.IP \fBconfig_directory\fR
Directory with Postfix configuration files and with administrative
shell scripts.
.IP \fBqueue_directory\fR
The directory with the Postfix queue directory (and with some
files needed for programs running in a chrooted environment).
.IP \fBmail_owner\fR
The owner of the Postfix queue and of most Postfix processes.
.SH FILES
.na
.nf
$\fBconfig_directory/postfix-script\fR, administrative commands
.SH SEE ALSO
.na
.nf
master(8) Postfix master program
.SH LICENSE
.na
.nf
.ad
.fi
The Secure Mailer license must be distributed with this software.
.SH AUTHOR(S)
.na
.nf
Wietse Venema
IBM T.J. Watson Research
P.O. Box 704
Yorktown Heights, NY 10598, USA