Skip to content

Commit

Permalink
guide NeoMutt 20240425-125-4e6e41
Browse files Browse the repository at this point in the history
  • Loading branch information
flatcap committed Sep 26, 2024
1 parent fa81fba commit 8e2d94f
Show file tree
Hide file tree
Showing 27 changed files with 1,203 additions and 1,171 deletions.
10 changes: 5 additions & 5 deletions _feature/compress.html
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ <h3 class="title">
</div>
</div>
<p>NeoMutt assumes that an empty file is not compressed. In this situation, unset
<a class="link" href="/guide/reference.html#save-empty" title="3.405.&#160;save_empty">$save_empty</a>, so that the compressed file will be removed if you delete all of the messages.</p>
<a class="link" href="/guide/reference.html#save-empty" title="3.404.&#160;save_empty">$save_empty</a>, so that the compressed file will be removed if you delete all of the messages.</p>
</div>
<div class="sect2">
<div class="titlepage">
Expand All @@ -377,7 +377,7 @@ <h3 class="title">
</div>
</div>
<p>Encrypted files are decrypted into temporary files which are stored in the
<a class="link" href="/guide/reference.html#tmp-dir" title="3.513.&#160;tmp_dir">$tmp_dir</a> directory. This could be a security risk.</p>
<a class="link" href="/guide/reference.html#tmp-dir" title="3.512.&#160;tmp_dir">$tmp_dir</a> directory. This could be a security risk.</p>
</div>
</div>
<div class="sect1">
Expand Down Expand Up @@ -443,17 +443,17 @@ <h2 class="title" style="clear: both">
</li>
<li class="listitem">
<p>
<a class="link" href="/guide/reference.html#tmp-dir" title="3.513.&#160;tmp_dir">$tmp_dir</a>
<a class="link" href="/guide/reference.html#tmp-dir" title="3.512.&#160;tmp_dir">$tmp_dir</a>
</p>
</li>
<li class="listitem">
<p>
<a class="link" href="/guide/reference.html#mbox-type" title="3.232.&#160;mbox_type">$mbox_type</a>
<a class="link" href="/guide/reference.html#mbox-type" title="3.233.&#160;mbox_type">$mbox_type</a>
</p>
</li>
<li class="listitem">
<p>
<a class="link" href="/guide/reference.html#save-empty" title="3.405.&#160;save_empty">$save_empty</a>
<a class="link" href="/guide/reference.html#save-empty" title="3.404.&#160;save_empty">$save_empty</a>
</p>
</li>
<li class="listitem">
Expand Down
4 changes: 2 additions & 2 deletions _feature/cond-date.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ <h2 class="title" style="clear: both">
</div>
<p>The
<span class="quote"><span class="quote">Conditional Dates</span></span> feature allows you to construct
<a class="link" href="/guide/reference.html#index-format" title="3.211.&#160;index_format">$index_format</a> expressions based on the age of the email.</p>
<a class="link" href="/guide/reference.html#index-format" title="3.212.&#160;index_format">$index_format</a> expressions based on the age of the email.</p>
<p>NeoMutt's default
<code class="literal">$index_format</code> displays email dates in the form: abbreviated-month day-of-month –
<span class="quote"><span class="quote">Jan 14</span></span>.</p>
Expand Down Expand Up @@ -464,7 +464,7 @@ <h2 class="title" style="clear: both">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
<p>
<a class="link" href="/guide/reference.html#index-format" title="3.211.&#160;index_format">$index_format</a>
<a class="link" href="/guide/reference.html#index-format" title="3.212.&#160;index_format">$index_format</a>
</p>
</li>
<li class="listitem">
Expand Down
14 changes: 7 additions & 7 deletions _feature/encrypt-to-self.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,24 +47,24 @@ <h2 class="title" style="clear: both">
</div>
</div>
<p>Once you encrypt an email to someone you cannot read it. This is good for security, but bad for record-keeping. If you wanted to keep a copy of an encrypted email you could set
<a class="link" href="/guide/reference.html#fcc-clear" title="3.124.&#160;fcc_clear">$fcc_clear</a>.</p>
<a class="link" href="/guide/reference.html#fcc-clear" title="3.125.&#160;fcc_clear">$fcc_clear</a>.</p>
<p>A better option is to enable
<a class="link" href="/guide/reference.html#smime-self-encrypt" title="3.463.&#160;smime_self_encrypt">$smime_self_encrypt</a>, then set
<a class="link" href="/guide/reference.html#smime-default-key" title="3.452.&#160;smime_default_key">$smime_default_key</a> to your personal S/MIME key id.</p>
<a class="link" href="/guide/reference.html#smime-self-encrypt" title="3.462.&#160;smime_self_encrypt">$smime_self_encrypt</a>, then set
<a class="link" href="/guide/reference.html#smime-default-key" title="3.451.&#160;smime_default_key">$smime_default_key</a> to your personal S/MIME key id.</p>
<pre class="screen">
set smime_self_encrypt = yes
set smime_default_key = bb345e23.0
</pre>
<p>Or, if you use PGP,
<a class="link" href="/guide/reference.html#pgp-self-encrypt" title="3.334.&#160;pgp_self_encrypt">$pgp_self_encrypt</a>, then set
<a class="link" href="/guide/reference.html#pgp-default-key" title="3.313.&#160;pgp_default_key">$pgp_default_key</a> to your personal PGP key id.</p>
<a class="link" href="/guide/reference.html#pgp-self-encrypt" title="3.333.&#160;pgp_self_encrypt">$pgp_self_encrypt</a>, then set
<a class="link" href="/guide/reference.html#pgp-default-key" title="3.312.&#160;pgp_default_key">$pgp_default_key</a> to your personal PGP key id.</p>
<pre class="screen">
set pgp_self_encrypt = yes
set pgp_default_key = A4AF18C5582473BD35A1E9CE78BB3D480042198E
</pre>
<p>If you have different key for signing, then you can set
<a class="link" href="/guide/reference.html#pgp-sign-as" title="3.337.&#160;pgp_sign_as">$pgp_sign_as</a> or
<a class="link" href="/guide/reference.html#smime-sign-as" title="3.465.&#160;smime_sign_as">$smime_sign_as</a> respectively.</p>
<a class="link" href="/guide/reference.html#pgp-sign-as" title="3.336.&#160;pgp_sign_as">$pgp_sign_as</a> or
<a class="link" href="/guide/reference.html#smime-sign-as" title="3.464.&#160;smime_sign_as">$smime_sign_as</a> respectively.</p>
</div>
<div class="sect1">
<div class="titlepage">
Expand Down
2 changes: 1 addition & 1 deletion _feature/fmemopen.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ <h2 class="title" style="clear: both">
<p>The
<span class="quote"><span class="quote">fmemopen</span></span> feature speeds up some searches.</p>
<p>This feature changes a few places where NeoMutt creates temporary files. It replaces them with in-memory buffers. This should improve the performance when searching the header or body using the
<a class="link" href="/guide/reference.html#thorough-search" title="3.508.&#160;thorough_search">$thorough_search</a> option.</p>
<a class="link" href="/guide/reference.html#thorough-search" title="3.507.&#160;thorough_search">$thorough_search</a> option.</p>
<p>There are no user-configurable parts.</p>
<p>This feature depends on
<code class="literal">open_memstream()</code> and
Expand Down
2 changes: 1 addition & 1 deletion _feature/forgotten-attachment.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h2 class="title" style="clear: both">
</div>
<p>The
<span class="quote"><span class="quote">forgotten-attachment</span></span> feature provides a new setting for NeoMutt that alerts the user if the message body contains a certain keyword but there are no attachments added. This is meant to ensure that the user does not forget to attach a file after promising to do so in the mail. The attachment keyword will not be scanned in text matched by
<a class="link" href="/guide/reference.html#quote-regex" title="3.380.&#160;quote_regex">$quote_regex</a>.</p>
<a class="link" href="/guide/reference.html#quote-regex" title="3.379.&#160;quote_regex">$quote_regex</a>.</p>
</div>
<div class="sect1">
<div class="titlepage">
Expand Down
2 changes: 1 addition & 1 deletion _feature/global-hooks.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ <h2 class="title" style="clear: both">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
<p>
<a class="link" href="/guide/reference.html#timeout" title="3.512.&#160;timeout">$timeout</a>
<a class="link" href="/guide/reference.html#timeout" title="3.511.&#160;timeout">$timeout</a>
</p>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion _feature/index-color.html
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ <h2 class="title" style="clear: both">
</li>
<li class="listitem">
<p>
<a class="link" href="/guide/reference.html#index-format" title="3.211.&#160;index_format">$index_format</a>
<a class="link" href="/guide/reference.html#index-format" title="3.212.&#160;index_format">$index_format</a>
</p>
</li>
<li class="listitem">
Expand Down
6 changes: 3 additions & 3 deletions _feature/initials.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ <h2 class="title" style="clear: both">
<p>The
<span class="quote"><span class="quote">initials</span></span> feature adds an expando (%I) for an author's initials.</p>
<p>The index panel displays a list of emails. Its layout is controlled by the
<a class="link" href="/guide/reference.html#index-format" title="3.211.&#160;index_format">$index_format</a> variable. Using this expando saves space in the index panel. This can be useful if you are regularly working with a small set of people.</p>
<a class="link" href="/guide/reference.html#index-format" title="3.212.&#160;index_format">$index_format</a> variable. Using this expando saves space in the index panel. This can be useful if you are regularly working with a small set of people.</p>
</div>
<div class="sect1">
<div class="titlepage">
Expand All @@ -61,7 +61,7 @@ <h2 class="title" style="clear: both">
</div>
</div>
<p>This feature has no config of its own. It adds an expando which can be used in the
<a class="link" href="/guide/reference.html#index-format" title="3.211.&#160;index_format">$index_format</a> variable.</p>
<a class="link" href="/guide/reference.html#index-format" title="3.212.&#160;index_format">$index_format</a> variable.</p>
</div>
<div class="sect1">
<div class="titlepage">
Expand Down Expand Up @@ -112,7 +112,7 @@ <h2 class="title" style="clear: both">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
<p>
<a class="link" href="/guide/reference.html#index-format" title="3.211.&#160;index_format">$index_format</a>
<a class="link" href="/guide/reference.html#index-format" title="3.212.&#160;index_format">$index_format</a>
</p>
</li>
<li class="listitem">
Expand Down
2 changes: 1 addition & 1 deletion _feature/multiple-fcc.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ <h2 class="title" style="clear: both">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
<p>
<a class="link" href="/guide/reference.html#record" title="3.387.&#160;record">$record</a>
<a class="link" href="/guide/reference.html#record" title="3.386.&#160;record">$record</a>
</p>
</li>
<li class="listitem">
Expand Down
4 changes: 2 additions & 2 deletions _feature/nested-if.html
Original file line number Diff line number Diff line change
Expand Up @@ -184,12 +184,12 @@ <h2 class="title" style="clear: both">
</li>
<li class="listitem">
<p>
<a class="link" href="/guide/reference.html#index-format" title="3.211.&#160;index_format">$index_format</a>
<a class="link" href="/guide/reference.html#index-format" title="3.212.&#160;index_format">$index_format</a>
</p>
</li>
<li class="listitem">
<p>
<a class="link" href="/guide/reference.html#status-format" title="3.503.&#160;status_format">$status_format</a>
<a class="link" href="/guide/reference.html#status-format" title="3.502.&#160;status_format">$status_format</a>
</p>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion _feature/new-mail.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ <h2 class="title" style="clear: both">
<p>This feature enables the new_mail_command setting, which can be used to execute a custom script (e.g. a notification handler) upon receiving a new mail.</p>
<p>The command string can contain expandos, such as
<code class="literal">%n</code> for the number of new messages. For a complete list, see:
<a class="link" href="/guide/reference.html#status-format" title="3.503.&#160;status_format">$status_format</a>.</p>
<a class="link" href="/guide/reference.html#status-format" title="3.502.&#160;status_format">$status_format</a>.</p>
<div class="note">
<h3 class="title">Note</h3>
<p>When the notification is sent, the folder of the new mail is no longer known. This is a limitation of NeoMutt. The `%f` expando will show the open folder.</p>
Expand Down
8 changes: 4 additions & 4 deletions _feature/nntp.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,17 @@ <h2 class="title" style="clear: both">
<p>The default news server can be obtained from the
<code class="literal">$NNTPSERVER</code> environment variable or from the
<code class="literal">/etc/nntpserver</code> file. Like in other news readers, information about the subscribed newsgroups is saved in the file specified by the
<a class="link" href="/guide/reference.html#newsrc" title="3.264.&#160;newsrc">$newsrc</a> variable. You can open a newsgroup with the function
<a class="link" href="/guide/reference.html#newsrc" title="3.263.&#160;newsrc">$newsrc</a> variable. You can open a newsgroup with the function
<code class="literal">&lt;change-newsgroup&gt;</code></p>
<p>When browsing the list of newsgroups on the server the function
<code class="literal">&lt;subscribe&gt;</code> can be used to tell NeoMutt the groups of interest to you. This list is stored in the
<a class="link" href="/guide/reference.html#newsrc" title="3.264.&#160;newsrc">$newsrc</a> file, so NeoMutt remembers it across invocations (see also
<a class="link" href="/guide/reference.html#save-unsubscribed" title="3.408.&#160;save_unsubscribed">$save_unsubscribed</a>). With the
<a class="link" href="/guide/reference.html#newsrc" title="3.263.&#160;newsrc">$newsrc</a> file, so NeoMutt remembers it across invocations (see also
<a class="link" href="/guide/reference.html#save-unsubscribed" title="3.407.&#160;save_unsubscribed">$save_unsubscribed</a>). With the
<code class="literal">&lt;unsubscribe&gt;</code> function a group can be deleted from that list. You can also specify the list of interesting groups with the
<a class="link" href="/guide/configuration.html#mailboxes" title="16.&#160;Monitoring Incoming Mail">mailboxes</a> command in your config file.</p>
<p>When checking for new messages, NeoMutt only polls the subscribed newsgroups.</p>
<p>The variable
<a class="link" href="/guide/reference.html#news-cache-dir" title="3.261.&#160;news_cache_dir">$news_cache_dir</a> can be used to point to a directory. NeoMutt will create a hierarchy of subdirectories named like the account and newsgroup the cache is for. The hierarchy is also used to store header cache if NeoMutt was compiled with
<a class="link" href="/guide/reference.html#news-cache-dir" title="3.260.&#160;news_cache_dir">$news_cache_dir</a> can be used to point to a directory. NeoMutt will create a hierarchy of subdirectories named like the account and newsgroup the cache is for. The hierarchy is also used to store header cache if NeoMutt was compiled with
<a class="link" href="/guide/optionalfeatures.html#header-caching" title="8.1.&#160;Header Caching">header cache</a> support.</p>
</div>
<div class="sect1">
Expand Down
2 changes: 1 addition & 1 deletion _feature/notmuch.html
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ <h2 class="title" style="clear: both">
<code class="literal">no</code>
</td>
<td>Unnecessary since
<a class="link" href="/guide/reference.html#spool-file" title="3.483.&#160;spool_file">$spool_file</a> supports mailbox descriptions.</td>
<a class="link" href="/guide/reference.html#spool-file" title="3.482.&#160;spool_file">$spool_file</a> supports mailbox descriptions.</td>
</tr>
</tbody>
</table>
Expand Down
6 changes: 3 additions & 3 deletions _feature/pager-read-delay-feature.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ <h2 class="title" style="clear: both">
</div>
<p>The
<span class="quote"><span class="quote">Pager Read Delay</span></span> feature adds one new config variable,
<a class="link" href="/guide/reference.html#pager-read-delay" title="3.295.&#160;pager_read_delay">$pager_read_delay</a>, which is an integer for how many seconds the pager must remain on a given message before marking it as read. The variable defaults to 0 for the original behavior of marking a message as read the moment the pager visits it.</p>
<a class="link" href="/guide/reference.html#pager-read-delay" title="3.294.&#160;pager_read_delay">$pager_read_delay</a>, which is an integer for how many seconds the pager must remain on a given message before marking it as read. The variable defaults to 0 for the original behavior of marking a message as read the moment the pager visits it.</p>
</div>
<div class="sect1">
<div class="titlepage">
Expand Down Expand Up @@ -102,10 +102,10 @@ <h2 class="title" style="clear: both">
</div>
</div>
<p>When
<a class="link" href="/guide/reference.html#pager-index-lines" title="3.294.&#160;pager_index_lines">$pager_index_lines</a> is non-zero, the
<a class="link" href="/guide/reference.html#pager-index-lines" title="3.293.&#160;pager_index_lines">$pager_index_lines</a> is non-zero, the
<span class="quote"><span class="quote">N</span></span> status indicator from the
<span class="quote"><span class="quote">%Z</span></span> expando of
<a class="link" href="/guide/reference.html#index-format" title="3.211.&#160;index_format">$index_format</a> does not actively reflect the current new/read status of the message.</p>
<a class="link" href="/guide/reference.html#index-format" title="3.212.&#160;index_format">$index_format</a> does not actively reflect the current new/read status of the message.</p>
</div>
<div class="sect1">
<div class="titlepage">
Expand Down
2 changes: 1 addition & 1 deletion _feature/sensible-browser.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ <h2 class="title" style="clear: both">
<ul class="itemizedlist" style="list-style-type: disc;">
<li class="listitem">
<p>
<a class="link" href="/guide/reference.html#folder-format" title="3.128.&#160;folder_format">$folder_format</a>
<a class="link" href="/guide/reference.html#folder-format" title="3.129.&#160;folder_format">$folder_format</a>
</p>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion _feature/sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ <h2 class="title" style="clear: both">
</em>... }</p>
</div>
<p>This command specifies mailboxes that will always be displayed in the sidebar, even if
<a class="link" href="/guide/reference.html#sidebar-new-mail-only" title="3.427.&#160;sidebar_new_mail_only">$sidebar_new_mail_only</a> is set and the mailbox does not contain new mail.</p>
<a class="link" href="/guide/reference.html#sidebar-new-mail-only" title="3.426.&#160;sidebar_new_mail_only">$sidebar_new_mail_only</a> is set and the mailbox does not contain new mail.</p>
<p>The
<span class="quote"><span class="quote">sidebar_unpin</span></span> command is used to remove a mailbox from the list of always displayed mailboxes. Use
<span class="quote"><span class="quote">sidebar_unpin&#160;*</span></span> to remove all mailboxes.</p>
Expand Down
2 changes: 1 addition & 1 deletion _feature/trash.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ <h2 class="title" style="clear: both">
<a class="link" href="/feature/trash" title="Trash Folder Feature">$trash</a> variable defines a folder in which to keep old emails. As before, first you mark emails for deletion. When &lt;sync-mailbox&gt; is called the emails are moved to the trash folder.</p>
<p>The
<code class="literal">$trash</code> path can be either a full directory, or be relative to the
<a class="link" href="/guide/reference.html#folder" title="3.127.&#160;folder">$folder</a> variable, like the
<a class="link" href="/guide/reference.html#folder" title="3.128.&#160;folder">$folder</a> variable, like the
<code class="literal">mailboxes</code> command.</p>
<div class="note">
<h3 class="title">Note</h3>
Expand Down
Loading

0 comments on commit 8e2d94f

Please sign in to comment.