bug#61837: 29.0.50; [PATCH] Document Gnus backend variable `nnimap-user'

bug#61837: 29.0.50; [PATCH] Document Gnus backend variable `nnimap-user'

[Arash Esbati]

[-- Attachment #1: Type: text/plain, Size: 117 bytes --]

Hi all,

please find attached a small change to gnus.texi.  This change is
against the release branch.

Best, Arash


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-nnimap-user-to-Gnus-manual.patch --]
[-- Type: text/x-patch, Size: 1135 bytes --]

From d309a7be26fa292d9918f0ada660821ba4181c75 Mon Sep 17 00:00:00 2001
From: Arash Esbati <arash@gnu.org>
Date: Mon, 27 Feb 2023 10:10:13 +0100
Subject: [PATCH] ; Add `nnimap-user' to Gnus manual

* doc/misc/gnus.texi (Customizing the IMAP Connection): Document
backend variable `nnimap-user' which was introduced with commit
5e68f8614f in 2011.
---
 doc/misc/gnus.texi | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index d513726979b..7d50fdfb4af 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -14512,6 +14512,12 @@ Customizing the IMAP Connection
 @item nnimap-address
 The address of the server, like @samp{imap.gmail.com}.
 
+@item nnimap-user
+Username to use for authentication to the @acronym{IMAP} server.  This
+corresponds to the value of the @samp{login} token in your
+@file{~/.authinfo} file.  Set this variable if you want to access
+multiple accounts from the same @acronym{IMAP} server.
+
 @item nnimap-server-port
 If the server uses a non-standard port, that can be specified here.  A
 typical port would be @code{"imap"} or @code{"imaps"}.
-- 
2.39.2

bug#61837: 29.0.50; [PATCH] Document Gnus backend variable `nnimap-user'

[Eli Zaretskii]

> From: Arash Esbati <arash@gnu.org>
> Date: Mon, 27 Feb 2023 10:23:08 +0100
> 
> please find attached a small change to gnus.texi.  This change is
> against the release branch.
> 
>  
> +@item nnimap-user
> +Username to use for authentication to the @acronym{IMAP} server.  This
> +corresponds to the value of the @samp{login} token in your
> +@file{~/.authinfo} file.  Set this variable if you want to access
> +multiple accounts from the same @acronym{IMAP} server.
> +
>  @item nnimap-server-port
>  If the server uses a non-standard port, that can be specified here.  A
>  typical port would be @code{"imap"} or @code{"imaps"}.

Thanks, but please add an index entry for this variable.  (Yes, I know
the other variables there aren't indexed, either, but Rome wasn't
built in one day.  Bonus points for adding index entries for the other
variables as well.)

bug#61837: 29.0.50; [PATCH] Document Gnus backend variable `nnimap-user'

[Arash Esbati]

[-- Attachment #1: Type: text/plain, Size: 340 bytes --]

Eli Zaretskii <eliz@gnu.org> writes:

> Thanks, but please add an index entry for this variable.  (Yes, I know
> the other variables there aren't indexed, either, but Rome wasn't
> built in one day.  Bonus points for adding index entries for the other
> variables as well.)

Next try attached seeking for bonus points as well.

Best, Arash

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-nnimap-user-to-Gnus-manual.patch --]
[-- Type: text/x-patch, Size: 3567 bytes --]

From ca13dfa26bc6a7f23a1872790a3a9a61af0e4cb9 Mon Sep 17 00:00:00 2001
From: Arash Esbati <arash@gnu.org>
Date: Mon, 27 Feb 2023 10:10:13 +0100
Subject: [PATCH] ; Add `nnimap-user' to Gnus manual

* doc/misc/gnus.texi (Customizing the IMAP Connection): Document
backend variable `nnimap-user' which was introduced with commit
5e68f8614f in 2011.
Add index entries for all backend variables.  (bug#61837)
---
 doc/misc/gnus.texi | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index d513726979b..cf6820948ad 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -14510,13 +14510,23 @@ Customizing the IMAP Connection
 
 @table @code
 @item nnimap-address
+@vindex nnimap-address
 The address of the server, like @samp{imap.gmail.com}.
 
+@item nnimap-user
+@vindex nnimap-user
+Username to use for authentication to the @acronym{IMAP} server.  This
+corresponds to the value of the @samp{login} token in your
+@file{~/.authinfo} file.  Set this variable if you want to access
+multiple accounts from the same @acronym{IMAP} server.
+
 @item nnimap-server-port
+@vindex nnimap-server-port
 If the server uses a non-standard port, that can be specified here.  A
 typical port would be @code{"imap"} or @code{"imaps"}.
 
 @item nnimap-stream
+@vindex nnimap-stream
 How @code{nnimap} should connect to the server.  Possible values are:
 
 @table @code
@@ -14547,6 +14557,7 @@ Customizing the IMAP Connection
 @end table
 
 @item nnimap-authenticator
+@vindex nnimap-authenticator
 Some @acronym{IMAP} servers allow anonymous logins.  In that case,
 this should be set to @code{anonymous}.  If this variable isn't set,
 the normal login methods will be used.  If you wish to specify a
@@ -14556,6 +14567,7 @@ Customizing the IMAP Connection
 requires using the @file{oauth2.el} library.)
 
 @item nnimap-expunge
