From 22cf3207d340400e7e34e2a1ebeb2aca384e9bc5 Mon Sep 17 00:00:00 2001 From: Richard Russon Date: Wed, 2 Oct 2019 01:50:36 +0100 Subject: [PATCH] docs: update list of colours Update the list of objects that can be coloured and give examples for each category. --- doc/manual.xml.head | 553 +++++++++++++++++++++++++------------------- 1 file changed, 315 insertions(+), 238 deletions(-) diff --git a/doc/manual.xml.head b/doc/manual.xml.head index 03b11df8a..3ebd68c13 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -4732,249 +4732,326 @@ folder-hook work "set sort=threads" regex. - object can be one of: + These simple colours below don't use a pattern. + If a name is configured more than once, the last one will be used. - - - - attachment - - - - - bold (highlighting bold patterns in the body of messages) - - - - - error (error messages printed by NeoMutt) - - - - - hdrdefault (default color of the message header in the pager) - - - - - index_author (color of the author name in the index, uses - pattern) - - - - - index_collapsed (the number of messages in a collapsed thread in - the index) - - - - - index_date (color of the date field in the index) - - - - - index_flags (color of the message flags in the index) - - - - - index_label (color of the message label in the index) - - - - - index_number (color of the message number in the index) - - - - - index_size (color of the message size and line number in the index) - - - - - index_subject (color of the subject in the index, uses - pattern) - - - - - indicator (arrow or bar used to indicate the current item in - a menu) - - - - - markers (the + markers at the beginning of wrapped - lines in the pager) - - - - - message (informational messages) - - - - - normal - - - - - options (the key letters in multi-choice questions) - - - - - progress (visual progress bar) - - - - - prompt - - - - - quoted (text matching - $quote_regex in the body of - a message) - - - - - quoted1, quoted2, ..., quoted N (higher levels - of quoting) - - - - - search (highlighting of words in the pager) - - - - - signature - - - - - status (mode lines used to display info about the mailbox or - message) - - - - - tilde (the ~ used to pad blank lines in the pager) - - - - - tree (thread tree drawn in the message index and attachment menu) - - - - - underline (highlighting underlined patterns in the body of - messages) - - - + +# Make error messages white text on a red background +color error white red +# Make questions bold, underlined, with light blue text (with default background) +color prompt bold underline cyan default + + + Simple Colours + + + + Colour Name + Description + + + + + attachment + Colour for attachment headers + + + bold + Highlighting bold patterns in the body of messages + + + error + Error messages printed by NeoMutt + + + hdrdefault + Default colour of the message header in the pager + + + indicator + Arrow or bar used to indicate the current item in a menu + + + markers + The "+" markers at the beginning of wrapped lines in the pager + + + message + Informational messages + + + normal + Default colour for all text + + + options + The key letters in multi-choice questions + + + progress + Visual progress bar + + + prompt + A question + + + search + Highlighting of words in the pager + + + signature + Email's signature lines (.sig) + + + tilde + The "~" used to pad blank lines in the pager + + + tree + Thread tree drawn in the message index and attachment menu + + + underline + Highlighting underlined patterns in the body of messages + + + +
- composeobject can be one of: + These simple index colours below don't use a pattern. + If a name is configured more than once, the last one will be used. + Each name will colour a certain expando in the index. + See $index_format for more details. - - - - header - - - - - security_encrypt - - - - - security_sign - - - - - security_both - - - - - security_none - - - + +color index_date green default + + + Simple Index Colours + + + + Colour Name + Description + + + + + index_collapsed + Number of messages in a collapsed thread, %M + + + index_date + Date field, %d %D %{fmt} %[fmt] %(fmt) + + + index_label + Message label, %y %Y + + + index_number + Message number, %C + + + index_size + Message size, %c %l + + + index_tags + Transformed message tags, %g %J + + + +
- index-object can be one of the following: + These simple sidebar colours below don't use a pattern. + If a name is configured more than once, the last one will be used. + See Sidebar Intro for more details. - - - - index (default highlighting of the entire index line, uses - pattern) - - - - - index_date (the date field) - - - - - index_flags (the message flags, %S %Z, uses - pattern) - - - - - index_number (the message number, %C) - - - - - index_collapsed (the number of messages in a collapsed thread, %M) - - - - - index_author (the author name, %A %a %F %L %n, uses - pattern) - - - - - index_subject (the subject, %s, uses pattern) - - - - - index_size (the message size, %c %l) - - - - - index_label (the message label, %y %Y) - - - - - index_tags (the transformed message tags, %g) - - - - - index_tag (an individual message tag, %G, uses pattern - / tag name) - - - + +color sidebar_divider brightblack default + + + Simple Sidebar Colours + + + + Colour Name + Description + + + + + sidebar_divider + The dividing line between the Sidebar and the Index/Pager panels + + + sidebar_flagged + Mailboxes containing flagged mail + + + sidebar_highlight + Cursor to select a mailbox + + + sidebar_indicator + The mailbox open in the Index panel + + + sidebar_new + Mailboxes containing new mail + + + sidebar_ordinary + Mailboxes that have no new/flagged mails, etc + + + sidebar_spoolfile + Mailbox that receives incoming mail + + + +
+ + These simple compose colours below don't use a pattern. + If a name is configured more than once, the last one will be used. + + +color header bold white default + + + Simple Compose Colours + + + + Colour Name + Description + + + + + header + Header labels, e.g. From: + + + security_encrypt + Mail will be encrypted + + + security_sign + Mail will be signed + + + security_both + Mail will be encrypted and signed + + + security_none + Mail will not be encrypted or signed + + + +
+ + These colours use a regex to match. When applying the colours, each + regex will be tested against the field to be coloured. All of the + matching patterns will have their colours applied in the order they are + configured. + + +color body bold red default "(urgent|important)" + + + Colour Regex Lists + + + + Colour Name + Description + + + + + attach_headers + Attachment headers + + + body + Email body + + + header + Email headers + + + index + Default highlighting of the entire index line + + + index_author + Author in the index, %A %a %F %L %n + + + index_flags + Flags in the index, %S %Z + + + index_subject + Subject in the index, %s + + + index_tag + Tags in the index, %G + + + status + Status bar + + + +
+ + The quoted email colours don't use pattern. + The first colour, quoted provides a default colour for + all quoted text. Also, each diffent level of quoting can be given a + different colour using, quoted1, + quoted2, quoted3 etc. + + +color quoted brightblue default +color quoted1 brightgreen default +color quoted2 yellow default + + + Quoted Email Colours + + + + Colour Name + Description + + + + + quoted + Text matching $quote_regex in the body of a message + + + quoted1 + 1 level deeper quoted text, e.g. > > text + + + quoted2 + 2 level deeper quoted text, e.g. > > > text + + + quotedN + n level deeper quoted text + + + +
attribute can be one of the following: -- 2.40.0