Skip to content

doveconf: Add filter parameter #1073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cmouse merged 2 commits into from
Nov 11, 2024
Merged

doveconf: Add filter parameter #1073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0190ae3
man/doveconf: Clarify -f filter parameters and fix examples
sirainen Nov 8, 2024
19fc550
man/doveconf: Remove -S parameter
sirainen Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/actions/spelling/patterns.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ BBAAAAAAAAAAAAAAAAAAAAAAB
d88ff1001d4bf753a1b800001accfe22
&U,BTFw-
&ZeVnLIqe-
-adnPNSx
-adnPNx
F=DFMPhnu9,
SPfne
\bAPPEND(?:ed|s)
Expand Down
32 changes: 16 additions & 16 deletions docs/core/man/doveconf.1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ dovecotComponent: core
## SYNOPSIS

**doveconf**
[**-adnPNSx**]
[**-adnPNx**]
[**-c** *config-file*]
[**-f** *filter*]

Expand Down Expand Up @@ -54,24 +54,27 @@ configuration in easy human readable output.
**-f** option can be supplied multiple times.

Possible names for the *filter* are:
: **lname**
: The local hostname, e.g. mail.example.com.
: **protocol**
: The protocol, e.g. imap or pop3

: **local_name**
: The local hostname for TLS SNI matching, e.g. mail.example.com.

This will only match hostnames which were configured like:
This matches filters which were configured like:
: **local_name mail.example.com { # special settings }**

: **local**
: The server's hostname or IP address.

This will also match hostnames which were configured like:
: **local imap.example.net { # special settings }**
: The local hostname or IP address.

: **protocol, service**
: The protocol, e.g. imap or pop3
This matches filters which were configured like:
: **local 1.2.3.0/24 { # special settings }**

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

This matches filters which were configured like:
: **remote 1.2.3.0/24 { # special settings }**

**-h**
: Hide the setting's name, show only the setting's value.

Expand All @@ -82,9 +85,6 @@ configuration in easy human readable output.
**-N**
: Show settings with non-default values and explicitly set default values.

**-S**
: Dump settings in simplified machine parsable/readable format.

**-s**
: Show also hidden settings. The hidden settings should not be changed
normally.
Expand All @@ -111,7 +111,7 @@ networks/subnets it is possible to show which settings will be applied
for a specific connection.

```sh
doveconf -f local=10.0.0.110 -f remote=10.11.1.2 -f service=pop3 -n
doveconf -f local=10.0.0.110 -f remote=10.11.1.2 -f protocol=pop3 -n
```

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

```sh
doveconf -h -f protocol=imap mail_plugins
doveconf -h -f protocol=imap login_greeting
```
```
quota imap_quota
Dovecot ready.
```

Dump a whole configuration section:
Expand Down