diff options
| -rw-r--r-- | doc/config.md | 36 | ||||
| -rw-r--r-- | readme.md | 7 |
2 files changed, 32 insertions, 11 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. diff --git a/readme.md b/readme.md index 267b4e65..10f4eab5 100644 --- a/readme.md +++ b/readme.md @@ -20,7 +20,6 @@ Currently implemented features are: * an unicode, double-width capable pager * a (basic) CSS-capable layout engine -* configuration * incomplete support for forms * incomplete support for remote resources (i.e. css) @@ -35,9 +34,9 @@ Currently implemented features are: * incremental page loading (to function as a proper pager) * table * iframe -* ruby (with non-standard extensions) +* ruby * separate threads for io, fetching resources and rendering pages -* http headers (incl. cookies) +* cookies * external viewers (for audio, video, image, etc) * image (sixel & kitty?) * markdown (built-in parser) @@ -69,6 +68,6 @@ features but a completely different architecture. Meaning this browser should be able to function as a replacement of w3m, just better. (I am still quite far from reaching that goal however.) -## How to configure stuff +## Configuration See [doc/config.md](doc/config.md). |