From b1b9961ff1c305dff57f547d28cb509bf007bad7 Mon Sep 17 00:00:00 2001 From: pdmef Date: Tue, 1 Mar 2005 17:50:05 +0000 Subject: [PATCH] Rocco Rutte: documentation update (makedoc beautify, added UPGRADING, added scope names for variables in init.h, ...) git-svn-id: svn://svn.berlios.de/mutt-ng/trunk@125 e385b8ad-14ed-0310-8656-cc95a2468c6d --- ChangeLog.mutt-ng | 3 + UPGRADING | 99 ++++++++++++++++++++++ doc/Makefile.in | 2 +- doc/devel-notes.txt | 5 ++ init.h | 194 +++++++++++++++++++++++++++++++++++++++++++- makedoc.c | 16 ++-- 6 files changed, 307 insertions(+), 12 deletions(-) create mode 100644 UPGRADING diff --git a/ChangeLog.mutt-ng b/ChangeLog.mutt-ng index 5e085c6..8b0bc0b 100644 --- a/ChangeLog.mutt-ng +++ b/ChangeLog.mutt-ng @@ -1,5 +1,8 @@ Changes specific to mutt-ng: +2005-03-01: + * somewhat bigger documentation update; introduce UPGRADING document + 2005-02-27: * integrated patch to highlight the next mailbox which includes new mail in sidebar * makes sidebar fit into screen in the pager diff --git a/UPGRADING b/UPGRADING new file mode 100644 index 0000000..070dd77 --- /dev/null +++ b/UPGRADING @@ -0,0 +1,99 @@ +This documents describes changes + + - made to configuration variables, functions and the like which are + not backwards-compatible and/or which do not exist in mutt + + - other changes which might break existing user configuration and thus + have to be documented + +This document is not the place for verbose documentation; it only offers +the necessary keywords to look them up in the manual, ChangeLog or other +sources of information. + +Note: as development goes fast and as documentation is way behind it, +this still likely is incomplete. + +Note for developers: if you encounter anything missing before SVN +rev123, please put it "into" init and removes this comment when done! + +2005-03-01 (init) + + New Variables: + + NNTP-Support: + ask_follow_up, ask_x_comment_to, followup_to_poster, + group_index_format, catchup_newsgroup, inews, news_cache_dir, + newsrc,news_server, nntp_context, nntp_load_description, nntp_pass, + nntp_poll, nntp_reconnect, nntp_user, post_moderated, + save_unsubscribed, show_new_news, show_only_unread, x_comment_to + + Quoting-Initials-Support + indent_string + + libESMTP-Support: + smtp_auth_password, smtp_auth_username, smtp_host, smtp_port + + Assumed Character Set Patch: + assumed_charset, strict_mime, file_charset + + Header Caching: + maildir_header_cache_verify, maildir_cache + + Sidebar: + sidebar_delim, sidebar_visible, sidebar_width, shorten_hierarchy + + Format Flowed Improvements: + max_line_length, quote_empty, quote_quoted + + XTerm-Titles Patch: + xterm_icon, xterm_set_titles, xterm_title + + Misc. + imap_reconnect, msgid_format, operating_system, shorten_hierarchy, + signoff_string, stuff_quoted, umask + + Trash-Folder Patch: + trash + + New Functions: + + NNTP-Support: + change-newsgroup, change-newsgroup-readonly, forward-to-group, + followup-message, get-children, get-message, get-parent, + reconstruct-thread, post-message, catchup, edit-newsgroups, + edit-followup-to, edit-x-comment-to, reload-active, + subscribe-pattern, unsubscribe-pattern, catchup, uncatchup, + + Purge-Message Patch: + purge-message + + List-Reply Patch + list_reply + + Patch edit_threads: + break-thread, link-threads + + Sidebar: + sidebar-open, sidebar-next, sidebar-prev, sidebar-next-new, + sidebar-prev-new, sidebar-scroll-up, sidebar-scroll-down + + New Hooks: + + Compressed-Folder Support: + close-hook, open-hook, append-hook + + New Misc.: + + Sidebar Colors: + sidebar_new, sidebar_flagged + + Scoring Patterns: + ~* + + Other Changes: + + The following tools were removed: bin/pgpewrap, bin/pgpring, + bin/smime_keys and etc/mime.types. + They were replaced by: bin/pgpewrapng, bin/pgpringng, + bin/smime_keysng and etc/muttng-mime.types. + Please check and update your configuration. diff --git a/doc/Makefile.in b/doc/Makefile.in index c42ec5c..260a384 100644 --- a/doc/Makefile.in +++ b/doc/Makefile.in @@ -60,7 +60,7 @@ srcdir_DOCFILES = PGP-Notes.txt applying-patches.txt \ topsrcdir_DOCFILES = COPYRIGHT GPL INSTALL ChangeLog \ - ChangeLog.old ChangeLog.mutt-ng \ + ChangeLog.old ChangeLog.mutt-ng UPGRADING \ README NEWS TODO TODO.mutt-ng README.SECURITY README.SSL all: muttrc.man try-html try-txt diff --git a/doc/devel-notes.txt b/doc/devel-notes.txt index a404922..85b3b7e 100644 --- a/doc/devel-notes.txt +++ b/doc/devel-notes.txt @@ -101,6 +101,7 @@ Style Guide - try to keep mutt-ng as portable as possible. +- do not use C++-style comments (i.e. "// Comment") Documentation ------------- @@ -117,6 +118,10 @@ where you may have to add documentation: Configuration _variables_ are documented directly in init.h. Note that this includes documentation for possibly added format flags! +When adding variables which depend on system-functionality and/or +./configure switches, you have to add additional availability +information to avoid confusion in the manual. + The parts of The Manual and the muttngrc manual page dealing with these variables, and the global Muttrc, are generated automatically from that documentation. To start this process, type "make diff --git a/init.h b/init.h index 1de9507..e668e6a 100644 --- a/init.h +++ b/init.h @@ -215,12 +215,18 @@ struct option_t MuttVars[] = { { "ask_follow_up", DT_BOOL, R_NONE, OPTASKFOLLOWUP, 0 }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** If set, Mutt-ng will prompt you for follow-up groups before editing ** the body of an outgoing message. */ { "ask_x_comment_to", DT_BOOL, R_NONE, OPTASKXCOMMENTTO, 0 }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** If set, Mutt-ng will prompt you for x-comment-to field before editing ** the body of an outgoing message. */ @@ -320,6 +326,9 @@ struct option_t MuttVars[] = { { "catchup_newsgroup", DT_QUAD, R_NONE, OPT_CATCHUP, M_ASKYES }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** If this variable is \fIset\fP, Mutt-ng will mark all articles in newsgroup ** as read when you quit the newsgroup (catchup newsgroup). */ @@ -496,6 +505,9 @@ struct option_t MuttVars[] = { { "dotlock_program", DT_PATH, R_NONE, UL &MuttDotlock, UL BINDIR "/muttng_dotlock" }, /* ** .pp + ** Availability: Standalone and Dotlock + ** + ** .pp ** Contains the path of the muttng_dotlock (1) binary to be used by ** mutt-ng. */ @@ -667,6 +679,9 @@ struct option_t MuttVars[] = { { "followup_to_poster", DT_QUAD, R_NONE, OPT_FOLLOWUPTOPOSTER, M_ASKYES }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** If this variable is \fIset\fP and the keyword "poster" is present in ** \fIFollowup-To\fP header, follow-up to newsgroup function is not ** permitted. The message will be mailed to the submitter of the @@ -748,6 +763,9 @@ struct option_t MuttVars[] = { { "group_index_format", DT_STR, R_BOTH, UL &GroupFormat, UL "%4C %M%N %5s %-45.45f %d" }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** This variable allows you to customize the newsgroup browser display to ** your personal taste. This string is similar to ``$index_format'', but ** has its own set of printf()-like sequences: @@ -872,6 +890,9 @@ struct option_t MuttVars[] = { { "imap_authenticators", DT_STR, R_NONE, UL &ImapAuthenticators, UL 0 }, /* ** .pp + ** Availability: IMAP + ** + ** .pp ** This is a colon-delimited list of authentication methods mutt-ng may ** attempt to use to log in to an IMAP server, in the order mutt-ng should ** try them. Authentication methods are either 'login' or the right @@ -889,6 +910,9 @@ struct option_t MuttVars[] = { { "imap_delim_chars", DT_STR, R_NONE, UL &ImapDelimChars, UL "/." }, /* ** .pp + ** Availability: IMAP + ** + ** .pp ** This contains the list of characters which you would like to treat ** as folder separators for displaying IMAP paths. In particular it ** helps in using the '=' shortcut for your \fIfolder\fP variable. @@ -897,6 +921,9 @@ struct option_t MuttVars[] = { { "imap_force_ssl", DT_BOOL, R_NONE, OPTIMAPFORCESSL, 0 }, /* ** .pp + ** Availability: IMAP and SSL or IMAP and GNUTLS + ** + ** .pp ** If this variable is set, Mutt-ng will always use SSL when ** connecting to IMAP servers. */ @@ -904,6 +931,9 @@ struct option_t MuttVars[] = { { "imap_headers", DT_STR, R_INDEX, UL &ImapHeaders, UL 0}, /* ** .pp + ** Availability: IMAP + ** + ** .pp ** Mutt-ng requests these header fields in addition to the default headers ** ("DATE FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE ** CONTENT-DESCRIPTION IN-REPLY-TO REPLY-TO LINES X-LABEL") from IMAP @@ -913,6 +943,9 @@ struct option_t MuttVars[] = { { "imap_home_namespace", DT_STR, R_NONE, UL &ImapHomeNamespace, UL 0}, /* ** .pp + ** Availability: IMAP + ** + ** .pp ** You normally want to see your personal folders alongside ** your INBOX in the IMAP browser. If you see something else, you may set ** this variable to the IMAP path to your folders. @@ -920,6 +953,9 @@ struct option_t MuttVars[] = { { "imap_keepalive", DT_NUM, R_NONE, UL &ImapKeepalive, 900 }, /* ** .pp + ** Availability: IMAP + ** + ** .pp ** This variable specifies the maximum amount of time in seconds that mutt-ng ** will wait before polling open IMAP connections, to prevent the server ** from closing them before mutt-ng has finished with them. The default is @@ -931,6 +967,9 @@ struct option_t MuttVars[] = { { "imap_list_subscribed", DT_BOOL, R_NONE, OPTIMAPLSUB, 0 }, /* ** .pp + ** Availability: IMAP + ** + ** .pp ** This variable configures whether IMAP folder browsing will look for ** only subscribed folders or all folders. This can be toggled in the ** IMAP browser with the \fItoggle-subscribed\fP function. @@ -938,6 +977,9 @@ struct option_t MuttVars[] = { { "imap_pass", DT_STR, R_NONE, UL &ImapPass, UL 0 }, /* ** .pp + ** Availability: IMAP + ** + ** .pp ** Specifies the password for your IMAP account. If unset, Mutt-ng will ** prompt you for your password when you invoke the fetch-mail function. ** \fBWarning\fP: you should only use this option when you are on a @@ -947,6 +989,9 @@ struct option_t MuttVars[] = { { "imap_passive", DT_BOOL, R_NONE, OPTIMAPPASSIVE, 1 }, /* ** .pp + ** Availability: IMAP + ** + ** .pp ** When set, mutt-ng will not open new IMAP connections to check for new ** mail. Mutt-ng will only check for new mail over existing IMAP ** connections. This is useful if you don't want to be prompted to @@ -956,6 +1001,9 @@ struct option_t MuttVars[] = { { "imap_peek", DT_BOOL, R_NONE, OPTIMAPPEEK, 1 }, /* ** .pp + ** Availability: IMAP + ** + ** .pp ** If set, mutt-ng will avoid implicitly marking your mail as read whenever ** you fetch a message from the server. This is generally a good thing, ** but can make closing an IMAP folder somewhat slower. This option @@ -964,12 +1012,18 @@ struct option_t MuttVars[] = { { "imap_reconnect", DT_QUAD, R_NONE, OPT_IMAPRECONNECT, M_ASKYES }, /* ** .pp + ** Availability: IMAP + ** + ** .pp ** Controls whether or not Mutt-ng will try to reconnect to IMAP server when ** the connection is lost. */ { "imap_servernoise", DT_BOOL, R_NONE, OPTIMAPSERVERNOISE, 1 }, /* ** .pp + ** Availability: IMAP + ** + ** .pp ** When set, mutt-ng will display warning messages from the IMAP ** server as error messages. Since these messages are often ** harmless, or generated due to configuration problems on the @@ -979,6 +1033,9 @@ struct option_t MuttVars[] = { { "imap_user", DT_STR, R_NONE, UL &ImapUser, UL 0 }, /* ** .pp + ** Availability: IMAP + ** + ** .pp ** Your login name on the IMAP server. ** .pp ** This variable defaults to your user name on the local machine. @@ -1087,6 +1144,9 @@ struct option_t MuttVars[] = { { "inews", DT_PATH, R_NONE, UL &Inews, UL "" }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** If set, specifies the program and arguments used to deliver news posted ** by Mutt-ng. Otherwise, mutt-ng posts article using current connection to ** news server. The following printf-style sequence is understood: @@ -1157,6 +1217,9 @@ struct option_t MuttVars[] = { { "header_cache", DT_PATH, R_NONE, UL &HeaderCache, 0 }, /* ** .pp + ** Availability: Header Cache + ** + ** .pp ** The header_cache variable points to the header cache database. If ** header_cache points to a directory there will be created one header cache ** database per folder within this directory. If it doesn't point to a directory a @@ -1166,6 +1229,9 @@ struct option_t MuttVars[] = { { "maildir_header_cache_verify", DT_BOOL, R_NONE, OPTHCACHEVERIFY, 1 }, /* ** .pp + ** Availability: Header Cache + ** + ** .pp ** Check for Maildir unaware programs other than mutt-ng having modified maildir ** files when the header cache is in use. This incurs one stat(2) per ** message every time the folder is opened. @@ -1173,6 +1239,9 @@ struct option_t MuttVars[] = { { "header_cache_pagesize", DT_STR, R_NONE, UL &HeaderCachePageSize, UL "16384" }, /* ** .pp + ** Availability: Header Cache + ** + ** .pp ** Change the maildir header cache database page size. Too large ** or too small of a page size for the common header can waste ** space, memory effectiveness, or CPU time. The default should be more or @@ -1335,6 +1404,9 @@ struct option_t MuttVars[] = { { "mime_subject", DT_BOOL, R_NONE, OPTMIMESUBJECT, 1 }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** If \fIunset\fP, 8-bit ``subject:'' line in article header will not be ** encoded according to RFC2047 to base64. This is useful when message ** is Usenet article, because MIME for news is nonstandard feature. @@ -1345,6 +1417,9 @@ struct option_t MuttVars[] = { { "mix_entry_format", DT_STR, R_NONE, UL &MixEntryFormat, UL "%4n %c %-16s %a" }, /* ** .pp + ** Availability: Mixmaster + ** + ** .pp ** This variable describes the format of a remailer line on the mixmaster ** chain selection screen. The following printf-like sequences are ** supported: @@ -1359,14 +1434,15 @@ struct option_t MuttVars[] = { { "mixmaster", DT_PATH, R_NONE, UL &Mixmaster, UL MIXMASTER }, /* ** .pp + ** Availability: Mixmaster + ** + ** .pp ** This variable contains the path to the Mixmaster binary on your ** system. It is used with various sets of parameters to gather the ** list of known remailers, and to finally send a message through the ** mixmaster chain. */ #endif - - { "move", DT_QUAD, R_NONE, OPT_MOVE, M_ASKNO }, /* ** .pp @@ -1420,6 +1496,9 @@ struct option_t MuttVars[] = { { "news_cache_dir", DT_PATH, R_NONE, UL &NewsCacheDir, UL "~/.mutt" }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** This variable pointing to directory where Mutt-ng will save cached news ** articles headers in. If \fIunset\fP, headers will not be saved at all ** and will be reloaded each time when you enter to newsgroup. @@ -1427,6 +1506,9 @@ struct option_t MuttVars[] = { { "news_server", DT_STR, R_NONE, UL &NewsServer, 0 }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** This variable specifies domain name or address of NNTP server. It ** defaults to the newsserver specified in the environment variable ** $$$NNTPSERVER or contained in the file /etc/nntpserver. You can also @@ -1437,6 +1519,9 @@ struct option_t MuttVars[] = { { "newsrc", DT_PATH, R_NONE, UL &NewsRc, UL "~/.newsrc" }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** The file, containing info about subscribed newsgroups - names and ** indexes of read articles. The following printf-style sequence ** is understood: @@ -1448,6 +1533,9 @@ struct option_t MuttVars[] = { { "nntp_context", DT_NUM, R_NONE, UL &NntpContext, 1000 }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** This variable defines number of articles which will be in index when ** newsgroup entered. If active newsgroup have more articles than this ** number, oldest articles will be ignored. Also controls how many @@ -1456,6 +1544,9 @@ struct option_t MuttVars[] = { { "nntp_load_description", DT_BOOL, R_NONE, OPTLOADDESC, 1 }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** This variable controls whether or not descriptions for each newsgroup ** must be loaded when newsgroup is added to list (first time list ** loading or new newsgroup adding). @@ -1463,6 +1554,9 @@ struct option_t MuttVars[] = { { "nntp_user", DT_STR, R_NONE, UL &NntpUser, UL "" }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** Your login name on the NNTP server. If \fIunset\fP and NNTP server requires ** authentification, Mutt-ng will prompt you for your account name when you ** connect to newsserver. @@ -1470,11 +1564,17 @@ struct option_t MuttVars[] = { { "nntp_pass", DT_STR, R_NONE, UL &NntpPass, UL "" }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** Your password for NNTP account. */ { "nntp_poll", DT_NUM, R_NONE, UL &NewsPollTimeout, 60 }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** The time in seconds until any operations on newsgroup except post new ** article will cause recheck for new news. If set to 0, Mutt-ng will ** recheck newsgroup on each operation in index (stepping, read article, @@ -1483,6 +1583,9 @@ struct option_t MuttVars[] = { { "nntp_reconnect", DT_QUAD, R_NONE, OPT_NNTPRECONNECT, M_ASKYES }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** Controls whether or not Mutt-ng will try to reconnect to newsserver when ** connection lost. */ @@ -2101,12 +2204,18 @@ struct option_t MuttVars[] = { { "smtp_auth_username", DT_STR, R_NONE, UL &SmtpAuthUser, 0 }, /* ** .pp + ** Availability: SMTP + ** + ** .pp ** Defines the username to use with SMTP AUTH. Setting this variable will ** cause mutt-ng to attempt to use SMTP AUTH when sending. */ { "smtp_auth_password", DT_STR, R_NONE, UL &SmtpAuthPass, 0 }, /* ** .pp + ** Availability: SMTP + ** + ** .pp ** Defines the password to use with SMTP AUTH. If ``$$smtp_auth_username'' ** is set, but this variable is not, you will be prompted for a password ** when sending. @@ -2114,6 +2223,9 @@ struct option_t MuttVars[] = { { "smtp_host", DT_STR, R_NONE, UL &SmtpHost, 0 }, /* ** .pp + ** Availability: SMTP + ** + ** .pp ** Defines the SMTP host which will be used to deliver mail, as opposed ** to invoking the sendmail binary. Setting this variable overrides the ** value of ``$$sendmail'', and any associated variables. @@ -2121,6 +2233,9 @@ struct option_t MuttVars[] = { { "smtp_port", DT_NUM, R_NONE, UL &SmtpPort, 25 }, /* ** .pp + ** Availability: SMTP + ** + ** .pp ** Defines the port that the SMTP host is listening on for mail delivery. ** Must be specified as a number. ** .pp @@ -2128,12 +2243,14 @@ struct option_t MuttVars[] = { ** servers will probably desire 587, the mail submission port. */ #endif - #if defined(USE_SSL)||defined(USE_NSS)||defined(USE_GNUTLS) #ifdef USE_SSL { "ssl_client_cert", DT_PATH, R_NONE, UL &SslClientCert, 0 }, /* ** .pp + ** Availability: SSL + ** + ** .pp ** The file containing a client certificate and its associated private ** key. */ @@ -2142,6 +2259,9 @@ struct option_t MuttVars[] = { { "ssl_starttls", DT_QUAD, R_NONE, OPT_SSLSTARTTLS, M_YES }, /* ** .pp + ** Availability: SSL or GNUTLS + ** + ** .pp ** If set (the default), mutt-ng will attempt to use STARTTLS on servers ** advertising the capability. When unset, mutt-ng will not attempt to ** use STARTTLS regardless of the server's capabilities. @@ -2150,6 +2270,9 @@ struct option_t MuttVars[] = { { "certificate_file", DT_PATH, R_NONE, UL &SslCertFile, UL "~/.mutt_certificates" }, /* ** .pp + ** Availability: SSL or NSS or GNUTLS + ** + ** .pp ** This variable specifies the file where the certificates you trust ** are saved. When an unknown certificate is encountered, you are asked ** if you accept it or not. If you accept it, the certificate can also @@ -2166,6 +2289,9 @@ struct option_t MuttVars[] = { { "ssl_usesystemcerts", DT_BOOL, R_NONE, OPTSSLSYSTEMCERTS, 1 }, /* ** .pp + ** Availability: SSL or NSS + ** + ** .pp ** If set to \fIyes\fP, mutt-ng will use CA certificates in the ** system-wide certificate store when checking if server certificate ** is signed by a trusted CA. @@ -2173,12 +2299,18 @@ struct option_t MuttVars[] = { { "entropy_file", DT_PATH, R_NONE, UL &SslEntropyFile, 0 }, /* ** .pp + ** Availability: SSL or NSS + ** + ** .pp ** The file which includes random data that is used to initialize SSL ** library functions. */ { "ssl_use_sslv2", DT_BOOL, R_NONE, OPTSSLV2, 1 }, /* ** .pp + ** Availability: SSL or NSS + ** + ** .pp ** This variables specifies whether to attempt to use SSLv2 in the ** SSL authentication process. */ @@ -2186,12 +2318,18 @@ struct option_t MuttVars[] = { { "ssl_use_sslv3", DT_BOOL, R_NONE, OPTSSLV3, 1 }, /* ** .pp + ** Availability: SSL or NSS or GNUTLS + ** + ** .pp ** This variables specifies whether to attempt to use SSLv3 in the ** SSL authentication process. */ { "ssl_use_tlsv1", DT_BOOL, R_NONE, OPTTLSV1, 1 }, /* ** .pp + ** Availability: SSL or NSS or GNUTLS + ** + ** .pp ** This variables specifies whether to attempt to use TLSv1 in the ** SSL authentication process. */ @@ -2199,6 +2337,9 @@ struct option_t MuttVars[] = { { "ssl_min_dh_prime_bits", DT_NUM, R_NONE, UL &SslDHPrimeBits, 0 }, /* ** .pp + ** Availability: GNUTLS + ** + ** .pp ** This variable specifies the minimum acceptable prime size (in bits) ** for use in any Diffie-Hellman key exchange. A value of 0 will use ** the default from the GNUTLS library. @@ -2242,6 +2383,9 @@ struct option_t MuttVars[] = { { "pop_authenticators", DT_STR, R_NONE, UL &PopAuthenticators, UL 0 }, /* ** .pp + ** Availability: POP + ** + ** .pp ** This is a colon-delimited list of authentication methods mutt-ng may ** attempt to use to log in to an POP server, in the order mutt-ng should ** try them. Authentication methods are either 'user', 'apop' or any @@ -2255,6 +2399,9 @@ struct option_t MuttVars[] = { { "pop_auth_try_all", DT_BOOL, R_NONE, OPTPOPAUTHTRYALL, 1 }, /* ** .pp + ** Availability: POP + ** + ** .pp ** If set, Mutt-ng will try all available methods. When unset, Mutt-ng will ** only fall back to other authentication methods if the previous ** methods are unavailable. If a method is available but authentication @@ -2263,12 +2410,18 @@ struct option_t MuttVars[] = { { "pop_checkinterval", DT_NUM, R_NONE, UL &PopCheckTimeout, 60 }, /* ** .pp + ** Availability: POP + ** + ** .pp ** This variable configures how often (in seconds) POP should look for ** new mail. */ { "pop_delete", DT_QUAD, R_NONE, OPT_POPDELETE, M_ASKNO }, /* ** .pp + ** Availability: POP + ** + ** .pp ** If set, Mutt-ng will delete successfully downloaded messages from the POP ** server when using the fetch-mail function. When unset, Mutt-ng will ** download messages but also leave them on the POP server. @@ -2276,6 +2429,9 @@ struct option_t MuttVars[] = { { "pop_host", DT_STR, R_NONE, UL &PopHost, UL "" }, /* ** .pp + ** Availability: POP + ** + ** .pp ** The name of your POP server for the fetch-mail function. You ** can also specify an alternative port, username and password, ie: ** .pp @@ -2284,6 +2440,9 @@ struct option_t MuttVars[] = { { "pop_last", DT_BOOL, R_NONE, OPTPOPLAST, 0 }, /* ** .pp + ** Availability: POP + ** + ** .pp ** If this variable is set, mutt-ng will try to use the "LAST" POP command ** for retrieving only unread messages from the POP server when using ** the fetch-mail function. @@ -2291,12 +2450,18 @@ struct option_t MuttVars[] = { { "pop_reconnect", DT_QUAD, R_NONE, OPT_POPRECONNECT, M_ASKYES }, /* ** .pp + ** Availability: POP + ** + ** .pp ** Controls whether or not Mutt-ng will try to reconnect to POP server when ** connection lost. */ { "pop_user", DT_STR, R_NONE, UL &PopUser, 0 }, /* ** .pp + ** Availability: POP + ** + ** .pp ** Your login name on the POP server. ** .pp ** This variable defaults to your user name on the local machine. @@ -2304,6 +2469,9 @@ struct option_t MuttVars[] = { { "pop_pass", DT_STR, R_NONE, UL &PopPass, UL "" }, /* ** .pp + ** Availability: POP + ** + ** .pp ** Specifies the password for your POP account. If unset, Mutt-ng will ** prompt you for your password when you open POP mailbox. ** \fBWarning\fP: you should only use this option when you are on a @@ -2324,6 +2492,9 @@ struct option_t MuttVars[] = { { "post_moderated", DT_QUAD, R_NONE, OPT_TOMODERATED, M_ASKYES }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** If set to \fIyes\fP, Mutt-ng will post article to newsgroup that have ** not permissions to posting (e.g. moderated). \fBNote:\fP if newsserver ** does not support posting to that newsgroup or totally read-only, that @@ -2695,9 +2866,13 @@ struct option_t MuttVars[] = { { "save_unsubscribed",DT_BOOL, R_NONE, OPTSAVEUNSUB, 0 }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** When \fIset\fP, info about unsubscribed newsgroups will be saved into ** ``newsrc'' file and into cache. */ +#endif { "shorten_hierarchy", DT_BOOL, R_NONE, OPTSHORTENHIERARCHY, 0 }, /* ** .pp @@ -2708,9 +2883,13 @@ struct option_t MuttVars[] = { ** ``d.a.s.recovery'' while ``de.alt.d0'' still would and thus will not get ** shortened. */ +#ifdef USE_NNTP { "show_new_news", DT_BOOL, R_NONE, OPTSHOWNEWNEWS, 1 }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** If \fIset\fP, newsserver will be asked for new newsgroups on entering ** the browser. Otherwise, it will be done only once for a newsserver. ** Also controls whether or not number of new articles of subscribed @@ -2719,6 +2898,9 @@ struct option_t MuttVars[] = { { "show_only_unread", DT_BOOL, R_NONE, OPTSHOWONLYUNREAD, 0 }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** If \fIset\fP, only subscribed newsgroups that contain unread articles ** will be displayed in browser. */ @@ -3137,6 +3319,9 @@ struct option_t MuttVars[] = { { "use_idn", DT_BOOL, R_BOTH, OPTUSEIDN, 1}, /* ** .pp + ** Availability: IDN + ** + ** .pp ** When \fIset\fP, Mutt-ng will show you international domain names decoded. ** Note: You can use IDNs for addresses even if this is \fIunset\fP. ** This variable only affects decoding. @@ -3238,6 +3423,9 @@ struct option_t MuttVars[] = { { "x_comment_to", DT_BOOL, R_NONE, OPTXCOMMENTTO, 0 }, /* ** .pp + ** Availability: NNTP + ** + ** .pp ** If \fIset\fP, Mutt-ng will add ``X-Comment-To:'' field (that contains full ** name of original article author) to article that followuped to newsgroup. */ diff --git a/makedoc.c b/makedoc.c index 08fd73e..52e15d8 100644 --- a/makedoc.c +++ b/makedoc.c @@ -749,21 +749,21 @@ static void print_confline (const char *varname, int type, const char *val) add ("