Skip to content

Commit

Permalink
Revert "Remove directory from man page includes"
Browse files Browse the repository at this point in the history 
This reverts commit 91a4f5b.

We need the paths for vitepress. Generate_man does includes
so that having a path won't cause problems.
  • Loading branch information
@cmouse
cmouse committed Sep 16, 2024
1 parent 4c86881 commit ad39769
Show file tree
Hide file tree
Showing 55 changed files with 211 additions and 211 deletions.
14 changes: 7 additions & 7 deletions docs/core/man/doveadm-acl.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,21 @@ dovecotComponent: core
The **doveadm acl** *COMMANDS* can be used to execute various Access
Control List related actions.

<!-- @include: global-options-formatter.inc -->
<!-- @include: include/global-options-formatter.inc -->

This command uses by default the output formatter **table**.

## OPTIONS

<!-- @include: option-A.inc -->
<!-- @include: include/option-A.inc -->

<!-- @include: option-F-file.inc -->
<!-- @include: include/option-F-file.inc -->

<!-- @include: option-no-userdb-lookup.inc -->
<!-- @include: include/option-no-userdb-lookup.inc -->

<!-- @include: option-S-socket.inc -->
<!-- @include: include/option-S-socket.inc -->

<!-- @include: option-u-user.inc -->
<!-- @include: include/option-u-user.inc -->

## ARGUMENTS

Expand Down Expand Up @@ -169,7 +169,7 @@ Show the *user*'s current ACL rights for the *mailbox*.
Set ACL rights to the *mailbox*/*id*. If the *id* already exists, the
existing rights are replaced.

<!-- @include: reporting-bugs.inc -->
<!-- @include: include/reporting-bugs.inc -->

## SEE ALSO

Expand Down
14 changes: 7 additions & 7 deletions docs/core/man/doveadm-altmove.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,24 @@ In the third form, the command will be performed for the user contained in the
In the last form, only matching mails of the given *user*\ (s) will be
moved to the alternative storage.

<!-- @include: global-options.inc -->
<!-- @include: include/global-options.inc -->

## OPTIONS

<!-- @include: option-A.inc -->
<!-- @include: include/option-A.inc -->

<!-- @include: option-F-file.inc -->
<!-- @include: include/option-F-file.inc -->

<!-- @include: option-no-userdb-lookup.inc -->
<!-- @include: include/option-no-userdb-lookup.inc -->

**-r**
: When the **-r** option is given this *command* works the other way
round. Mails will be moved from the alternative storage back to the
default mail location.

<!-- @include: option-S-socket.inc -->
<!-- @include: include/option-S-socket.inc -->

<!-- @include: option-u-user.inc -->
<!-- @include: include/option-u-user.inc -->

## ARGUMENTS

Expand Down Expand Up @@ -79,7 +79,7 @@ mail_location = mdbox:~/mdbox:ALT=/nfsmount/%h/mdbox
$ doveadm altmove -u [email protected] seen savedbefore 1w<
```

<!-- @include: reporting-bugs.inc -->
<!-- @include: include/reporting-bugs.inc -->

## SEE ALSO

Expand Down
14 changes: 7 additions & 7 deletions docs/core/man/doveadm-auth.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ dovecotComponent: core
The **doveadm auth** *COMMANDS* can be used to perform various
authentication related actions.

<!-- @include: global-options-formatter.inc -->
<!-- @include: include/global-options-formatter.inc -->

## OPTIONS

<!-- @include: option-x.inc -->
<!-- @include: include/option-x.inc -->

## ARGUMENTS

Expand Down Expand Up @@ -50,7 +50,7 @@ providing their usernames.
The socket may be located in another directory, when the default
*base_dir* setting was overridden in */etc/dovecot/dovecot.conf*.

<!-- @include: option-x.inc -->
<!-- @include: include/option-x.inc -->

### auth lookup

Expand All @@ -71,7 +71,7 @@ lookup (without authentication) instead of a *userdb* lookup.
: When this option and the name of a userdb field is given,
[[man,doveadm]] will show only the value of the specified field.

<!-- @include: option-x.inc -->
<!-- @include: include/option-x.inc -->

### auth test

Expand All @@ -90,7 +90,7 @@ Test authentication for the given user.
**-A** *sasl_mech*
: The SASL mechanism used for the authentication. By default PLAIN is used.

<!-- @include: option-x.inc -->
<!-- @include: include/option-x.inc -->

### auth login