+@vindex nnimap-expunge
 When to expunge deleted messages.  If @code{never}, deleted articles
 are marked with the IMAP @code{\\Delete} flag but not automatically
 expunged. If @code{immediately}, deleted articles are immediately expunged
@@ -14571,27 +14583,32 @@ Customizing the IMAP Connection
 (i.e., potentially not only the article that was just deleted).
 
 @item nnimap-streaming
+@vindex nnimap-streaming
 Virtually all @acronym{IMAP} server support fast streaming of data.
 If you have problems connecting to the server, try setting this to
 @code{nil}.
 
 @item nnimap-fetch-partial-articles
+@vindex nnimap-fetch-partial-articles
 If non-@code{nil}, fetch partial articles from the server.  If set to
 a string, then it's interpreted as a regexp, and parts that have
 matching types will be fetched.  For instance, @samp{"text/"} will
 fetch all textual parts, while leaving the rest on the server.
 
 @item nnimap-record-commands
+@vindex nnimap-record-commands
 If non-@code{nil}, record all @acronym{IMAP} commands in the
 @samp{"*imap log*"} buffer.
 
 @item nnimap-use-namespaces
+@vindex nnimap-use-namespaces
 If non-@code{nil}, omit the IMAP namespace prefix in nnimap group
 names.  If your IMAP mailboxes are called something like @samp{INBOX}
 and @samp{INBOX.Lists.emacs}, but you'd like the nnimap group names to
 be @samp{INBOX} and @samp{Lists.emacs}, you should enable this option.
 
 @item nnimap-keepalive-intervals
+@vindex nnimap-keepalive-intervals
 By default, nnimap will send occasional @samp{NOOP} (keepalive)
 commands to the server, to keep the connection alive.  This option
 governs how often that happens.  It is a cons of two integers,
-- 
2.39.2

bug#61837: 29.0.50; [PATCH] Document Gnus backend variable `nnimap-user'

[Eli Zaretskii]

> From: Arash Esbati <arash@gnu.org>
> Cc: 61837@debbugs.gnu.org
> Date: Mon, 27 Feb 2023 13:16:30 +0100
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> > Thanks, but please add an index entry for this variable.  (Yes, I know
> > the other variables there aren't indexed, either, but Rome wasn't
> > built in one day.  Bonus points for adding index entries for the other
> > variables as well.)
> 
> Next try attached seeking for bonus points as well.

You've got them!  Thanks.

(In the future, please remember to put index entries _before_ any
@item. not after it, so that index search brings you to the @item.  I
fixed that for you this time.)

bug#61837: 29.0.50; [PATCH] Document Gnus backend variable `nnimap-user'

[Arash Esbati]

Eli Zaretskii <eliz@gnu.org> writes:

> (In the future, please remember to put index entries _before_ any
> @item. not after it, so that index search brings you to the @item.  I
> fixed that for you this time.)

Thanks for installing/fixing the patch and the hint.  I looked at the
previous @node News Spool in gnus.texi and took over how it was there:
index entries come after the @item.  But fixing gnus.texi in that
respect is currently out of my scope.

Best, Arash

bug#61837: 29.0.50; [PATCH] Document Gnus backend variable `nnimap-user'

[Eli Zaretskii]

> From: Arash Esbati <arash@gnu.org>
> Cc: 61837-done@debbugs.gnu.org
> Date: Mon, 27 Feb 2023 14:44:52 +0100
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> > (In the future, please remember to put index entries _before_ any
> > @item. not after it, so that index search brings you to the @item.  I
> > fixed that for you this time.)
> 
> Thanks for installing/fixing the patch and the hint.  I looked at the
> previous @node News Spool in gnus.texi and took over how it was there:
> index entries come after the @item.  But fixing gnus.texi in that
> respect is currently out of my scope.

Right, that's a large and boring job.