Reformat <para> elements: indentation/wrapping

...and tidy dashes, trailing whitespace, try to fix all spaces around
brackets and punctuation marks etc., e.g. keep link tags on the same
line to avoid an underlined space after hyperlinks in rendered result.

Reformat <screen> elements: too long or multi lines

...and tidy comments, dashes, potential Vim modelines, whitespace.

Add Vim modeline

doxygen: Add lots of new comment blocks

doxygen: Fix, improve, tidy comment blocks

merge: minor changes

 * Add a comment in auth_gss about RFCs and null-termination.
 * validate docs
 * fix the case of some variables
 * rename convert_to_7bit
 * doxy: add headers

doxy: add headers

rename convert_to_7bit

fix the case of some variables

validate docs

Add a comment in auth_gss about RFCs and null-termination.

Document the config priority

Adjust the precedence of some more config items

Let config file have precedence over environment

Issue #1140

add support for idn2 (IDNA2008)

Improve gss debug printing of status_string.

Commit f52ee2f7 ensured the debug strings were properly '\0'
terminated.  However, it did not prevent the strncpy from reading past
the end of the status_string.value data; it simply capped it
afterwards.  Improve the code so it only reads up to
status_string.length without overwriting the buffer.

Remove trailing null count from gss_buffer_desc.length field.

RFC 2744 section 3.2.2 clearly states that trailing NULL characters
are not to be included in the length field, and are not to be assumed
to be present in the value field.

Thanks to Greg Hudson, who recently debugged this same issue with
fetchmail, and kindly took the time to look at Mutt's code too.

minor IMAP string handling fixes

merge: improvements to libconn

 * replace mutt_socket_write_d by mutt_socket_send_d
 * rename mutt_socket_write to mutt_socket_send
 * introduce mutt_socket_{read,write}
 * don't try to determine buffer size if length was negative
 * rename socket_new_conn to mutt_socket_new
 * define mutt_ssl_socket_setup even when building without SSL
 * move mutt_socket_free to conn/socket.c
 * let mutt_socket_new add Connection to the list
 * move Connections declaration to conn/socket.c
 * add parameter to mutt_socket_new to specify socket type
 * move raw connection to its own file
 * conn/ssl.c: rename local var data to ssldata
 * factorise ssl_socket_open and mutt_ssl_starttls
 * rename tls_close to ssl_socket_close_and_restore

conn: rename tls_close to ssl_socket_close_and_restore

conn: factorise ssl_socket_open and mutt_ssl_starttls

It was in the TODO of mutt_ssl_starttls, so let's do this! The main
difference is that mutt_ssl_starttls now respects options
OPT_SSL_USE_SSLV2 and OPT_SSL_USE_SSLV3. These options default to 0, so
it should have no impacts for users who didn't explicitely set these
options in their config. And if they did, they should be aware of the
security concerns already.

conn/ssl.c: rename local var data to ssldata

conn: move raw connection to its own file

conn: add parameter to mutt_socket_new to specify socket type

It's currently the responsibility of mutt_conn_find to setup the
Connection, but this should really be done by mutt_socket_new, as it's
part of the socket initialization. To let it know which kind of
Connection it should create, add a parameter to allow callers to
specify the type.

move Connections declaration to conn/socket.c

Functions responsible for adding and removing entries to Connections
(the Connection list) are in conn/socket.c, so it makes sense to move
it there too.

Also change mutt_conn_find to use the accessor instead of the global
variable, so it can be made static again.

conn: let mutt_socket_new add Connection to the list

mutt_socket_new is followed by a call to TAILQ_INSERT_HEAD; and
mutt_socket_free takes care of removing the Connection from the
Connection list. Make these two more in pair by making mutt_socket_new
adds the newly created Connection to the connection list.

move mutt_socket_free to conn/socket.c

mutt_socket_new is in conn/socket.c, mutt_socket_free is in
mutt_socket.c. Let's move these two together. "Connections" is made
global during the transition to keep the diffs more straightforward.

conn: define mutt_ssl_socket_setup even when building without SSL

Error conditions were duplicated for builds with and without SSL. This
can be factorized by letting mutt_ssl_socket_setup be defined even when
SSL is not enabled.

conn: rename socket_new_conn to mutt_socket_new

Make this function be in the same "namespace" as other Connection
related functions by making its prefix be "mutt_socket".

conn: don't try to determine buffer size if length was negative

It's caller's responsibility to pass the correct buffer size.

conn: introduce mutt_socket_{read,write}

conn: rename mutt_socket_write to mutt_socket_send

For consistency, and as the buffer size is not passed to this function,
rename it to use "send" instead of "write". This frees
"mutt_socket_write" symbol, so we will be able to reuse it as a wrapper
over conn->conn_write.

conn: replace mutt_socket_write_d by mutt_socket_send_d

Every occurrence of mutt_socket_write_d used -1 as buffer size. Wrap
these calls in a new macro mutt_socket_send_d. Keep "write" for
functions where the size is passed as parameter.

pager specific "show incoming mailboxes list" macro

Exiting the pager before change-folder avoids 'Not available in this
menu' error when selecting a different entry in some circumstances.

[ci skip]

merge: small cleanups

 * add missing extern
 * rename OPT_ variables
 * comment list functions
 * comment and reorder params
 * history: move static functions first
 * history: tidy/sync functions
 * history: free resources
 * free resources

Clarify the relation between NeoMutt and Mutt

