From 5068b3c4bd28a40af3ce1ee6a3e224cff6dfc302 Mon Sep 17 00:00:00 2001 From: Michael M Slusarz Date: Thu, 12 Sep 2024 15:10:54 -0600 Subject: [PATCH] man: Fix doveadm-instance to accurately reflect arguments data/doveadm.js already reflected the correct arguments. --- docs/core/man/doveadm-instance.1.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/core/man/doveadm-instance.1.md b/docs/core/man/doveadm-instance.1.md index 7c60f54db..a86347a47 100644 --- a/docs/core/man/doveadm-instance.1.md +++ b/docs/core/man/doveadm-instance.1.md @@ -8,9 +8,9 @@ dovecotComponent: core ## SYNOPSIS -**doveadm** [*GLOBAL OPTIONS*] **instance list** +**doveadm** [*GLOBAL OPTIONS*] **instance list** [**-c**] [*name*] -**doveadm** [*GLOBAL OPTIONS*] **instance remove** *name* | *base_dir* +**doveadm** [*GLOBAL OPTIONS*] **instance remove** *name* ## DESCRIPTION @@ -31,22 +31,23 @@ binaries (e.g. doveadm). ## ARGUMENTS *name* -: The value of an instance's *instance_name* setting. - -*base_dir* -: The base directory of a Dovecot instance. +: The value of an instance's *instance_name* setting. Each instance can + also be uniquely identified by its *base_dir* setting. ## COMMANDS ### instance list -**doveadm** [*GLOBAL OPTIONS*] instance list +**doveadm** [*GLOBAL OPTIONS*] instance list [**-c**] [*name*] This command lists the seen Dovecot instances. +**-c** +: Output the config path instead of instance information. + ### instance remove -**doveadm** [*GLOBAL OPTIONS*] instance remove *name* | *base_dir* +**doveadm** [*GLOBAL OPTIONS*] instance remove *name* This command removes the specified instance.