From: Richard Russon Date: Wed, 3 Feb 2016 17:33:27 +0000 (+0000) Subject: add docs X-Git-Tag: neomutt-20160404~20^2~2 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=67fd3ea23ee6f47124b53c1c25a3ce179be911d7;p=neomutt add docs --- diff --git a/README.progress b/README.progress new file mode 100644 index 000000000..40a8a071f --- /dev/null +++ b/README.progress @@ -0,0 +1,47 @@ +Progress Bar Patch +================== + + Show a visual progress bar on slow operations + +Patch +----- + + To check if Mutt supports "Progress Bar", look for "patch-progress" in the + mutt version. + + Dependencies + * mutt-1.5.24 + +Introduction +------------ + + The "progress" patch shows a visual progress bar on slow tasks, such as + indexing a large folder over the net. + +Colors +------ + + Progress Colors + + | Name | Default Color | Description | + |------------|---------------|---------------------| + | 'progress' | default | Visual progress bar | + +See Also +-------- + + * NeoMutt project + * Color command + +Known Bugs +---------- + + None + +Credits +------- + + * Stefan Kuhn + * Karel Zak + * Richard Russon + diff --git a/doc/manual.xml.head b/doc/manual.xml.head index 3368eda9e..ce9ea4f54 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -2706,7 +2706,7 @@ patterns. markers (the + markers at the beginning of wrapped lines in the pager) message (informational messages) normal -progress (visual progress bar) +progress (visual progress bar) prompt quoted (text matching $quote_regexp in the body of a message) quoted1, quoted2, ..., quotedN (higher levels of quoting) @@ -8082,6 +8082,123 @@ please have a look at the mixmaster documentation. + + Progress Bar Patch + Show a visual progress bar on slow operations + + + Patch + + + To check if Mutt supports Progress Bar, look for + patch-progress in the mutt version. + See: . + + + + Dependencies: + mutt-1.5.24 + + + This patch is part of the NeoMutt Project. + + + + Introduction + + + The progress patch shows a visual progress bar on slow + tasks, such as indexing a large folder over the net. + + + + + + + Colors + + Progress Colors + + + + Name + Default Color + Description + + + + + progress + default + Visual progress bar + + + +
+
+ + + + + Muttrc + +# Example Mutt config file for the 'progress' patch. + +# The 'progress' patch provides clear visual feedback for +# slow tasks, such as indexing a large folder over the net. + +# Set the color of the progress bar +# White text on a red background +color progress white red + +# vim: syntax=muttrc + + + + + See Also + + + NeoMutt Project + Color command + + + + + Known Bugs + None + + + + Credits + + Stefan Kuhn wuodan@hispeed.ch + Karel Zak kzak@redhat.com + Richard Russon rich@flatcap.org + + +
+ diff --git a/doc/muttrc.progress b/doc/muttrc.progress new file mode 100644 index 000000000..7efe45c5f --- /dev/null +++ b/doc/muttrc.progress @@ -0,0 +1,10 @@ +# Example Mutt config file for the 'progress' patch. + +# The 'progress' patch provides clear visual feedback for +# slow tasks, such as indexing a large folder over the net. + +# Set the color of the progress bar +# White text on a red background +color progress white red + +# vim: syntax=muttrc diff --git a/doc/vimrc.progress b/doc/vimrc.progress new file mode 100644 index 000000000..a632dc020 --- /dev/null +++ b/doc/vimrc.progress @@ -0,0 +1,5 @@ +" Vim syntax file for the mutt progress patch + +syntax keyword muttrcColorField contained progress + +" vim: syntax=vim