/* These Config Variables are only used in addrbook.c */
char *AliasFormat; ///< Config: printf-like format string for the alias menu
-short SortAlias;
+short SortAlias; ///< Config: Sort method for the alias menu
#define RSORT(x) ((SortAlias & SORT_REVERSE) ? -x : x)
#include "muttlib.h"
/* These Config Variables are only used in bcache.c */
-char *MessageCachedir;
+char *MessageCachedir; ///< Config: (imap/pop) Directory for the message cache
/**
* struct BodyCache - Local cache of email bodies
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;
-short SortBrowser;
+short SortBrowser; ///< Config: Sort method for the browser
char *VfolderFormat; ///< Config: (notmuch) printf-like format string for the browser's display of virtual folders
static const struct Mapping FolderHelp[] = {
/* These Config Variables are only used in buffy.c */
short MailCheck; ///< Config: Number of seconds before NeoMutt checks for new mail
-bool MailCheckStats;
-short MailCheckStatsInterval;
-bool MaildirCheckCur;
+bool MailCheckStats; ///< Config: Periodically check for new mail
+short MailCheckStatsInterval; ///< Config: How often to check for new mail
+bool MaildirCheckCur; ///< Config: Check both 'new' and 'cur' directories for new mail
static time_t BuffyTime = 0; /**< last time we started checking for mail */
static time_t BuffyStatsTime = 0; /**< last time we check performed mail_check_stats */
/* These Config Variables are only used in commands.c */
unsigned char CryptVerifySig; /* verify PGP 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
-bool PipeSplit; ///< Config: Run the pipe command on each message separately
-bool PrintDecode;
-bool PrintSplit;
-bool PromptAfter;
+bool PipeDecode; ///< Config: Decode the message when piping it
+char *PipeSep; ///< Config: Separator to add between multiple piped messages
+bool PipeSplit; ///< Config: Run the pipe command on each message separately
+bool PrintDecode; ///< Config: Decode message before printing it
+bool PrintSplit; ///< Config: Print multiple messages separately
+bool PromptAfter; ///< Config: Pause after running an external pager
static const char *ExtPagerProgress = "all";
/* These Config Variables are only used in compose.c */
char *ComposeFormat; ///< Config: printf-like format string for the Compose panel's status bar
-char *Ispell; ///< Config: External command to perform spell-checking
-unsigned char Postpone;
+char *Ispell; ///< Config: External command to perform spell-checking
+unsigned char Postpone; ///< Config: Save messages to the Postponed folder
static const char *There_are_no_attachments = N_("There are no attachments.");
#ifdef USE_SSL
const char *CertificateFile = NULL; ///< Config: File containing trusted certificates
const char *EntropyFile = NULL; ///< Config: (ssl) File/device containing random data to initialise SSL
-const char *SslCiphers = NULL; ///< Config: Ciphers to use when using SSL
+const char *SslCiphers = NULL; ///< Config: Ciphers to use when using SSL
const char *SslClientCert = NULL; ///< Config: File containing client certificates
#ifdef USE_SSL_GNUTLS
const char *SslCaCertificatesFile = NULL; ///< Config: File containing trusted CA certificates
#endif
#ifdef USE_SOCKET
-const char *Preconnect = NULL; ///< Config: Shell command to run before making a connection
+const char *Preconnect = NULL; ///< Config: (socket) External command to run prior to opening a socket
const char *Tunnel = NULL; ///< Config: Shell command to establish a tunnel
#endif
bool CollapseUnread; ///< Config: Prevent the collapse of threads with unread emails
char *MarkMacroPrefix;
bool PgpAutoDecode;
-bool UncollapseJump;
-bool UncollapseNew;
+bool UncollapseJump; ///< Config: When opening a thread, jump to the next unread message
+bool UncollapseNew; ///< Config: Open collapsed threads when new mail arrives
static const char *No_mailbox_is_open = N_("No mailbox is open.");
static const char *There_are_no_messages = N_("There are no messages.");
#include "mutt/mutt.h"
/* Config items */
-bool MarkOld = false; ///< Config: If set, mark mail old when leaving mailbox
-struct Regex *ReplyRegex = NULL; ///< Config: Regex to match reply marker "Re:"
-char *SendCharset = NULL; ///< Config: Character sets for outgoing mail
+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
-bool Weed = false; ///< Config: If set, filter the displayed email headers
+bool Weed = false; ///< Config: Filter headers when displaying/forwarding/printing/replying
/* Global variables */
struct RegexList *NoSpamList = NULL;
#include "tags.h"
/* These Config Variables are only used in email/tags.c */
-char *HiddenTags;
+char *HiddenTags; ///< Config: Tags that shouldn't be displayed on screen
struct Hash *TagTransforms; /**< Lookup table of alternative tag names */
/* All the variables below are backing for config items */
WHERE struct Address *EnvelopeFromAddress;
-WHERE struct Address *From;
+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;
-WHERE char *AttributionLocale;
+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 *ImapUser; ///< Config: (imap) Username for the IMAP server
#endif
WHERE char *Mbox; ///< Config: Folder that receives read emails (see Move)
-WHERE char *MailcapPath;
+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;
+WHERE char *HeaderCache; ///< Config: (hcache) Directory/file for the header cache database
#if defined(HAVE_GDBM) || defined(HAVE_BDB)
-WHERE char *HeaderCachePagesize;
+WHERE char *HeaderCachePagesize; ///< Config: (hcache) Database page size (gdbm,bdb4)
#endif /* HAVE_GDBM || HAVE_BDB */
#endif /* USE_HCACHE */
#ifdef USE_NNTP
WHERE char *NewsServer; ///< Config: (nntp) Url of the news server
#endif
-WHERE char *Record;
-WHERE char *Pager;
+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;
+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;
-WHERE char *Shell;
-WHERE char *SimpleSearch;
+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;
+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 *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;
+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)
#ifdef USE_SIDEBAR
-WHERE short SidebarWidth;
+WHERE short SidebarWidth; ///< Config: (sidebar) Width of the sidebar
#endif
#ifdef USE_IMAP
WHERE short ImapKeepalive;
#endif
/* These variables are backing for config items */
-WHERE struct Regex *Mask;
-WHERE struct Regex *QuoteRegex;
+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;
+WHERE unsigned char Delete; ///< Config: Really delete messages, when the mailbox is closed
WHERE unsigned char MimeForward;
-WHERE unsigned char Print;
+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 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;
+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;
-WHERE bool ForwardQuote;
+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;
+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)
#endif /* USE_SSL_OPENSSL */
#endif /* defined(USE_SSL) */
WHERE bool MailCheckRecent;
-WHERE bool MaildirTrash;
-WHERE bool Markers;
+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;
+WHERE bool MessageCacheClean; ///< Config: (imap/pop) Clean out obsolete entries from the message cache
#endif
-WHERE bool ReadOnly;
+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;
+WHERE bool Score; ///< Config: Use message scoring
#ifdef USE_SIDEBAR
-WHERE bool SidebarVisible;
-WHERE bool SidebarOnRight;
+WHERE bool SidebarVisible; ///< Config: (sidebar) Show the sidebar
+WHERE bool SidebarOnRight; ///< Config: (sidebar) Display the sidebar on the right
#endif
-WHERE bool StatusOnTop;
+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;
+WHERE bool WaitKey; ///< Config: Prompt to press a key after running external commands
WHERE bool WrapSearch;
WHERE bool WriteBcc; /**< write out a bcc header? */
#include "hcache/hcversion.h"
/* These Config Variables are only used in hcache/hcache.c */
-char *HeaderCacheBackend;
+char *HeaderCacheBackend; ///< Config: (hcache) Header cache backend to use
static unsigned int hcachever = 0x0;
bool CheckNew; ///< Config: (maildir,mh) Check for new mail while the mailbox is open
bool MaildirHeaderCacheVerify;
bool MhPurge;
-char *MhSeqFlagged;
-char *MhSeqReplied;
-char *MhSeqUnseen;
+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
#define INS_SORT_THRESHOLD 6
#endif
/* These Config Variables are only used in menu.c */
-short MenuContext;
-bool MenuMoveOff; /**< allow menu to scroll past last entry */
-bool MenuScroll; /**< scroll menu instead of implicit next-page */
+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
char *SearchBuffers[MENU_MAX];
#define EILSEQ EINVAL
#endif
-char *AssumedCharset; ///< Config: Encoding schemes for messages without indication
+char *AssumedCharset; ///< Config: If a message is missing a character set, assume this character set
char *Charset; ///< Config: Default character set for displaying text on screen
/**
#include "message.h"
#include "string2.h"
-char *Tmpdir; /**< Temporary directory path */
+char *Tmpdir; /**< Temporary directory path */ ///< Config: Directory for temporary files
/* these characters must be escaped in regular expressions */
static const char rx_special_chars[] = "^.[$()|*+?{\\";
char *NntpUser; ///< Config: (nntp) Username for the news server
char *PopPass; ///< Config: (pop) Password of the POP server
char *PopUser; ///< Config: (pop) Username of the POP server
-char *SmtpPass;
+char *SmtpPass; ///< Config: (smtp) Password for the SMTP server
/**
* mutt_account_match - Compare account info (host/port/user)
/* These Config Variables are only used in mutt_thread.c */
bool DuplicateThreads;
-bool HideLimited;
-bool HideMissing;
-bool HideThreadSubject;
-bool HideTopLimited;
-bool HideTopMissing;
+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 HideTopLimited; ///< Config: Don't indicate hidden top message, in the thread tree
+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;
+bool SortRe; ///< Config: Sort method for the sidebar
bool StrictThreads;
bool ThreadReceived;
unsigned char CatchupNewsgroup;
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;
+char *Trash; ///< Config: Folder to put deleted emails
/**
* mx_get_ops - Get mailbox operations
struct MxOps *mx_get_ops(int magic);
/* This variable is backing for a config item */
-WHERE short MboxType;
+WHERE short MboxType; ///< Config: Default type for creating new mailboxes
#endif /* _MUTT_MX_H */
bool SmimeAskCertLabel;
char *SmimeCaLocation;
char *SmimeCertificates;
-char *SmimeDecryptCommand; ///< Config: (smime) External command to decrypt an SMIME message
+char *SmimeDecryptCommand; ///< Config: (smime) External command to decrypt an SMIME message
bool SmimeDecryptUseDefaultKey;
-char *SmimeEncryptCommand; ///< Config: (smime) External command to encrypt a message
-char *SmimeGetCertCommand; ///< Config: (smime) External command to extract a certificate from a message
-char *SmimeGetCertEmailCommand; ///< Config: (smime) External command to get a certificate for an email
-char *SmimeGetSignerCertCommand; ///< Config: (smime) External command to extract a certificate from an email
-char *SmimeImportCertCommand; ///< Config: (smime) External command to import a certificate
+char *SmimeEncryptCommand; ///< Config: (smime) External command to encrypt a message
+char *SmimeGetCertCommand; ///< Config: (smime) External command to extract a certificate from a message
+char *SmimeGetCertEmailCommand; ///< Config: (smime) External command to get a certificate for an email
+char *SmimeGetSignerCertCommand; ///< Config: (smime) External command to extract a certificate from an email
+char *SmimeImportCertCommand; ///< Config: (smime) External command to import a certificate
char *SmimeKeys;
-char *SmimePk7outCommand; ///< Config: (smime) External command to extract a public certificate
-char *SmimeSignCommand; ///< Config: (smime) External command to sign a message
+char *SmimePk7outCommand; ///< Config: (smime) External command to extract a public certificate
+char *SmimeSignCommand; ///< Config: (smime) External command to sign a message
char *SmimeSignDigestAlg;
long SmimeTimeout;
-char *SmimeVerifyCommand; ///< Config: (smime) External command to verify a signed message
-char *SmimeVerifyOpaqueCommand; ///< Config: (smime) External command to verify a signature
+char *SmimeVerifyCommand; ///< Config: (smime) External command to verify a signed message
+char *SmimeVerifyOpaqueCommand; ///< Config: (smime) External command to verify a signature
/**
* struct SmimeCommandContext - Data for a SIME command
#endif
/* These Config Variables are only used in nntp/nntp.c */
-char *NntpAuthenticators;
+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;
#include "protos.h"
/* These Config Variables are only used in notmuch/mutt_notmuch.c */
-int NmDbLimit;
-char *NmDefaultUri;
-char *NmExcludeTags;
+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;
#endif
/* These Config Variables are only used in pager.c */
-bool AllowAnsi;
+bool AllowAnsi; ///< Config: Allow ANSI colour codes in rich text messages
bool HeaderColorPartial;
short PagerContext; ///< Config: Number of lines of overlap when changing pages in the pager
short PagerIndexLines;
-bool PagerStop;
+bool PagerStop; ///< Config: Don't automatically open the next message when at the end of a message
short SearchContext;
short SkipQuotedOffset;
bool SmartWrap;
/* These Config Variables are only used in remailer.c */
char *MixEntryFormat; ///< Config: (mixmaster) printf-like format string for the mixmaster chain
-char *Mixmaster;
+char *Mixmaster; ///< Config: (mixmaster) External command to route a mixmaster message
#define MIX_CAP_COMPRESS (1 << 0)
#define MIX_CAP_MIDDLEMAN (1 << 1)
#include "protos.h"
/* These Config Variables are only used in rfc1524.c */
-bool MailcapSanitize;
+bool MailcapSanitize; ///< Config: Restrict the possible characters in mailcap expandos
/**
* rfc1524_expand_command - Expand expandos in a command
#include "sort.h"
/* These Config Variables are only used in score.c */
-short ScoreThresholdDelete;
-short ScoreThresholdFlag;
-short ScoreThresholdRead;
+short ScoreThresholdDelete; ///< Config: Messages with a lower score will be automatically deleted
+short ScoreThresholdFlag; ///< Config: Messages with a greater score will be automatically flagged
+short ScoreThresholdRead; ///< Config: Messages with a lower score will be automatically marked read
/**
* struct Score - Scoring rule for email
#endif
/* These Config Variables are only used in send.c */
-unsigned char AbortNoattach; /* forgotten attachment detector */
-struct Regex *AbortNoattachRegex;
-unsigned char AbortNosubject;
+unsigned char AbortNoattach; /* forgotten attachment detector */ ///< 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;
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
bool FollowupTo;
char *ForwardAttributionIntro;
char *ForwardAttributionTrailer;
-unsigned char ForwardEdit;
+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;
+bool ForwardReferences; ///< Config: Set the 'In-Reply-To' and 'References' headers when forwarding a message
bool Hdrs;
unsigned char HonorFollowupTo;
bool IgnoreListReplyTo;
bool NmRecord;
bool PgpReplyinline;
char *PostIndentString;
-bool PostponeEncrypt;
-char *PostponeEncryptAs;
-unsigned char Recall;
+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;
-char *Signature;
+char *Signature; ///< Config: File containing a signature to append to all mail
bool SigOnTop;
bool UseFrom;
/* These Config Variables are only used in sendlib.c */
bool Allow8bit;
-char *AttachCharset;
+char *AttachCharset; ///< Config: When attaching files, use one of these character sets
bool BounceDelivered;
bool EncodeFrom;
-bool ForwardDecrypt;
-bool HiddenHost;
-char *Inews; ///< Config: (nntp) External command to post news articles
+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
char *MimeTypeQueryCommand; ///< Config: External command to determine the MIME type of an attachment
bool MimeTypeQueryFirst;
-char *Sendmail;
+char *Sendmail; ///< Config: External command to send email
short SendmailWait;
bool Use8bitmime;
bool UseEnvelopeFrom;
/* These Config Variables are only used in sidebar.c */
short SidebarComponentDepth;
-char *SidebarDelimChars;
-char *SidebarDividerChar;
-bool SidebarFolderIndent;
+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;
-bool SidebarNewMailOnly;
+char *SidebarIndentString; ///< Config: (sidebar) Indent nested folders using this string
+bool SidebarNewMailOnly; ///< Config: (sidebar) Only show folders with new/flagged mail
bool SidebarNextNewWrap;
-bool SidebarShortPath;
-short SidebarSortMethod;
+bool SidebarShortPath; ///< Config: (sidebar) Abbreviate the paths using the Folder variable
+short SidebarSortMethod; ///< Config: (sidebar) Method to sort the sidebar
/* Previous values for some sidebar config */
static short PreviousSort = SORT_ORDER; /* sidebar_sort_method */
const char *mutt_get_name(struct Address *a);
/* These variables are backing for config items */
-WHERE short Sort;
-WHERE short SortAux; /* auxiliary sorting method */
+WHERE short Sort; ///< Config: Sort method for the index
+WHERE short SortAux; /* auxiliary sorting method */ ///< Config: Secondary sort method for the index
/* FIXME: This one does not belong to here */
WHERE short PgpSortKeys;
projects / neomutt / commitdiff