Expand All @@ -117,7 +117,7 @@ Test full login for the given user; i.e. performing both passdb lookup (authenti
**-A** *sasl_mech*
: The SASL mechanism used for the authentication. By default PLAIN is used.

<!-- @include: option-x.inc -->
<!-- @include: include/option-x.inc -->

## EXAMPLE

Expand All @@ -133,7 +133,7 @@ extra fields:
user=john
```

<!-- @include: reporting-bugs.inc -->
<!-- @include: include/reporting-bugs.inc -->

## SEE ALSO

Expand Down
2 changes: 1 addition & 1 deletion docs/core/man/doveadm-backup.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ dovecotComponent: core

# doveadm-backup(1) - Dovecot's one-way mailbox synchronization feature

<!-- @include: doveadm-backup-sync.inc -->
<!-- @include: include/doveadm-backup-sync.inc -->
2 changes: 1 addition & 1 deletion docs/core/man/doveadm-compress-connect.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ command **COMPRESS DEFLATE**
* *host* - the hostname/ip address to connect to
* *port* - the port to connect to, 143 by default

<!-- @include: reporting-bugs.inc -->
<!-- @include: include/reporting-bugs.inc -->

## SEE ALSO

Expand Down
2 changes: 1 addition & 1 deletion docs/core/man/doveadm-copy.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ dovecotComponent: core

# doveadm-copy(1) - Copy messages matching the given search query into another mailbox

<!-- @include: doveadm-copy-move.inc -->
<!-- @include: include/doveadm-copy-move.inc -->
14 changes: 7 additions & 7 deletions docs/core/man/doveadm-deduplicate.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,24 +20,24 @@ messages from the mailbox and keep the oldest.

Deduplication across multiple mailboxes is not supported.

<!-- @include: global-options.inc -->
<!-- @include: include/global-options.inc -->

## OPTIONS

<!-- @include: option-A.inc -->
<!-- @include: include/option-A.inc -->

<!-- @include: option-F-file.inc -->
<!-- @include: include/option-F-file.inc -->

<!-- @include: option-no-userdb-lookup.inc -->
<!-- @include: include/option-no-userdb-lookup.inc -->

**-m**
: if the **-m** option is given, [[man,doveadm]] will deduplicate by
Message-Id header. By default deduplication will be done by message
GUIDs.

<!-- @include: option-S-socket.inc -->
<!-- @include: include/option-S-socket.inc -->

<!-- @include: option-u-user.inc -->
<!-- @include: include/option-u-user.inc -->

## ARGUMENTS

Expand Down Expand Up @@ -71,7 +71,7 @@ a7999e1530739c4bd26d0000ca356bad 18749
...
```

<!-- @include: reporting-bugs.inc -->
<!-- @include: include/reporting-bugs.inc -->

## SEE ALSO

Expand Down
4 changes: 2 additions & 2 deletions docs/core/man/doveadm-dict.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ dovecotComponent: core

**doveadm dict** can be used to query and modify dictionary entries.

<!-- @include: global-options-formatter.inc -->
<!-- @include: include/global-options-formatter.inc -->

**-u** *user*
: The user to use.
Expand Down Expand Up @@ -98,7 +98,7 @@ Remove a key from the dictionary.
*key*
: The key to unset.

<!-- @include: reporting-bugs.inc -->
<!-- @include: include/reporting-bugs.inc -->

## SEE ALSO

Expand Down
4 changes: 2 additions & 2 deletions docs/core/man/doveadm-dump.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ about index files, see [[link,design_index_format_main].
files, in human readable format. This is mainly useful for Dovecot
developers when debugging some problem.

<!-- @include: global-options.inc -->
<!-- @include: include/global-options.inc -->

## OPTIONS

Expand Down Expand Up @@ -96,7 +96,7 @@ Look at the contents of a mailbox's index:
$ doveadm dump ~/Maildir/.work/
```

<!-- @include: reporting-bugs.inc -->
<!-- @include: include/reporting-bugs.inc -->

## SEE ALSO

Expand Down
4 changes: 2 additions & 2 deletions docs/core/man/doveadm-exec.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ user could start a pre-authenticated imap session, using the command:
**doveadm exec imap**. An administrator would use the command
**doveadm exec imap -u** *username*.

<!-- @include: global-options.inc -->
<!-- @include: include/global-options.inc -->

## ARGUMENTS

Expand All @@ -37,7 +37,7 @@ user's mailbox.
$ doveadm exec dovecot-lda -d [email protected] -f [email protected] < ~/stuff/welcome.msg
```

<!-- @include: reporting-bugs.inc -->
<!-- @include: include/reporting-bugs.inc -->

SEE ALSO

Expand Down
14 changes: 7 additions & 7 deletions docs/core/man/doveadm-expunge.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,22 +34,22 @@ In the third form, the command will be performed for the user contained in the
In the final form, only matching mails of the given *user* (s) will be
expunged.

<!-- @include: global-options.inc -->
<!-- @include: include/global-options.inc -->

## OPTIONS

<!-- @include: option-A.inc -->
<!-- @include: include/option-A.inc -->

**-d**
: Delete the mailbox if it is empty after expunging.

<!-- @include: option-F-file.inc -->
<!-- @include: include/option-F-file.inc -->

<!-- @include: option-no-userdb-lookup.inc -->
<!-- @include: include/option-no-userdb-lookup.inc -->

<!-- @include: option-S-socket.inc -->
<!-- @include: include/option-S-socket.inc -->

<!-- @include: option-u-user.inc -->
<!-- @include: include/option-u-user.inc -->

## ARGUMENTS

Expand All @@ -66,7 +66,7 @@ there more than two weeks ago:
$ doveadm expunge -u [email protected] mailbox Spam savedbefore 2w
```

<!-- @include: reporting-bugs.inc -->
<!-- @include: include/reporting-bugs.inc -->

## SEE ALSO

Expand Down
14 changes: 7 additions & 7 deletions docs/core/man/doveadm-fetch.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,21 @@ messages one at a time, see [[man,doveadm-search]].

- Please respect your users' privacy.

<!-- @include: global-options-formatter.inc -->
<!-- @include: include/global-options-formatter.inc -->

This command uses by default the output formatter **pager**.

## OPTIONS

<!-- @include: option-A.inc -->
<!-- @include: include/option-A.inc -->

<!-- @include: option-F-file.inc -->
<!-- @include: include/option-F-file.inc -->

<!-- @include: option-no-userdb-lookup.inc -->
<!-- @include: include/option-no-userdb-lookup.inc -->

<!-- @include: option-S-socket.inc -->
<!-- @include: include/option-S-socket.inc -->

<!-- @include: option-u-user.inc -->
<!-- @include: include/option-u-user.inc -->

## ARGUMENTS

Expand Down Expand Up @@ -179,7 +179,7 @@ mailbox: dovecot/pigeonhole/2.0
date.sent: 2010-03-28 18:41:14 (+0200)
```

<!-- @include: reporting-bugs.inc -->
<!-- @include: include/reporting-bugs.inc -->

## SEE ALSO

Expand Down
14 changes: 7 additions & 7 deletions docs/core/man/doveadm-flags.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@ dovecotComponent: core

This command is used to manipulate flags of messages.

<!-- @include: global-options.inc -->
<!-- @include: include/global-options.inc -->

## OPTIONS

<!-- @include: option-A.inc -->
<!-- @include: include/option-A.inc -->

<!-- @include: option-F-file.inc -->
<!-- @include: include/option-F-file.inc -->

<!-- @include: option-no-userdb-lookup.inc -->
<!-- @include: include/option-no-userdb-lookup.inc -->

<!-- @include: option-S-socket.inc -->
<!-- @include: include/option-S-socket.inc -->

<!-- @include: option-u-user.inc -->
<!-- @include: include/option-u-user.inc -->

## ARGUMENTS

Expand Down Expand Up @@ -85,7 +85,7 @@ $ doveadm flags remove -u bob NonJunk mailbox dovecot uid 81563
$ doveadm flags add -u bob '\Flagged $Forwarded' mailbox dovecot uid 81563
```

<!-- @include: reporting-bugs.inc -->
<!-- @include: include/reporting-bugs.inc -->

## SEE ALSO

Expand Down
14 changes: 7 additions & 7 deletions docs/core/man/doveadm-force-resync.1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,19 @@ situations the **force-resync** command may be helpful. It tries to fix
all problems. For sdbox and mdbox mailboxes the storage files will be
also checked.

<!-- @include: global-options.inc -->
<!-- @include: include/global-options.inc -->

## OPTIONS

<!-- @include: option-A.inc -->
<!-- @include: include/option-A.inc -->

<!-- @include: option-F-file.inc -->
<!-- @include: include/option-F-file.inc -->

<!-- @include: option-no-userdb-lookup.inc -->
<!-- @include: include/option-no-userdb-lookup.inc -->

<!-- @include: option-S-socket.inc -->
<!-- @include: include/option-S-socket.inc -->

<!-- @include: option-u-user.inc -->
<!-- @include: include/option-u-user.inc -->

## ARGUMENTS

Expand All @@ -52,7 +52,7 @@ Fix bob's INBOX:
$ doveadm force-resync -u bob INBOX
```

<!-- @include: reporting-bugs.inc -->
<!-- @include: include/reporting-bugs.inc -->

## SEE ALSO

Expand Down
Loading

0 comments on commit ad39769

Please sign in to comment.