Fixes a discrepancy between the website and this README on the topic of "is it a fork?".

 Let mutt_ch_choose report conversion failure (#1137)

* Let mutt_ch_choose report conversion failure

Issue #1136

* Let mutt_ch_convert_string return errno if iconv(..) fails

Previously, mutt_ch_convert_string returned error only if any arguments
failed the sanity check or iconv_open() failed.

With this change, an error value is returned even if the iconv()
conversion fails, such as when the input string contains an invalid
character in the source character set (EILSEQ).

I have looked at each caller and it seems to me that this change won't
introduce any misbehaviour, but I'm far from being 100% confident.

Issue #1136

* test int functions against 0

* Better error reporting in mutt_ch_iconv

Issue #1136

free resources

doc: Describe logging capabilities of NeoMutt

Describe the logging capabilities of NeoMutt in the User Guide. The
section currently covers the different log message types (perror, error,
warning, informational debug), where they are shown and how to enable
debug log messages.

Rename <show-messages> to <show-log-messages>

Rename the function <show-messages> to <show-log-messages> as well as
its symbolic constant OP_SHOW_MESSAGES to OP_SHOW_LOG_MESSAGES.

Background is that 'messages' (in the context of neomutt) refers usually
to emails instead of log messages.

Describe <show-messages> more precisely

The term 'message' is used for log-messages as well as for ordinary
mails. In the help 'message' usually means an email. Adjust the
description of <show-message>/OP_SHOW_MESSAGE to clarify that log and
debug messages are meant.

Remove reminiscent of txt2c

txt2c is replaced by a routine in the configure/autosetup script.
Update .gitignore accordingly.

Generate .clang_complete

For users of https://github.com/Rip-Rip/clang_complete, this allows to
always keep the .clang_complete file in sync with CFLAGS.

Build: restructure ncurses/tinfo checks (#1119)

* Build: restructure ncurses/tinfo checks

Issue #1118

* Fallback to ncurses library for tgetent

This fixes the configure phase in NetBSD, which doesn't have a separate
tinfo library in base.

Issue #1118

history: free resources

history: tidy/sync functions

- sync format_str and menu_entry functions
- reduce scope of variables
- document functions

history: move static functions first

comment and reorder params

comment list functions

rename OPT_ variables

add missing extern

merge: fix cppcheck warnings

 * reduce scope of variables
 * printf format
 * make logic clearer
 * misc fixes
 * match prototypes to their functions

cppcheck: match prototypes to their functions

cppcheck: misc

cppcheck: make logic clearer

cppcheck: printf format

split out progress functions

split out window functions

split out terminal setting

merge: rename functions for consistency

 * body functions
 * header functions
 * enter_state functions
 * alias functions
 * menu functions
 * rfc822 functions

merge: light tidying

 * test ints against 0
 * test int functions against 0
 * tidy comments / docs
 * tidy mutt_str_strdup
 * tidy uses of mutt_str_getenv

merge: refactor config parsing on startup

 * nntp config
 * mailcap config
 * tmpdir config
 * editor, visual config
 * separate get from set Charset

refactor: separate get from set Charset

refactor: editor, visual config

Precedence: environment, config, code

refactor: tmpdir config

Precedence: environment, config, code

refactor: mailcap config

Precedence: environment, config file, code

refactor: nntp config

Precedence: command line, environment, config file, system file

rename rfc822 functions

rename menu functions

rename alias functions

rename enter_state functions

rename header functions

rename body functions

Enhance neomutt -v with NCURSES_VERSION_PATCH

tidy uses of mutt_str_getenv

tidy mutt_str_strdup

refactor: startup hostname

Delay the code that finds the FQDN until after the config and command
line have been processed.

This means that some users, with mis-configured network lookups, can work
around a long timeout during startup.

refactor: move the envlist code to the library

The envlist code keeps a private copy of the environment.

tidy comments / docs

test int functions against 0

cppcheck: reduce scope of variables

test ints against 0

build: fix bmake's lack of variable expansion in "include" lines

slang: don't endwin() if slang wasn't started

merge: trivial improvements

 * docs: update README
 * sort switch cases
 * sort option definitions
 * sort colour fields
 * remove unused variables
 * initialise variables
 * iwyu: fix #include usage
 * docs: add missing comment
 * refactor spanning ifs
 * check for null pointer

check for null pointer

refactor spanning ifs

Refactor an `if` that spans an entire function, to return early.

docs: add missing comment

iwyu: fix #include usage

build: fix dependencies for test dir

initialise variables

scan-build warns that these variables may not get set elsewhere

remove unused variables

Remove variables that are set, but not used again.

sort colour fields

sort option definitions

sort switch cases

There are no code changes here.
The 'case' statements have been sorted where:
- There's a clear order, e.g. alphabetical
- Where they all have break/return statements

docs: update README

- links contributors
- add shields

convert init.h

Another (small) step towards the new config system

lua: fix variable getting/setting

acutest: update with latest upstream (documentation fixes)

fix Notmuch deprecation warning

We need to distinguish between two versions of `notmuch.h`.
Both declare that they are v5.0.0.  They are:

- libnotmuch 5.0 (Notmuch 0.25)
  - `notmuch_database_add_message()` is a normal function
  - `notmuch_database_index_file()` doesn't exist

- libnotmuch 5.1 (Notmuch 0.26)
  - `notmuch_database_add_message()` is **deprecated**
  - `notmuch_database_index_file()` exists

To work around this, we check for `notmuch_database_index_file()` specifically.