annotate doc/man/doveadm-log.1.in @ 22560:9a300e778b20

director: When logging "ring SYNC lost", include sync seq number in message This can help with debugging.
author Timo Sirainen <timo.sirainen@dovecot.fi>
date Thu, 14 Sep 2017 17:26:39 +0300
parents 2e2563132d5f
children cb108f786fb4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
21390
2e2563132d5f Updated copyright notices to include the year 2017.
Stephan Bosch <stephan.bosch@dovecot.fi>
parents: 19552
diff changeset
1 .\" Copyright (c) 2010-2017 Dovecot authors, see the included COPYING file
17025
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
2 .TH DOVEADM\-LOG 1 "2013-11-24" "Dovecot v2.2" "Dovecot"
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
3 .SH NAME
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
4 doveadm\-log \- Locate, test or reopen Dovecot\(aqs log files
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
5 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
6 .SH SYNOPSIS
17025
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
7 .BR doveadm " [" \-Dv "] " "log errors" " [" \-s
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
8 .IR min_timestamp ]
14203
007ec1d1d995 man: Added description of command `log errors' to doveadm-log.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
9 .\"-------------------------------------
007ec1d1d995 man: Added description of command `log errors' to doveadm-log.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
10 .br
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
11 .BR doveadm " [" \-Dv "] " "log find"
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
12 .RI [ directory ]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
13 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
14 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
15 .BR doveadm " [" \-Dv "] " "log reopen"
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
16 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
17 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
18 .BR doveadm " [" \-Dv "] " "log test"
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
19 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
20 .SH DESCRIPTION
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
21 The
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
22 .B doveadm log
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
23 .I commands
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
24 are used to locate and reopen the log files of
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
25 .BR dovecot (1).
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
26 It\(aqs also possible to test the configured targets of the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
27 .I *log_path
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
28 settings.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
29 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
30 @INCLUDE:global-options@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
31 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
32 .SH COMMANDS
14203
007ec1d1d995 man: Added description of command `log errors' to doveadm-log.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
33 .SS log errors
17025
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
34 .BR "doveadm log errors" " [" \-s
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
35 .IR min_timestamp ]
14203
007ec1d1d995 man: Added description of command `log errors' to doveadm-log.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
36 .PP
007ec1d1d995 man: Added description of command `log errors' to doveadm-log.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
37 The
007ec1d1d995 man: Added description of command `log errors' to doveadm-log.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
38 .B log errors
007ec1d1d995 man: Added description of command `log errors' to doveadm-log.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
39 command is used to show the last \- up to 1,000 \- errors and warnings.
007ec1d1d995 man: Added description of command `log errors' to doveadm-log.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
40 If no output is generated, no errors have occurred since the last start.
17025
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
41 .PP
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
42 .TP
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
43 .BI \-s \ min_timestamp
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
44 An integer value, representing seconds since the epoch \- also known as
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
45 Unix timestamp.
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
46 When a min_timestamp was given,
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
47 .BR doveadm (1)
89dd80dfb86e man: doveadm-log.1: Added description for option -s.
Pascal Volk <user@localhost.localdomain.org>
parents: 16484
diff changeset
48 will only show errors occurred since that point in time.
14203
007ec1d1d995 man: Added description of command `log errors' to doveadm-log.1.
Pascal Volk <user@localhost.localdomain.org>
parents: 13707
diff changeset
49 .\"-------------------------------------
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
50 .SS log find
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
51 .B doveadm log find
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
52 .RI [ directory ]
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
53 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
54 The
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
55 .B log find
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
56 command is used to show the location of the log files, to which
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
57 .BR dovecot (1)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
58 sends its log messages.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
59 If
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
60 .BR dovecot (1)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
61 logs its messages through
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
62 .BR syslogd (8)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
63 and
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
64 .BR doveadm (1)
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
65 could not find any log files, you can specify the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
66 .I directory
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
67 where your syslogd writes its log files.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
68 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
69 .SS log reopen
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
70 .B doveadm log reopen
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
71 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
72 This command causes
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
73 .B doveadm
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
74 to reopen all log files, configured in the
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
75 .IR log_path ,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
76 .I info_log_path
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
77 and
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
78 .I debug_log_path
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
79 settings.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
80 These settings are configured in
11798
a2bbd6c3624a man: Use pkgsysconfdir instead of explicit sysconfdir/dovecot
Timo Sirainen <tss@iki.fi>
parents: 11644
diff changeset
81 .IR @pkgsysconfdir@/conf.d/10\-logging.conf .
11644
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
82 .br
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
83 This is for example useful after manually rotating the log files.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
84 .\"-------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
85 .SS log test
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
86 .B doveadm log test
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
87 .PP
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
88 This command causes
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
89 .B doveadm
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
90 to write the message \(dqThis is Dovecot\(aqs
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
91 .I priority
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
92 log
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
93 .RI ( timestamp )\(dq
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
94 to the configured log files.
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
95 The used priorities are:
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
96 .BR debug ,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
97 .BR info ,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
98 .BR warning ,
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
99 .BR error
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
100 and
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
101 .BR fatal .
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
102 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
103 .SH EXAMPLE
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
104 This example shows how to locate the log files used by
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
105 .BR dovecot (1).
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
106 .sp
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
107 .nf
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
108 .B doveadm log find
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
109 Looking for log files from /var/log
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
110 Debug: /var/log/dovecot.debug
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
111 Info: /var/log/mail.log
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
112 Warning: /var/log/mail.log
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
113 Error: /var/log/mail.log
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
114 Fatal: /var/log/mail.log
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
115 .fi
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
116 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
117 @INCLUDE:reporting-bugs@
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
118 .\"------------------------------------------------------------------------
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
119 .SH SEE ALSO
be2b7d2901a0 doc: added manual pages
Pascal Volk <user@localhost.localdomain.org>
parents:
diff changeset
120 .BR doveadm (1)