about summary refs log tree commit diff stats
path: root/doc/config.md
diff options
context:
space:
mode:
authorbptato <nincsnevem662@gmail.com>2022-06-17 19:54:43 +0200
committerbptato <nincsnevem662@gmail.com>2022-06-17 19:54:43 +0200
commit36064a80eb40320621c971fb21818aa1b3de4945 (patch)
tree148109feb3a80c10807fccbdedcdc52d6a878a76 /doc/config.md
parent25368137bde70556332f368c308427bb6d1b497d (diff)
downloadchawan-36064a80eb40320621c971fb21818aa1b3de4945.tar.gz
Update documentation
Diffstat (limited to 'doc/config.md')
-rw-r--r--doc/config.md36
1 files changed, 29 insertions, 7 deletions
diff --git a/doc/config.md b/doc/config.md
index ad18bc52..59c4b578 100644
--- a/doc/config.md
+++ b/doc/config.md
@@ -10,18 +10,18 @@ A list of configurable options follows.
 
 ## General
 
-General options are to be placed in a section called [general].
+General options must be placed in a section called `[general]`.
 
-Following are general options:
+Following is a list of general options:
 
 <table>
 <tr><th>**Name**<th>**Value**<th>**Function**
-<tr><td>double-width-ambiguous<td>boolean<td>assume the terminal displays characters in the East Asian Ambiguous category as double width
+<tr><td>double-width-ambiguous<td>boolean<td>Assume the terminal displays characters in the East Asian Ambiguous category as double width
 </table>
 
 ## Stylesheets
 
-User stylesheets are to be placed in a section called [css].
+User stylesheets must be placed in a section called `[css]`.
 
 There are two ways to import user stylesheets:
 
@@ -35,10 +35,10 @@ There are two ways to import user stylesheets:
 
 ## Keybindings
 
-Keybindings are to be placed in these sections:
+Keybindings must be placed in these sections:
 
-* for page browsing: [page]
-* for line editing: [line]
+* for page browsing: `[page]`
+* for line editing: `[line]`
 
 Keybindings are configured using the syntax
 
@@ -122,3 +122,25 @@ description of these follows.
 <tr><td>`END`<td>Move cursor to the previous word by one character
 <tr><td>`ESC`<td>Ignore keybindings for next character
 </table>
+
+## Network
+
+Network options must be placed in a section called `[network]`.
+
+Chawan can use two separate back-ends to fetch remote resources (i.e. websites,
+css, etc.) The default back-end is the nim standard library's HTTP client.  
+As an alternative, curl is supported as well, by invoking an existing curl
+binary on your system.
+
+Following is a list of network options:
+
+<table>
+<tr><th>**Name**<th>**Value**<th>**Function**
+<tr><td>use-curl<td>boolean<td>Enable curl support
+<tr><td>curl-binary<td>string<td>Path to the curl binary (only used if use-curl is set to true)
+</table>
+
+To enable curl support, you must
+
+* set `use-curl` to true
+* and set `curl-binary` to the path of your curl binary.