From 36064a80eb40320621c971fb21818aa1b3de4945 Mon Sep 17 00:00:00 2001 From: bptato Date: Fri, 17 Jun 2022 19:54:43 +0200 Subject: Update documentation --- doc/config.md | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) (limited to 'doc/config.md') 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:
**Name****Value****Function** -
double-width-ambiguousbooleanassume the terminal displays characters in the East Asian Ambiguous category as double width +
double-width-ambiguousbooleanAssume the terminal displays characters in the East Asian Ambiguous category as double width
## 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. `END`Move cursor to the previous word by one character `ESC`Ignore keybindings for next character + +## 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: + + +
**Name****Value****Function** +
use-curlbooleanEnable curl support +
curl-binarystringPath to the curl binary (only used if use-curl is set to true) +
+ +To enable curl support, you must + +* set `use-curl` to true +* and set `curl-binary` to the path of your curl binary. -- cgit 1.4.1-2-gfad0