#endif
/* These Config Variables are only used in browser.c */
-bool BrowserAbbreviateMailboxes;
+bool BrowserAbbreviateMailboxes; ///< Config: Abbreviate mailboxes using '~' and '=' in the browser
char *FolderFormat; ///< Config: printf-like format string for the browser's display of folders
char *GroupIndexFormat; ///< Config: (nntp) printf-like format string for the browser's display of newsgroups
char *NewsgroupsCharset; ///< Config: (nntp) Character set of newsgroups' descriptions
-bool ShowOnlyUnread;
+bool ShowOnlyUnread; ///< Config: (nntp) Only show subscribed newsgroups with unread articles
short SortBrowser; ///< Config: Sort method for the browser
char *VfolderFormat; ///< Config: (notmuch) printf-like format string for the browser's display of virtual folders
#endif
/* These Config Variables are only used in commands.c */
-unsigned char CryptVerifySig; /* verify PGP signatures */ ///< Config: Verify PGP or SMIME signatures
+unsigned char CryptVerifySig; ///< Config: Verify PGP or SMIME signatures
char *DisplayFilter; ///< Config: External command to pre-process an email before display
bool PipeDecode; ///< Config: Decode the message when piping it
char *PipeSep; ///< Config: Separator to add between multiple piped messages
#endif
#ifdef USE_SSL
-bool SslUseSslv3;
-bool SslUseTlsv1;
-bool SslUseTlsv11;
-bool SslUseTlsv12;
-bool SslVerifyDates;
-bool SslVerifyHost;
+bool SslUseSslv3; ///< Config: (ssl) INSECURE: Use SSLv3 for authentication
+bool SslUseTlsv1; ///< Config: (ssl) Use TLSv1 for authentication
+bool SslUseTlsv11; ///< Config: (ssl) Use TLSv1.1 for authentication
+bool SslUseTlsv12; ///< Config: (ssl) Use TLSv1.2 for authentication
+bool SslVerifyDates; ///< Config: (ssl) Verify the dates on the server certificate
+bool SslVerifyHost; ///< Config: (ssl) Verify the server's hostname against the certificate
#endif
/* These Config Variables are only used in conn/conn_raw.c */
#ifdef HAVE_GETADDRINFO
-bool UseIpv6;
+bool UseIpv6; ///< Config: Lookup IPv6 addresses when making connections
#endif
/**
#endif
/* These Config Variables are only used in curs_lib.c */
-bool MetaKey; /**< interpret ALT-x as ESC-x */
+bool MetaKey; ///< Config: Interpret 'ALT-x' as 'ESC-x'
/* not possible to unget more than one char under some curses libs, and it
* is impossible to unget function keys in SLang, so roll our own input
#endif
/* These Config Variables are only used in curs_main.c */
-bool ChangeFolderNext;
+bool ChangeFolderNext; ///< Config: Suggest the next folder, rather than the first when using '<change-folder>'
bool CollapseAll; ///< Config: Collapse all threads when entering a folder
bool CollapseFlagged; ///< Config: Prevent the collapse of threads with flagged emails
bool CollapseUnread; ///< Config: Prevent the collapse of threads with unread emails
-char *MarkMacroPrefix;
+char *MarkMacroPrefix; ///< Config: Prefix for macros using '<mark-message>'
bool PgpAutoDecode; ///< Config: Automatically decrypt PGP messages
bool UncollapseJump; ///< Config: When opening a thread, jump to the next unread message
bool UncollapseNew; ///< Config: Open collapsed threads when new mail arrives
#include "protos.h"
/* These Config Variables are only used in edit.c */
-char *Escape; ///< Config: Escape character to use for functions in the built-in editor.
+char *Escape; ///< Config: Escape character to use for functions in the built-in editor
/* SLcurses_waddnstr() can't take a "const char *", so this is only
* declared "static" (sigh)
/* Config items */
bool MarkOld = false; ///< Config: Mark new emails as old when leaving the mailbox
struct Regex *ReplyRegex = NULL; ///< Config: Regex to match message reply subjects like "re: "
-char *SendCharset = NULL; ///< Config: Character sets for outgoing mail
-char *SpamSeparator = NULL; ///< Config: Separator for multiple spam headers
+char *SendCharset = NULL; ///< Config: Character sets for outgoing mail ///< Config: List of character sets for outgoing messages
+char *SpamSeparator = NULL; ///< Config: Separator for multiple spam headers ///< Config: Separator for spam headers
bool Weed = false; ///< Config: Filter headers when displaying/forwarding/printing/replying
/* Global variables */
#include "rfc2047.h"
/* These Config Variables are only used in rfc2231.c */
-bool Rfc2047Parameters;
+bool Rfc2047Parameters; ///< Config: Decode RFC2047-encoded MIME parameters
/**
* struct Rfc2231Parameter - MIME section parameter
#include <signal.h>
#include <stdbool.h>
#include "mutt/mutt.h"
-#include "where.h"
#include "config/lib.h"
+#include "where.h"
#ifdef MAIN_C
/* so that global vars get included */
/* All the variables below are backing for config items */
-WHERE struct Address *EnvelopeFromAddress;
-WHERE struct Address *From; ///< Config: Default 'From' address to use, if isn't otherwise set
-
-WHERE char *AliasFile; ///< Config: Save new aliases to this file
-WHERE char *Attribution; ///< Config: Message to start a reply, "On DATE, PERSON wrote:"
-WHERE char *AttributionLocale; ///< Config: Locale for dates in the attribution message
-WHERE char *AttachFormat; ///< Config: printf-like format string for the attachment menu
-WHERE char *ConfigCharset; ///< Config: Character set that the config files are in
-WHERE char *DateFormat; ///< Config: strftime format string for the `%d` expando
-WHERE char *DsnNotify;
-WHERE char *DsnReturn;
-WHERE char *Editor; ///< Config: External command to use as an email editor
-WHERE char *Hostname; ///< Config: Fully-qualified domain name of this machine
-WHERE char *IndexFormat; ///< Config: printf-like format string for the index menu (emails)
+WHERE struct Address *EnvelopeFromAddress; ///< Config: Manually set the sender for outgoing messages
+WHERE struct Address *From; ///< Config: Default 'From' address to use, if isn't otherwise set
+
+WHERE char *AliasFile; ///< Config: Save new aliases to this file
+WHERE char *Attribution; ///< Config: Message to start a reply, "On DATE, PERSON wrote:"
+WHERE char *AttributionLocale; ///< Config: Locale for dates in the attribution message
+WHERE char *AttachFormat; ///< Config: printf-like format string for the attachment menu
+WHERE char *ConfigCharset; ///< Config: Character set that the config files are in
+WHERE char *DateFormat; ///< Config: strftime format string for the `%d` expando
+WHERE char *DsnNotify; ///< Config: Request notification for message delivery or delay
+WHERE char *DsnReturn; ///< Config: What to send as a notification of message delivery or delay
+WHERE char *Editor; ///< Config: External command to use as an email editor
+WHERE char *Hostname; ///< Config: Fully-qualified domain name of this machine
+WHERE char *IndexFormat; ///< Config: printf-like format string for the index menu (emails)
#ifdef USE_IMAP
-WHERE char *ImapUser; ///< Config: (imap) Username for the IMAP server
+WHERE char *ImapUser; ///< Config: (imap) Username for the IMAP server
#endif
-WHERE char *Mbox; ///< Config: Folder that receives read emails (see Move)
-WHERE char *MailcapPath; ///< Config: Colon-separated list of mailcap files
-WHERE char *Folder; ///< Config: Base folder for a set of mailboxes
+WHERE char *Mbox; ///< Config: Folder that receives read emails (see Move)
+WHERE char *MailcapPath; ///< Config: Colon-separated list of mailcap files
+WHERE char *Folder; ///< Config: Base folder for a set of mailboxes
#ifdef USE_HCACHE
-WHERE char *HeaderCache; ///< Config: (hcache) Directory/file for the header cache database
+WHERE char *HeaderCache; ///< Config: (hcache) Directory/file for the header cache database
#if defined(HAVE_GDBM) || defined(HAVE_BDB)
-WHERE char *HeaderCachePagesize; ///< Config: (hcache) Database page size (gdbm,bdb4)
+WHERE char *HeaderCachePagesize; ///< Config: (hcache) Database page size (gdbm,bdb4)
#endif /* HAVE_GDBM || HAVE_BDB */
#endif /* USE_HCACHE */
#ifdef USE_SOCKET
-WHERE short NetInc; ///< Config: (socket) Update the progress bar after this many KB sent/received (0 to disable)
+WHERE short NetInc; ///< Config: (socket) Update the progress bar after this many KB sent/received (0 to disable)
#endif /* USE_SOCKET */
#ifdef USE_NNTP
-WHERE char *NewsServer; ///< Config: (nntp) Url of the news server
+WHERE char *NewsServer; ///< Config: (nntp) Url of the news server
#endif
-WHERE char *Record; ///< Config: Folder to save 'sent' messages
-WHERE char *Pager; ///< Config: External command for viewing messages, or 'builtin' to use NeoMutt's
-WHERE char *PagerFormat; ///< Config: printf-like format string for the pager's status bar
-WHERE char *Postponed; ///< Config: Folder to store postponed messages
-WHERE char *IndentString; ///< Config: String used to indent 'reply' text
-WHERE char *PrintCommand; ///< Config: External command to print a message
-WHERE char *NewMailCommand; ///< Config: External command to run when new mail arrives
-WHERE char *Realname; ///< Config: Real name of the user
-WHERE char *Shell; ///< Config: External command to run subshells in
-WHERE char *SimpleSearch; ///< Config: Pattern to search for when search doesn't contain ~'s
+WHERE char *Record; ///< Config: Folder to save 'sent' messages
+WHERE char *Pager; ///< Config: External command for viewing messages, or 'builtin' to use NeoMutt's
+WHERE char *PagerFormat; ///< Config: printf-like format string for the pager's status bar
+WHERE char *Postponed; ///< Config: Folder to store postponed messages
+WHERE char *IndentString; ///< Config: String used to indent 'reply' text
+WHERE char *PrintCommand; ///< Config: External command to print a message
+WHERE char *NewMailCommand; ///< Config: External command to run when new mail arrives
+WHERE char *Realname; ///< Config: Real name of the user
+WHERE char *Shell; ///< Config: External command to run subshells in
+WHERE char *SimpleSearch; ///< Config: Pattern to search for when search doesn't contain ~'s
#ifdef USE_SMTP
-WHERE char *SmtpUrl; ///< Config: (smtp) Url of the SMTP server
+WHERE char *SmtpUrl; ///< Config: (smtp) Url of the SMTP server
#endif /* USE_SMTP */
-WHERE char *Spoolfile;
-WHERE char *StatusFormat; ///< Config: printf-like format string for the index's status line
-WHERE char *TsStatusFormat; ///< Config: printf-like format string for the terminal's status (window title)
-WHERE char *TsIconFormat; ///< Config: printf-like format string for the terminal's icon title
-WHERE char *Visual; ///< Config: Editor to use when '~v' is given in the built-in editor
-
-WHERE short ReadInc; ///< Config: Update the progress bar after this many records read (0 to disable)
-WHERE short SleepTime; ///< Config: Time to pause after certain info messages
-WHERE short Timeout;
-WHERE short Wrap;
-WHERE short WriteInc; ///< Config: Update the progress bar after this many records written (0 to disable)
+WHERE char *Spoolfile; ///< Config: Inbox
+WHERE char *StatusFormat; ///< Config: printf-like format string for the index's status line
+WHERE char *TsStatusFormat; ///< Config: printf-like format string for the terminal's status (window title)
+WHERE char *TsIconFormat; ///< Config: printf-like format string for the terminal's icon title
+WHERE char *Visual; ///< Config: Editor to use when '~v' is given in the built-in editor
+
+WHERE short ReadInc; ///< Config: Update the progress bar after this many records read (0 to disable)
+WHERE short SleepTime; ///< Config: Time to pause after certain info messages
+WHERE short Timeout; ///< Config: Time to wait for user input in menus
+WHERE short Wrap; ///< Config: Width to wrap text in the pager
+WHERE short WriteInc; ///< Config: Update the progress bar after this many records written (0 to disable)
#ifdef USE_SIDEBAR
-WHERE short SidebarWidth; ///< Config: (sidebar) Width of the sidebar
+WHERE short SidebarWidth; ///< Config: (sidebar) Width of the sidebar
#endif
#ifdef USE_IMAP
-WHERE short ImapKeepalive;
-WHERE short ImapPollTimeout;
+WHERE short ImapKeepalive; ///< Config: (imap) Time to wait before polling an open IMAP connection
+WHERE short ImapPollTimeout; ///< Config: (imap) Maximum time to wait for a server response
#endif
/* -- formerly in pgp.h -- */
-WHERE char *PgpDefaultKey; ///< Config: Default key to use for PGP operations
-WHERE char *PgpSignAs; ///< Config: Use this alternative key for signing messages
-WHERE char *PgpEntryFormat; ///< Config: printf-like format string for the PGP key selection menu
+WHERE char *PgpDefaultKey; ///< Config: Default key to use for PGP operations
+WHERE char *PgpSignAs; ///< Config: Use this alternative key for signing messages
+WHERE char *PgpEntryFormat; ///< Config: printf-like format string for the PGP key selection menu
/* -- formerly in smime.h -- */
-WHERE char *SmimeDefaultKey; ///< Config: Default key for SMIME operations
-WHERE char *SmimeSignAs; ///< Config: Use this alternative key for signing messages
-WHERE char *SmimeEncryptWith; ///< Config: Algorithm for encryption
+WHERE char *SmimeDefaultKey; ///< Config: Default key for SMIME operations
+WHERE char *SmimeSignAs; ///< Config: Use this alternative key for signing messages
+WHERE char *SmimeEncryptWith; ///< Config: Algorithm for encryption
#ifdef USE_NOTMUCH
-WHERE int NmQueryWindowDuration;
-WHERE char *NmQueryWindowCurrentSearch;
+WHERE int NmQueryWindowDuration; ///< Config: (notmuch) Time duration of the current search window
+WHERE char *NmQueryWindowCurrentSearch; ///< Config: (notmuch) Current search parameters
#endif
/* These variables are backing for config items */
-WHERE struct Regex *Mask; ///< Config: Only display files/dirs matching this regex in the browser
-WHERE struct Regex *QuoteRegex; ///< Config: Regex to match quoted text in a reply
+WHERE struct Regex *Mask; ///< Config: Only display files/dirs matching this regex in the browser
+WHERE struct Regex *QuoteRegex; ///< Config: Regex to match quoted text in a reply
/* Quad-options */
-WHERE unsigned char Bounce;
-WHERE unsigned char Copy; ///< Config: Save outgoing emails to $record
-WHERE unsigned char Delete; ///< Config: Really delete messages, when the mailbox is closed
-WHERE unsigned char MimeForward;
-WHERE unsigned char Print; ///< Config: Confirm before printing a message
-WHERE unsigned char Quit; ///< Config: Prompt before exiting NeoMutt
+WHERE unsigned char Bounce; ///< Config: Confirm before bouncing a message
+WHERE unsigned char Copy; ///< Config: Save outgoing emails to $record
+WHERE unsigned char Delete; ///< Config: Really delete messages, when the mailbox is closed
+WHERE unsigned char MimeForward; ///< Config: Forward a message as a 'message/RFC822' MIME part
+WHERE unsigned char Print; ///< Config: Confirm before printing a message
+WHERE unsigned char Quit; ///< Config: Prompt before exiting NeoMutt
#ifdef USE_SSL
-WHERE unsigned char SslStarttls;
+WHERE unsigned char SslStarttls; ///< Config: (ssl) Use STARTTLS on servers advertising the capability
#endif
#ifdef USE_NNTP
-WHERE unsigned char PostModerated;
-WHERE unsigned char FollowupToPoster;
+WHERE unsigned char PostModerated; ///< Config: (nntp) Allow posting to moderated newsgroups
+WHERE unsigned char FollowupToPoster; ///< Config: (nntp) Reply to the poster if 'poster' is in the 'Followup-To' header
#endif
-WHERE bool ArrowCursor; ///< Config: Use an arrow '->' instead of highlighting in the index
-WHERE bool AsciiChars; ///< Config: Use plain ASCII characters, when drawing email threads
-WHERE bool Askbcc; ///< Config: Ask the user for the blind-carbon-copy recipients
-WHERE bool Askcc; ///< Config: Ask the user for the carbon-copy recipients
-WHERE bool Autoedit;
-WHERE bool AutoTag;
-WHERE bool Beep; ///< Config: Make a noise when an error occurs
-WHERE bool BeepNew; ///< Config: Make a noise when new mail arrives
-WHERE bool BrailleFriendly; ///< Config: Move the cursor to the beginning of the line
-WHERE bool CheckMboxSize; ///< Config: (mbox,mmdf) Use mailbox size as an indicator of new mail
-WHERE bool Confirmappend; ///< Config: Confirm before appending emails to a mailbox
-WHERE bool Confirmcreate; ///< Config: Confirm before creating a new mailbox
-WHERE bool DeleteUntag;
-WHERE bool EditHeaders; ///< Config: Let the user edit the email headers whilst editing an email
-WHERE bool FlagSafe; ///< Config: Protect flagged messages from deletion
-WHERE bool ForwardDecode; ///< Config: Decode the message when forwarding it
-WHERE bool ForwardQuote; ///< Config: Automatically quote a forwarded message using IndentString
+WHERE bool ArrowCursor; ///< Config: Use an arrow '->' instead of highlighting in the index
+WHERE bool AsciiChars; ///< Config: Use plain ASCII characters, when drawing email threads
+WHERE bool Askbcc; ///< Config: Ask the user for the blind-carbon-copy recipients
+WHERE bool Askcc; ///< Config: Ask the user for the carbon-copy recipients
+WHERE bool Autoedit; ///< Config: Skip the initial compose menu and edit the email
+WHERE bool AutoTag; ///< Config: Automatically apply actions to all tagged messages
+WHERE bool Beep; ///< Config: Make a noise when an error occurs
+WHERE bool BeepNew; ///< Config: Make a noise when new mail arrives
+WHERE bool BrailleFriendly; ///< Config: Move the cursor to the beginning of the line
+WHERE bool CheckMboxSize; ///< Config: (mbox,mmdf) Use mailbox size as an indicator of new mail
+WHERE bool Confirmappend; ///< Config: Confirm before appending emails to a mailbox
+WHERE bool Confirmcreate; ///< Config: Confirm before creating a new mailbox
+WHERE bool DeleteUntag; ///< Config: Untag messages when they are marked for deletion
+WHERE bool EditHeaders; ///< Config: Let the user edit the email headers whilst editing an email
+WHERE bool FlagSafe; ///< Config: Protect flagged messages from deletion
+WHERE bool ForwardDecode; ///< Config: Decode the message when forwarding it
+WHERE bool ForwardQuote; ///< Config: Automatically quote a forwarded message using IndentString
#ifdef USE_HCACHE
#if defined(HAVE_QDBM) || defined(HAVE_TC) || defined(HAVE_KC)
-WHERE bool HeaderCacheCompress; ///< Config: (hcache) Enable database compression (qdbm,tokyocabinet,kyotocabinet)
+WHERE bool HeaderCacheCompress; ///< Config: (hcache) Enable database compression (qdbm,tokyocabinet,kyotocabinet)
#endif /* HAVE_QDBM */
#endif
-WHERE bool Header; ///< Config: Include the message headers in the reply email (Weed applies)
-WHERE bool Help; ///< Config: Display a help line with common key bindings
+WHERE bool Header; ///< Config: Include the message headers in the reply email (Weed applies)
+WHERE bool Help; ///< Config: Display a help line with common key bindings
#ifdef USE_IMAP
-WHERE bool ImapCheckSubscribed; ///< Config: (imap) Ask the IMAP server for a list of subscribed folders
-WHERE bool ImapListSubscribed;
-WHERE bool ImapPassive;
-WHERE bool ImapPeek;
+WHERE bool ImapCheckSubscribed; ///< Config: (imap) Ask the IMAP server for a list of subscribed folders
+WHERE bool ImapListSubscribed; ///< Config: (imap) Get a list of mailboxes from the server
+WHERE bool ImapPassive; ///< Config: (imap) Reuse an existing IMAP connection to check for new mail
+WHERE bool ImapPeek; ///< Config: (imap) Don't mark messages as read when fetching them from the server
#endif
#ifdef USE_SSL
#ifndef USE_SSL_GNUTLS
-WHERE bool SslUsesystemcerts;
-WHERE bool SslUseSslv2;
+WHERE bool SslUsesystemcerts; ///< Config: (ssl) Use CA certificates in the system-wide store
+WHERE bool SslUseSslv2; ///< Config: (ssl) INSECURE: Use SSLv2 for authentication
#endif /* USE_SSL_GNUTLS */
-WHERE bool SslForceTls;
+WHERE bool SslForceTls; ///< Config: (ssl) Require TLS encryption for all connections
#if defined(USE_SSL_OPENSSL) && defined(HAVE_SSL_PARTIAL_CHAIN)
-WHERE bool SslVerifyPartialChains;
+WHERE bool SslVerifyPartialChains; ///< Config: (ssl) Allow verification using partial certificate chains
#endif /* USE_SSL_OPENSSL */
#endif /* defined(USE_SSL) */
-WHERE bool MailCheckRecent;
-WHERE bool MaildirTrash; ///< Config: Use the maildir 'trashed' flag, rather than deleting
-WHERE bool Markers; ///< Config: Display a '+' at the beginning of wrapped lines in the pager
+WHERE bool MailCheckRecent; ///< Config: Notify the user about new mail since the last time the mailbox was opened
+WHERE bool MaildirTrash; ///< Config: Use the maildir 'trashed' flag, rather than deleting
+WHERE bool Markers; ///< Config: Display a '+' at the beginning of wrapped lines in the pager
#if defined(USE_IMAP) || defined(USE_POP)
-WHERE bool MessageCacheClean; ///< Config: (imap/pop) Clean out obsolete entries from the message cache
+WHERE bool MessageCacheClean; ///< Config: (imap/pop) Clean out obsolete entries from the message cache
#endif
-WHERE bool ReadOnly; ///< Config: Open folders in read-only mode
-WHERE bool Resolve;
-WHERE bool ResumeDraftFiles;
-WHERE bool SaveAddress;
-WHERE bool SaveEmpty; ///< Config: (mbox,mmdf) Preserve empty mailboxes
-WHERE bool Score; ///< Config: Use message scoring
+WHERE bool ReadOnly; ///< Config: Open folders in read-only mode
+WHERE bool Resolve; ///< Config: Move to the next email whenever a command modifies an email
+WHERE bool ResumeDraftFiles; ///< Config: Process draft files like postponed messages
+WHERE bool SaveAddress; ///< Config: Use sender's full address as a default save folder
+WHERE bool SaveEmpty; ///< Config: (mbox,mmdf) Preserve empty mailboxes
+WHERE bool Score; ///< Config: Use message scoring
#ifdef USE_SIDEBAR
-WHERE bool SidebarVisible; ///< Config: (sidebar) Show the sidebar
-WHERE bool SidebarOnRight; ///< Config: (sidebar) Display the sidebar on the right
+WHERE bool SidebarVisible; ///< Config: (sidebar) Show the sidebar
+WHERE bool SidebarOnRight; ///< Config: (sidebar) Display the sidebar on the right
#endif
-WHERE bool StatusOnTop; ///< Config: Display the status bar at the top
-WHERE bool Suspend;
-WHERE bool TextFlowed;
-WHERE bool TsEnabled;
-WHERE bool UseDomain;
-WHERE bool WaitKey; ///< Config: Prompt to press a key after running external commands
-WHERE bool WrapSearch;
-WHERE bool WriteBcc; /**< write out a bcc header? */
+WHERE bool StatusOnTop; ///< Config: Display the status bar at the top
+WHERE bool Suspend; ///< Config: Allow the user to suspend NeoMutt using '^Z'
+WHERE bool TextFlowed; ///< Config: Generate 'format=flowed' messages
+WHERE bool TsEnabled; ///< Config: Allow NeoMutt to set the terminal status line and icon
+WHERE bool UseDomain; ///< Config: Qualify local addresses using this domain
+WHERE bool WaitKey; ///< Config: Prompt to press a key after running external commands
+WHERE bool WrapSearch; ///< Config: Wrap around when the search hits the end
+WHERE bool WriteBcc; ///< Config: Write out the 'Bcc' field when preparing to send a mail
-WHERE bool CryptUsePka; ///< Config: Use GPGME to use PKA (lookup PGP keys using DNS)
+WHERE bool CryptUsePka; ///< Config: Use GPGME to use PKA (lookup PGP keys using DNS)
/* PGP options */
-WHERE bool CryptConfirmhook; ///< Config: Prompt the user to confirm keys before use
-WHERE bool CryptOpportunisticEncrypt; ///< Config: Enable encryption when the recipient's key is available
-WHERE bool SmimeIsDefault; ///< Config: Use SMIME rather than PGP by default
-WHERE bool PgpIgnoreSubkeys; ///< Config: Only use the principal PGP key
-WHERE bool PgpLongIds; ///< Config: Display long PGP key IDs to the user
-WHERE bool PgpShowUnusable; ///< Config: Show non-usable keys in the key selection
-WHERE bool PgpAutoinline; ///< Config: Use old-style inline PGP messages (not recommended)
+WHERE bool CryptConfirmhook; ///< Config: Prompt the user to confirm keys before use
+WHERE bool CryptOpportunisticEncrypt; ///< Config: Enable encryption when the recipient's key is available
+WHERE bool SmimeIsDefault; ///< Config: Use SMIME rather than PGP by default
+WHERE bool PgpIgnoreSubkeys; ///< Config: Only use the principal PGP key
+WHERE bool PgpLongIds; ///< Config: Display long PGP key IDs to the user
+WHERE bool PgpShowUnusable; ///< Config: Show non-usable keys in the key selection
+WHERE bool PgpAutoinline; ///< Config: Use old-style inline PGP messages (not recommended)
/* news options */
#ifdef USE_NNTP
-WHERE bool SaveUnsubscribed;
-WHERE bool XCommentTo;
+WHERE bool SaveUnsubscribed; ///< Config: (nntp) Save a list of unsubscribed newsgroups to the 'newsrc'
+WHERE bool XCommentTo; ///< Config: (nntp) Add 'X-Comment-To' header that contains article author
#endif
#ifdef USE_NOTMUCH
-WHERE bool VirtualSpoolfile;
+WHERE bool VirtualSpoolfile; ///< Config: (notmuch) Use the first virtual mailbox as a spool file
#endif
#endif /* _MUTT_GLOBALS_H */
#endif
/* These Config Variables are only used in handler.c */
-bool HonorDisposition;
-bool ImplicitAutoview;
-bool IncludeOnlyfirst;
-char *PreferredLanguages;
-bool ReflowText;
-char *ShowMultipartAlternative;
+bool HonorDisposition; ///< Config: Don't display MIME parts inline if they have a disposition of 'attachment'
+bool ImplicitAutoview; ///< Config: Display MIME attachments inline if a 'copiousoutput' mailcap entry exists
+bool IncludeOnlyfirst; ///< Config: Only include the first attachment when replying
+char *PreferredLanguages; ///< Config: Preferred languages for multilingual MIME
+bool ReflowText; ///< Config: Reformat paragraphs of 'format=flowed' text
+char *ShowMultipartAlternative; ///< Config: How to display 'multipart/alternative' MIME parts
#define BUFI_SIZE 1000
#define BUFO_SIZE 2000
#include "sort.h"
/* These Config Variables are only used in hdrline.c */
-struct MbTable *FlagChars; ///< Config: User-configurable index flags, e.g. tagged, new, etc
-struct MbTable *FromChars; ///< Config: User-configurable index flags, e.g. to address, cc address, etc
-struct MbTable *ToChars;
+struct MbTable *FlagChars; ///< Config: User-configurable index flags: tagged, new, etc
+struct MbTable *FromChars; ///< Config: User-configurable index flags: to address, cc address, etc
+struct MbTable *ToChars; ///< Config: Indicator characters for the 'To' field in the index
/**
* enum FlagChars - Index into the FlagChars variable ($flag_chars)
struct Context;
/* These Config Variables are only used in hook.c */
-char *DefaultHook;
-bool ForceName;
-bool SaveName;
+char *DefaultHook; ///< Config: Pattern to use for hooks that only have a simple regex
+bool ForceName; ///< Config: Save outgoing mail in a folder of their name
+bool SaveName; ///< Config: Save outgoing message to mailbox of recipient's name if it exists
/**
* struct Hook - A list of user hooks
#include "mx.h"
/* These Config Variables are only used in imap/command.c */
-bool ImapServernoise;
+bool ImapServernoise; ///< Config: (imap) Display server warnings as error messages
#define IMAP_CMD_BUFSIZE 512
#endif
/* These Config Variables are only used in imap/imap.c */
-bool ImapIdle;
+bool ImapIdle; ///< Config: (imap) Use the IMAP IDLE extension to check for new mail
/**
* check_capabilities - Make sure we can log in to this server
/* These Config Variables are only used in imap/util.c */
char *ImapDelimChars; ///< Config: (imap) Characters that denote separators in IMAP folders
-short ImapPipelineDepth;
+short ImapPipelineDepth; ///< Config: (imap) Number of IMAP commands that may be queued up
/**
* imap_expand_path - Canonicalise an IMAP path
{ "nm_query_window_current_position", DT_NUMBER, R_NONE, &NmQueryWindowCurrentPosition, 0 },
/*
** .pp
- ** This variable contains the currently setup notmuch search for window based vfolder.
+ ** This variable contains the position of the current search for window based vfolder.
*/
{ "nm_query_window_current_search", DT_STRING, R_NONE, &NmQueryWindowCurrentSearch, 0 },
/*
** .pp
- ** This variable sets the time duration of a windowed notmuch query.
- ** Accepted values all non negative integers. A value of 0 disables the feature.
+ ** This variable contains the currently setup notmuch search for window based vfolder.
*/
{ "nm_query_window_duration", DT_NUMBER|DT_NOT_NEGATIVE, R_NONE, &NmQueryWindowDuration, 0 },
/*
/* These Config Variables are only used in maildir/mh.c */
bool CheckNew; ///< Config: (maildir,mh) Check for new mail while the mailbox is open
-bool MaildirHeaderCacheVerify;
-bool MhPurge;
+bool MaildirHeaderCacheVerify; ///< Config: (hcache) Check for maildir changes when opening mailbox
+bool MhPurge; ///< Config: Really delete files in MH mailboxes
char *MhSeqFlagged; ///< Config: MH sequence for flagged message
char *MhSeqReplied; ///< Config: MH sequence to tag replied messages
char *MhSeqUnseen; ///< Config: MH sequence for unseen messages
#endif
/* These Config Variables are only used in main.c */
-bool ResumeEditedDraftFiles;
+bool ResumeEditedDraftFiles; ///< Config: Resume editing previously saved draft files
#define MUTT_IGNORE (1 << 0) /* -z */
#define MUTT_MAILBOX (1 << 1) /* -Z */
/* These Config Variables are only used in menu.c */
short MenuContext; ///< Config: Number of lines of overlap when changing pages in the index
-bool MenuMoveOff; /**< allow menu to scroll past last entry */ ///< Config: Allow the last menu item to move off the bottom of the screen
-bool MenuScroll; /**< scroll menu instead of implicit next-page */ ///< Config: Scroll the menu/index by one line, rather than a page
+bool MenuMoveOff; ///< Config: Allow the last menu item to move off the bottom of the screen
+bool MenuScroll; ///< Config: Scroll the menu/index by one line, rather than a page
char *SearchBuffers[MENU_MAX];
#include "message.h"
#include "string2.h"
-char *Tmpdir; /**< Temporary directory path */ ///< Config: Directory for temporary files
+char *Tmpdir; ///< Config: Directory for temporary files
/* these characters must be escaped in regular expressions */
static const char rx_special_chars[] = "^.[$()|*+?{\\";
struct timeval LastError = { 0 };
-short DebugLevel = 0; /**< Log file logging level */
-char *DebugFile = NULL; /**< Log file name */
+short DebugLevel = 0; ///< Config: Logging level for debug logs
+char *DebugFile = NULL; ///< Config: File to save debug logs
char *CurrentFile = NULL; /**< The previous log file name */
const int NumOfLogs = 5; /**< How many log files to rotate */
#include "sort.h"
/* These Config Variables are only used in mutt_thread.c */
-bool DuplicateThreads;
+bool DuplicateThreads; ///< Config: Highlight messages with duplicated message IDs
bool HideLimited; ///< Config: Don't indicate hidden messages, in the thread tree
bool HideMissing; ///< Config: Don't indicate missing messages, in the thread tree
bool HideThreadSubject; ///< Config: Hide subjects that are similar to that of the parent message
bool HideTopMissing; ///< Config: Don't indicate missing top message, in the thread tree
bool NarrowTree; ///< Config: Draw a narrower thread tree in the index
bool SortRe; ///< Config: Sort method for the sidebar
-bool StrictThreads;
-bool ThreadReceived;
+bool StrictThreads; ///< Config: Thread messages using 'In-Reply-To' and 'References' headers
+bool ThreadReceived; ///< Config: Sort threaded messages by their received date
/**
* is_visible - Is the message visible?
#endif
/* These Config Variables are only used in mx.c */
-unsigned char CatchupNewsgroup;
+unsigned char CatchupNewsgroup; ///< Config: (nntp) Mark all articles as read when leaving a newsgroup
bool KeepFlagged; ///< Config: Don't move flagged messages from Spoolfile to Mbox
unsigned char Move; ///< Config: Move emails from Spoolfile to Mbox when read
char *Trash; ///< Config: Folder to put deleted emails
/* These Config Variables are only used in ncrypt/crypt.c */
bool CryptTimestamp; ///< Config: Add a timestamp to PGP or SMIME output to prevent spoofing
unsigned char PgpEncryptSelf;
-unsigned char PgpMimeAuto; /* ask to revert to PGP/MIME when inline fails */ ///< Config: Prompt the user to use MIME if inline PGP fails
+unsigned char PgpMimeAuto; ///< Config: Prompt the user to use MIME if inline PGP fails
bool PgpRetainableSigs; ///< Config: Create nested multipart/signed or encrypted messages
bool PgpSelfEncrypt; ///< Config: Encrypted messages will also be encrypted to PgpDefaultKey too
bool PgpStrictEnc; ///< Config: Encode PGP signed messages with quoted-printable (don't unset)
/* These Config Variables are only used in nntp/nntp.c */
char *NntpAuthenticators; ///< Config: (nntp) Allowed authentication methods
short NntpContext; ///< Config: (nntp) Maximum number of articles to list (0 for all articles)
-bool NntpListgroup;
-bool NntpLoadDescription;
-short NntpPoll;
-bool ShowNewNews;
+bool NntpListgroup; ///< Config: (nntp) Check all articles when opening a newsgroup
+bool NntpLoadDescription; ///< Config: (nntp) Load descriptions for newsgroups when adding to the list
+short NntpPoll; ///< Config: (nntp) Interval between checks for new posts
+bool ShowNewNews; ///< Config: (nntp) Check for new newsgroups when entering the browser
struct NntpServer *CurrentNewsSrv;
int NmDbLimit; ///< Config: (notmuch) Default limit for Notmuch queries
char *NmDefaultUri; ///< Config: (notmuch) Path to the Notmuch database
char *NmExcludeTags; ///< Config: (notmuch) Exclude messages with these tags
-int NmOpenTimeout;
-char *NmQueryType;
-int NmQueryWindowCurrentPosition;
-char *NmQueryWindowTimebase;
-char *NmRecordTags;
-char *NmUnreadTag;
+int NmOpenTimeout; ///< Config: (notmuch) Database timeout
+char *NmQueryType; ///< Config: (notmuch) Default query type: 'threads' or 'messages'
+int NmQueryWindowCurrentPosition; ///< Config: (notmuch) Position of current search window
+char *NmQueryWindowTimebase; ///< Config: (notmuch) Units for the time duration
+char *NmRecordTags; ///< Config: (notmuch) Tags to apply to the 'record' mailbox (sent mail)
+char *NmUnreadTag; ///< Config: (notmuch) Tag to use for unread messages
#ifdef LIBNOTMUCH_CHECK_VERSION
#undef LIBNOTMUCH_CHECK_VERSION
/* These Config Variables are only used in pager.c */
bool AllowAnsi; ///< Config: Allow ANSI colour codes in rich text messages
-bool HeaderColorPartial;
+bool HeaderColorPartial; ///< Config: Only colour the part of the header matching the regex
short PagerContext; ///< Config: Number of lines of overlap when changing pages in the pager
-short PagerIndexLines;
+short PagerIndexLines; ///< Config: Number of index lines to display above the pager
bool PagerStop; ///< Config: Don't automatically open the next message when at the end of a message
-short SearchContext;
-short SkipQuotedOffset;
-bool SmartWrap;
-struct Regex *Smileys;
-bool Tilde;
+short SearchContext; ///< Config: Context to display around search matches
+short SkipQuotedOffset; ///< Config: Lines of context to show when skipping quoted text
+bool SmartWrap; ///< Config: Wrap text at word boundaries
+struct Regex *Smileys; ///< Config: Regex to match smileys to prevent mistakes when quoting text
+bool Tilde; ///< Config: Character to pad blank lines in the pager
#define ISHEADER(x) ((x) == MT_COLOR_HEADER || (x) == MT_COLOR_HDEFAULT)
#endif
/* These Config Variables are only used in pattern.c */
-bool ThoroughSearch;
+bool ThoroughSearch; ///< Config: Decode headers and messages before searching them
// clang-format off
/* The regexes in a modern format */
struct BodyCache;
/* These Config Variables are only used in pop/pop.c */
-short PopCheckinterval;
+short PopCheckinterval; ///< Config: (pop) Interval between checks for new mail
unsigned char PopDelete; ///< Config: (pop) After downloading POP messages, delete them on the server
char *PopHost; ///< Config: (pop) Url of the POP server
-bool PopLast;
+bool PopLast; ///< Config: (pop) Use the 'LAST' command to fetch new mail
#ifdef USE_HCACHE
#define HC_FNAME "neomutt" /* filename for hcache as POP lacks paths */
#endif
/* These Config Variables are only used in pop/pop_auth.c */
-char *PopAuthenticators;
-bool PopAuthTryAll;
+char *PopAuthenticators; ///< Config: (pop) List of allowed authentication methods
+bool PopAuthTryAll; ///< Config: (pop) Try all available authentication methods
#ifdef USE_SASL
/**
#include "progress.h"
/* These Config Variables are only used in pop/pop_lib.c */
-unsigned char PopReconnect;
+unsigned char PopReconnect; ///< Config: (pop) Reconnect to the server is the connection is lost
/**
* pop_parse_path - Parse a POP mailbox name
#include "options.h"
/* These Config Variables are only used in progress.c */
-short TimeInc;
+short TimeInc; ///< Config: Frequency of progress bar updates (milliseconds)
/**
* message_bar - Draw a colourful progress bar
#endif
/* These Config Variables are only used in recvattach.c */
-char *AttachSep;
-bool AttachSplit;
-bool DigestCollapse;
+char *AttachSep; ///< Config: Separator to add between saved/printed/piped attachments
+bool AttachSplit; ///< Config: Save/print/pipe tagged messages individually
+bool DigestCollapse; ///< Config: Hide the subparts of a multipart/digest
char *MessageFormat; ///< Config: printf-like format string for listing attached messages
static void mutt_update_recvattach_menu(struct AttachCtx *actx, struct Menu *menu, bool init);
#endif
/* These Config Variables are only used in recvcmd.c */
-unsigned char MimeForwardRest;
+unsigned char MimeForwardRest; ///< Config: Forward all attachments, even if they can't be decoded
/**
* check_msg - Are we working with an RFC822 message
#include "state.h"
/* These Config Variables are only used in rfc3676.c */
-bool ReflowSpaceQuotes;
-short ReflowWrap;
+bool ReflowSpaceQuotes; ///< Config: Insert spaces into reply quotes for 'format=flowed' messages
+short ReflowWrap; ///< Config: Maximum paragraph width for reformatting 'format=flowed' text
#define FLOWED_MAX 72
#endif
/* These Config Variables are only used in send.c */
-unsigned char AbortNoattach; /* forgotten attachment detector */ ///< Config: Abort sending the email if attachments are missing
+unsigned char AbortNoattach; ///< Config: Abort sending the email if attachments are missing
struct Regex *AbortNoattachRegex; ///< Config: Regex to match text indicating attachments are expected
unsigned char AbortNosubject; ///< Config: Abort creating the email if subject is missing
-unsigned char AbortUnmodified;
+unsigned char AbortUnmodified; ///< Config: Abort the sending if the message hasn't been edited
bool AskFollowUp; ///< Config: (nntp) Ask the user for follow-up groups before editing
bool AskXCommentTo; ///< Config: (nntp) Ask the user for the 'X-Comment-To' field before editing
char *ContentType; ///< Config: Default "Content-Type" for newly composed messages
bool FastReply; ///< Config: Don't prompt for the recipients and subject when replying/forwarding
unsigned char FccAttach; ///< Config: Save send message with all their attachments
bool FccClear; ///< Config: Save sent messages unencrypted and unsigned
-bool FollowupTo;
-char *ForwardAttributionIntro;
-char *ForwardAttributionTrailer;
+bool FollowupTo; ///< Config: Add the 'Mail-Followup-To' header is generated when sending mail
+char *ForwardAttributionIntro; ///< Config: Prefix message for forwarded messages
+char *ForwardAttributionTrailer; ///< Config: Suffix message for forwarded messages
unsigned char ForwardEdit; ///< Config: Automatically start the editor when forwarding a message
char *ForwardFormat; ///< Config: printf-like format string to control the subject when forwarding a message
bool ForwardReferences; ///< Config: Set the 'In-Reply-To' and 'References' headers when forwarding a message
-bool Hdrs;
-unsigned char HonorFollowupTo;
-bool IgnoreListReplyTo;
+bool Hdrs; ///< Config: Add custom headers to outgoing mail
+unsigned char HonorFollowupTo; ///< Config: Honour the 'Mail-Followup-To' header when group replying
+bool IgnoreListReplyTo; ///< Config: Ignore the 'Reply-To' header when using `<reply>` on a mailing list
unsigned char Include; ///< Config: Include a copy of the email that's being replied to
-bool Metoo;
-bool NmRecord;
+bool Metoo; ///< Config: Remove the user's address from the list of recipients
+bool NmRecord; ///< Config: (notmuch) If the 'record' mailbox (sent mail) should be indexed
bool PgpReplyinline; ///< Config: Reply using old-style inline PGP messages (not recommended)
-char *PostIndentString;
+char *PostIndentString; ///< Config: Suffix message to add after reply text
bool PostponeEncrypt; ///< Config: Self-encrypt postponed messages
char *PostponeEncryptAs; ///< Config: Fallback encryption key for postponed messages
unsigned char Recall; ///< Config: Recall postponed mesaages when asked to compose a message
-bool ReplySelf;
-unsigned char ReplyTo;
-bool ReplyWithXorig;
-bool ReverseName;
-bool ReverseRealname;
-bool SigDashes;
+bool ReplySelf; ///< Config: Really reply to yourself, when replying to your own email
+unsigned char ReplyTo; ///< Config: Address to use as a 'Reply-To' header
+bool ReplyWithXorig; ///< Config: Create 'From' header from 'X-Original-To' header
+bool ReverseName; ///< Config: Set the 'From' from the address the email was sent to
+bool ReverseRealname; ///< Config: Set the 'From' from the full 'To' address the email was sent to
+bool SigDashes; ///< Config: Insert '-- ' before the signature
char *Signature; ///< Config: File containing a signature to append to all mail
-bool SigOnTop;
-bool UseFrom;
+bool SigOnTop; ///< Config: Insert the signature before the quoted text
+bool UseFrom; ///< Config: Set the 'From' header for outgoing mail
/**
* append_signature - Append a signature to an email
#endif
/* These Config Variables are only used in sendlib.c */
-bool Allow8bit;
+bool Allow8bit; ///< Config: Allow 8-bit messages, don't use quoted-printable or base64
char *AttachCharset; ///< Config: When attaching files, use one of these character sets
-bool BounceDelivered;
-bool EncodeFrom;
+bool BounceDelivered; ///< Config: Add 'Delivered-To' to bounced messages
+bool EncodeFrom; ///< Config: Encode 'From ' as 'quote-printable' at the beginning of lines
bool ForwardDecrypt; ///< Config: Decrypt the message when forwarding it
bool HiddenHost; ///< Config: Don't use the hostname, just the domain, when generating the message id
char *Inews; ///< Config: (nntp) External command to post news articles
-bool MimeForwardDecode;
-bool MimeSubject; ///< encode subject line with RFC2047
+bool MimeForwardDecode; ///< Config: Decode the forwarded message before attaching it
+bool MimeSubject; ///< Config: (nntp) Encode the article subject in base64
char *MimeTypeQueryCommand; ///< Config: External command to determine the MIME type of an attachment
-bool MimeTypeQueryFirst;
+bool MimeTypeQueryFirst; ///< Config: Run the MimeTypeQueryCommand before the mime.types lookup
char *Sendmail; ///< Config: External command to send email
-short SendmailWait;
-bool Use8bitmime;
-bool UseEnvelopeFrom;
+short SendmailWait; ///< Config: Time to wait for sendmail to finish
+bool Use8bitmime; ///< Config: Use 8-bit messages and ESMTP to send messages
+bool UseEnvelopeFrom; ///< Config: Set the envelope sender of the message
bool UserAgent; ///< Config: Add a 'User-Agent' head to outgoing mail
-short WrapHeaders;
+short WrapHeaders; ///< Config: Width to wrap headers in outgoing messages
/**
* encode_quoted - Encode text as quoted printable
#endif
/* These Config Variables are only used in sidebar.c */
-short SidebarComponentDepth;
+short SidebarComponentDepth; ///< Config: (sidebar) Strip leading path components from sidebar folders
char *SidebarDelimChars; ///< Config: (sidebar) Characters that separate nested folders
char *SidebarDividerChar; ///< Config: (sidebar) Character to draw between the sidebar and index
bool SidebarFolderIndent; ///< Config: (sidebar) Indent nested folders
char *SidebarFormat; ///< Config: (sidebar) printf-like format string for the sidebar panel
char *SidebarIndentString; ///< Config: (sidebar) Indent nested folders using this string
bool SidebarNewMailOnly; ///< Config: (sidebar) Only show folders with new/flagged mail
-bool SidebarNextNewWrap;
+bool SidebarNextNewWrap; ///< Config: (sidebar) Wrap around when searching for the next mailbox with new mail
bool SidebarShortPath; ///< Config: (sidebar) Abbreviate the paths using the Folder variable
short SidebarSortMethod; ///< Config: (sidebar) Method to sort the sidebar
#endif
/* These Config Variables are only used in smtp.c */
-char *SmtpAuthenticators;
+char *SmtpAuthenticators; ///< Config: (smtp) List of allowed authentication methods
#define smtp_success(x) ((x) / 100 == 2)
#define SMTP_READY 334
#endif
/* These Config Variables are only used in sort.c */
-bool ReverseAlias;
+bool ReverseAlias; ///< Config: Display the alias in the index, rather than the message's sender
/* function to use as discriminator when normal sort method is equal */
static sort_t *AuxSort = NULL;
const char *mutt_get_name(struct Address *a);
/* These variables are backing for config items */
-WHERE short Sort; ///< Config: Sort method for the index
-WHERE short SortAux; /* auxiliary sorting method */ ///< Config: Secondary sort method for the index
+WHERE short Sort; ///< Config: Sort method for the index
+WHERE short SortAux; ///< Config: Secondary sort method for the index
/* FIXME: This one does not belong to here */
WHERE short PgpSortKeys; ///< Config: Sort order for PGP keys
#endif
/* These Config Variables are only used in status.c */
-struct MbTable *StatusChars;
+struct MbTable *StatusChars; ///< Config: Indicator characters for the status bar
/**
* get_sort_str - Get the sort method as a string
projects / neomutt / commitdiff