diff options
| author | bptato <nincsnevem662@gmail.com> | 2024-04-12 03:47:20 +0200 |
|---|---|---|
| committer | bptato <nincsnevem662@gmail.com> | 2024-04-12 03:47:20 +0200 |
| commit | b2822404793aa5011aff2597f0c98f59c55a9a89 (patch) | |
| tree | f456e644998ab8e80ea7d809a45845c7a5c6f2e7 | |
| parent | b77810d07984f6586529b60e0b1e4238b639e488 (diff) | |
| download | chawan-b2822404793aa5011aff2597f0c98f59c55a9a89.tar.gz | |
Update readme
| -rw-r--r-- | README.md | 32 |
1 files changed, 27 insertions, 5 deletions
diff --git a/README.md b/README.md index 3492fffe..5449a0f8 100644 --- a/README.md +++ b/README.md @@ -121,13 +121,27 @@ You can fix this manually by adjusting the `display.default-background-color`, Yes; Chawan now has a built-in markdown converter. If you don't like it, you can always [replace it](doc/mailcap.md) with e.g. pandoc. -### Why write another web browser? +### I set Chawan as my PAGER and now man pages are unreadable. -I've found other text-based web browsers insufficient for my needs, so -I thought it'd be a fun excercise to write one by myself, for myself. +TLDR: use mancha. -Generally, I'm happy if Chawan works on websites I use frequently. If it -also works on other websites, that's a bonus. +Long explanation: + +Most `man` implementations print formatted manual pages by default, which +Chawan *can* in fact automatically parse, *if* they are passed through standard +input. Unfortunately, some `man` implementations (mandoc in particular) pass us +the formatted document as a *file*, which Chawan reasonably interprets as plain +text without formatting. (mandoc does not even set a useful file extension to +guide us.) + +At this point you have two options: + +* Set PAGER='cha -T text/x-ansi', and see that man suddenly works as expected. +* alias man=mancha in your bashrc, and see that man suddenly works better than + expected. + +It may be best to do both, to deal with annoying cases like git help which +shells out to man directly. ### Where are the keybindings? @@ -225,6 +239,14 @@ Here's some: For further details, ~~you will have to read the source code~~ please read [this](doc/architecture.md). +### Why write another web browser? + +I've found other text-based web browsers insufficient for my needs, so +I thought it'd be a fun excercise to write one by myself, for myself. + +Generally, I'm happy if Chawan works on websites I use frequently. If it +also works on other websites, that's a bonus. + ## License Chawan is dedicated to the public domain. See the UNLICENSE file for details. |