Skip to content

Commit 3a8aee8

Browse files
sirainencmouse
authored andcommitted
man/doveconf: Clarify -f filter parameters and fix examples
1 parent d4129a9 commit 3a8aee8

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

docs/core/man/doveconf.1.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,24 +54,27 @@ configuration in easy human readable output.
5454
**-f** option can be supplied multiple times.
5555

5656
Possible names for the *filter* are:
57-
: **lname**
58-
: The local hostname, e.g. mail.example.com.
57+
: **protocol**
58+
: The protocol, e.g. imap or pop3
59+
60+
: **local_name**
61+
: The local hostname for TLS SNI matching, e.g. mail.example.com.
5962

60-
This will only match hostnames which were configured like:
63+
This matches filters which were configured like:
6164
: **local_name mail.example.com { # special settings }**
6265

6366
: **local**
64-
: The server's hostname or IP address.
67+
: The local hostname or IP address.
6568

66-
This will also match hostnames which were configured like:
67-
: **local imap.example.net { # special settings }**
68-
69-
: **protocol, service**
70-
: The protocol, e.g. imap or pop3
69+
This matches filters which were configured like:
70+
: **local 1.2.3.0/24 { # special settings }**
7171

7272
: **remote**
7373
: The client's hostname or IP address.
7474

75+
This matches filters which were configured like:
76+
: **remote 1.2.3.0/24 { # special settings }**
77+
7578
**-h**
7679
: Hide the setting's name, show only the setting's value.
7780

@@ -111,7 +114,7 @@ networks/subnets it is possible to show which settings will be applied
111114
for a specific connection.
112115

113116
```sh
114-
doveconf -f local=10.0.0.110 -f remote=10.11.1.2 -f service=pop3 -n
117+
doveconf -f local=10.0.0.110 -f remote=10.11.1.2 -f protocol=pop3 -n
115118
```
116119

117120
**doveconf** can be also used to convert v1.x configuration files into
@@ -134,10 +137,10 @@ Ask **doveconf** for a protocol specific setting. Uses the **-h**
134137
option, in order to hide the setting's name:
135138

136139
```sh
137-
doveconf -h -f protocol=imap mail_plugins
140+
doveconf -h -f protocol=imap login_greeting
138141
```
139142
```
140-
quota imap_quota
143+
Dovecot ready.
141144
```
142145

143146
Dump a whole configuration section:

0 commit comments

Comments
 (0)