about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorbptato <nincsnevem662@gmail.com>2023-08-13 18:23:59 +0200
committerbptato <nincsnevem662@gmail.com>2023-08-13 18:23:59 +0200
commit0392e608bda16fd21bc0d6c15bd2352bb2a5c91b (patch)
tree79d18c2b9d7553ca1075660402ee29dd4b3670dc
parentb4da6c35e7676b8c53424a41194da5f5ec5fb6ce (diff)
downloadchawan-0392e608bda16fd21bc0d6c15bd2352bb2a5c91b.tar.gz
Update docs
-rw-r--r--README.md10
-rw-r--r--doc/config.md12
-rw-r--r--doc/mailcap.md19
-rw-r--r--doc/mime.types.md6
4 files changed, 41 insertions, 6 deletions
diff --git a/README.md b/README.md
index 40f13a6d..0a3e03c0 100644
--- a/README.md
+++ b/README.md
@@ -14,8 +14,9 @@ It also functions as a pager, similarly to w3m.
 	  your nim compiler's version using `nim -v`.)
 2. Install the following dependencies:
 	* libcurl: <https://curl.se/libcurl/>
-	* zlib: <http://zlib.net/>
-	* (QuickJS is included in the repository.)
+	* zlib: <https://zlib.net/>
+	* pkg-config, pkgconf, or similar (must be found as "pkg-config"
+	  in PATH)
 3. Use one of the following:
 	* `make release` - optimized release build
 	* `make` - debug build (slow, for development)
@@ -28,6 +29,7 @@ Currently implemented features are:
 * a CSS-capable layout engine (with forms, tables...)
 * incremental loading of plain text streams
 * JavaScript based navigation, (very) basic JS support in documents
+* mailcap
 * cookies
 
 ...with a lot more planned.
@@ -79,6 +81,10 @@ display.color-mode to "24bit". To use 256 colors, set display.color-mode to
 "8bit" instead. (You can also turn off colors and/or styling altogether in
 the configuration; please consult [doc/config.md](doc/config.md) for details.)
 
+### Can I view Markdown files using Chawan?
+
+[Yes](doc/mailcap.md).
+
 ### Why write another web browser?
 
 I've found other text-based web browsers insufficient for my needs, so
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