From 0392e608bda16fd21bc0d6c15bd2352bb2a5c91b Mon Sep 17 00:00:00 2001
From: bptato <nincsnevem662@gmail.com>
Date: Sun, 13 Aug 2023 18:23:59 +0200
Subject: Update docs

---
 doc/config.md     | 12 ++++++++++++
 doc/mailcap.md    | 19 +++++++++++++++----
 doc/mime.types.md |  6 ++++++
 3 files changed, 33 insertions(+), 4 deletions(-)

(limited to 'doc')

diff --git a/doc/config.md b/doc/config.md
index fabe9820..6d90f947 100644
--- a/doc/config.md
+++ b/doc/config.md
@@ -161,6 +161,18 @@ Following is a list of external options:
 the line number.</td>
 </tr>
 
+<tr>
+<td>mailcap</td>
+<td>array of paths</td>
+<td>Search path for [mailcap](mailcap.md) files.</td>
+</tr>
+
+<tr>
+<td>mime-types</td>
+<td>array of paths</td>
+<td>Search path for [mime.types](mime.types.md) files.</td>
+</tr>
+
 </table>
 
 ## Network
diff --git a/doc/mailcap.md b/doc/mailcap.md
index 03fbebb1..0e8f77e1 100644
--- a/doc/mailcap.md
+++ b/doc/mailcap.md
@@ -3,15 +3,26 @@
 Chawan's buffers can only handle HTML and plain text. To make Chawan recognize
 other file formats, the mailcap file format can be used.
 
+Note that Chawan's default mime.types file only recognizes a few file
+extensions, which may result in your entries not being executed.
+Please consult the [mime.types](mime.types.md) documentation for details.
+
 For an exact description of the mailcap format, see
 [RFC 1524](https://www.rfc-editor.org/rfc/rfc1524).
 
 ## Search path
 
 The search path for mailcap files can be overridden using the configuration
-variable `external.mailcap`. If no mailcap files were found, Chawan simply
-uses the xdg-open command for all entries. NOTE: this will change once file
-downloading is implemented.
+variable `external.mailcap`.
+
+The default search path for mailcap files is:
+
+```
+$HOME/.mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap
+```
+
+When no mailcap files are found, Chawan simply uses the xdg-open command
+for all entries. Note: this will change once file downloading is implemented.
 
 ## Format
 
@@ -50,7 +61,7 @@ is recognized too.
   but makes Chawan interpret the command's output as HTML.
 * For a description of nametemplate, see the RFC.
 
-## Notes
+## Note
 
 Entries with a content type of text/html are ignored.
 
diff --git a/doc/mime.types.md b/doc/mime.types.md
index 626ebf22..1c69a1db 100644
--- a/doc/mime.types.md
+++ b/doc/mime.types.md
@@ -9,6 +9,12 @@ a description of mailcap.
 Chawan parses all mime.types files defined in `external.mime-types`. If no
 mime.types file was found, the built-in mime type associations are used.
 
+The default search path for mime.types files is:
+
+```
+$HOME/.mailcap:/etc/mailcap:/usr/etc/mailcap:/usr/local/etc/mailcap
+```
+
 ## Format
 
 The mime.types file is a list of whitespace-separated columns. The first
-- 
cgit 1.4.1-2-gfad0