.\" Copyright (c) 2010-2013 Dovecot authors, see the included COPYING file .TH DOVECOT 1M "2013-08-06" "Dovecot v2.2" "Dovecot" .SH NAME dovecot \- a secure and highly configurable IMAP and POP3 server .\"------------------------------------------------------------------------ .SH SYNOPSIS .nh .na .HP \" ./master-options-short.inc \fBdovecot\fR [\-c\ \fIfile\fR|\-i\ \fIinstance\fR] [\-k] [\-L] [\-O] [\-o\ \fIsetting\fB=\fIvalue\fR]... [\-F] [\-p] .HP \" ./master-options-short.inc \fBdovecot\fR [\-c\ \fIfile\fR|\-i\ \fIinstance\fR] [\-k] [\-L] [\-O] [\-o\ \fIsetting\fB=\fIvalue\fR]... [\-F] [\-p] \[\-a|\-b|\-d|\-h|\-l|\-n|\-v] [\fIcmd\fR [\fIoptions\fR]... [\fIoperands\fR]...] .ad .hy .\"------------------------------------------------------------------------ .SH DESCRIPTION Dovecot is an open source IMAP and POP3 server for Linux/UNIX\-like systems, written with security primarily in mind. Dovecot is an excellent choice for both small and large installations. It\'s fast, simple to set up, requires no special administration and it uses very little memory. The first form of the command starts the dovecot master process, which in turn spawns several helpers to allow user to login and/or to work as a proxy. The 2nd form of the command can be used to obtain additional information about dovecot itself or its configuration. For backward compatibility but deprecated, if a \fIcmd\ ...\fR operand is given, dovecot just executes \fBdoveadm\fR(1M) with the given command, options and operands. .\"------------------------------------------------------------------------ .SH OPTIONS Common options: \" ./master-options.inc \" vim: ts=4 sw=4 filetype=nroff .TP .BI \-c\ file Read configuration from the given \fIfile\fR. By default \fI/etc/dovecot/dovecot.conf\fR will be used. .TP .BI \-i\ instance Get the configuration from the instance with the name \fIinstance\fR. .TP .B \-k Keep environment, i.e. when executing a new process do not explicitly set the environment variables HOME, USER and when reading configurations, don\'t overwrite currently set environment variables with corresponding settings. Usually used internally, only. .TP .B \-L Log directly. .TP .B \-O Don\'t read settings, but use whatever is in the environment. .TP .BI \-o\ setting = value Overrides the \fIsetting\fR from the current configuration with the given \fIvalue\fR (can be specified multiple times). E.g. with \-o dsync_alt_char=c one is able to overwrite the character to use as an replacement for all invalid characters encountered within a mailbox name (per default \'\fB_\fR'). .P Command specific options: .TP .B \-a \fBDeprecated\fR. Just executes \fBdoveconf\ \-a\fR. .TP .BR \-b , \ \-\-build\-options Show dovecot\'s build options and exit successfully. .TP .BR \-d , \ \-\-hostdomain Shows the current fully-qualified hostname of the system. If the domain lookup should fail for some reason, the unqualified hostname will be shown. .TP .B \-F Run in foreground, do not daemonize. .TP .BR \-h , \ \-\-help Print a short usage message to stdout and exit successfully. .TP .BR \-l , \ \-\-log\-error \fBDeprecated\fR. Just executes \fBdoveadm log test ...\fR. .TP .B \-n \fBDeprecated\fR. Just executes \fBdoveconf\ \-n\fR. .TP .B \-p Prompt for the ssl key password for the configured \fBssl_key\fR on startup. .TP .BR \-v , \ \-\-version Show dovecot\'s version and exit successfully. .\"------------------------------------------------------------------------ .SH SIGNALS Dovecot handles the following .IR signals : .TP 6 .B HUP Force .B dovecot to reload its configuration. .TP .B INT Shutdown .B dovecot and all its child processes. .TP .B TERM Shutdown .B dovecot and all its child processes. .TP .B USR1 Force .B dovecot to reopen all configured log files (\c .IR log_path , .IR info_log_path\ and .IR debug_log_path ). . .PP The signals .BR ALARM\ and .B PIPE are ignored. .\"------------------------------------------------------------------------ .SH FILES .TP .I /etc/dovecot/dovecot.conf Dovecot\'s main configuration file. .TP .I /etc/dovecot/conf.d/ldap.conf Dovecot\'s LDAP authdb/userdb module configuration file. .TP .I /etc/dovecot/conf.d/sql.conf Dovecot\'s SQL authdb/userdb module configuration file. .TP .I /etc/dovecot/conf.d/dict\-sql.conf Dovecot\'s dict configuration with SQL\-backend. .TP .I /etc/dovecot/conf.d/auth\-*.conf Configuration files of different authentication modules. .TP .I /etc/dovecot/conf.d/*.conf Configuration files of different services and settings. .\"------------------------------------------------------------------------ .SH SEE ALSO .BR doveadm (1M), .BR doveconf (1M), .BR dovecot\-lda (1M), .BR dsync (1M), .BR svcadm(1M), .BR svcprop(1M) .\"------------------------------------------------------------------------ .SH NOTES .P The \fBdovecot\fR daemon is controlled through the service management facility (SMF) service instance: .in +2 .nf svc:/network/dovecot:default .fi .in -2 .P Use \fBsvcadm\fR(1M) to enable this service. To view current service properties, use: .in +2 .nf svcprop -p config svc:/network/dovecot:default .fi .in -2 .\"------------------------------------------------------------------------ .SH AUTHOR Dovecot and its manual pages were written by the Dovecot authors , mainly Timo Sirainen , and are licensed under the terms of the MIT and LGPLv2.1 licenses, see for details. .\"------------------------------------------------------------------------ \" ./reporting-bugs.inc .SH REPORTING BUGS Report bugs, including \fBdoveconf \-n\fR output, to the dovecot Mailing List . Information about reporting bugs is available at: http://dovecot.org/bugreport.html