doc: convert git-imap-send synopsis and options to new style
Convert git-imap-send from [verse]/single-quote style to the modern synopsis-block style: - Replace [verse] with [synopsis] in SYNOPSIS block - Backtick-quote all OPTIONS terms - Backtick-quote all config keys in config/imap.adoc - Backtick-quote bare config key references in prose Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jean-Noël Avila committed
May 25, 2026 at 10:28 UTC
2ef248ae45bdcfbb027108bf87fcc3375cb5daba
2 files changed
+27
-27
Documentation/config/imap.adoc
+15
-15
@@ -1,44 +1,44 @@
1
-imap.folder::
1
+`imap.folder`::
2
The folder to drop the mails into, which is typically the Drafts
3
folder. For example: `INBOX.Drafts`, `INBOX/Drafts` or
4
`[Gmail]/Drafts`. The IMAP folder to interact with MUST be specified;
5
the value of this configuration variable is used as the fallback
6
default value when the `--folder` option is not given.
7
8
-imap.tunnel::
8
+`imap.tunnel`::
9
Command used to set up a tunnel to the IMAP server through which
10
commands will be piped instead of using a direct network connection
11
- to the server. Required when imap.host is not set.
11
+ to the server. Required when `imap.host` is not set.
12
13
-imap.host::
13
+`imap.host`::
14
A URL identifying the server. Use an `imap://` prefix for non-secure
15
connections and an `imaps://` prefix for secure connections.
16
- Ignored when imap.tunnel is set, but required otherwise.
16
+ Ignored when `imap.tunnel` is set, but required otherwise.
17
18
-imap.user::
18
+`imap.user`::
19
The username to use when logging in to the server.
20
21
-imap.pass::
21
+`imap.pass`::
22
The password to use when logging in to the server.
23
24
-imap.port::
24
+`imap.port`::
25
An integer port number to connect to on the server.
26
- Defaults to 143 for imap:// hosts and 993 for imaps:// hosts.
27
- Ignored when imap.tunnel is set.
26
+ Defaults to 143 for `imap://` hosts and 993 for `imaps://` hosts.
27
+ Ignored when `imap.tunnel` is set.
28
29
-imap.sslverify::
29
+`imap.sslverify`::
30
A boolean to enable/disable verification of the server certificate
31
used by the SSL/TLS connection. Default is `true`. Ignored when
32
- imap.tunnel is set.
32
+ `imap.tunnel` is set.
33
34
-imap.preformattedHTML::
34
+`imap.preformattedHTML`::
35
A boolean to enable/disable the use of html encoding when sending
36
- a patch. An html encoded patch will be bracketed with <pre>
36
+ a patch. An html encoded patch will be bracketed with `<pre>`
37
and have a content type of text/html. Ironically, enabling this
38
option causes Thunderbird to send the patch as a plain/text,
39
format=fixed email. Default is `false`.
40
41
-imap.authMethod::
41
+`imap.authMethod`::
42
Specify the authentication method for authenticating with the IMAP server.
43
If Git was built with the NO_CURL option, or if your curl version is older
44
than 7.34.0, or if you're running git-imap-send with the `--no-curl`
Documentation/git-imap-send.adoc
+12
-12
@@ -8,9 +8,9 @@ git-imap-send - Send a collection of patches from stdin to an IMAP folder
8
9
SYNOPSIS
10
--------
11
-[verse]
12
-'git imap-send' [-v] [-q] [--[no-]curl] [(--folder|-f) <folder>]
13
-'git imap-send' --list
11
+[synopsis]
12
+git imap-send [-v] [-q] [--[no-]curl] [(--folder|-f) <folder>]
13
+git imap-send --list
14
15
16
DESCRIPTION
@@ -32,30 +32,30 @@ $ git format-patch --signoff --stdout --attach origin | git imap-send
32
OPTIONS
33
-------
34
35
--v::
36
---verbose::
35
+`-v`::
36
+`--verbose`::
37
Be verbose.
38
39
--q::
40
---quiet::
39
+`-q`::
40
+`--quiet`::
41
Be quiet.
42
43
--f <folder>::
44
---folder=<folder>::
43
+`-f <folder>`::
44
+`--folder=<folder>`::
45
Specify the folder in which the emails have to saved.
46
For example: `--folder=[Gmail]/Drafts` or `-f INBOX/Drafts`.
47
48
---curl::
48
+`--curl`::
49
Use libcurl to communicate with the IMAP server, unless tunneling
50
into it. Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND
51
option set.
52
53
---no-curl::
53
+`--no-curl`::
54
Talk to the IMAP server using git's own IMAP routines instead of
55
using libcurl. Ignored if Git was built with the NO_OPENSSL option
56
set.
57
58
---list::
58
+`--list`::
59
Run the IMAP LIST command to output a list of all the folders present.
60
61
CONFIGURATION