about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorbptato <nincsnevem662@gmail.com>2025-05-09 19:36:07 +0200
committerbptato <nincsnevem662@gmail.com>2025-05-09 19:36:07 +0200
commitf563d85a5f47261d7e48d9e38a3c2ff6e318bf6a (patch)
tree98d0aba533217faf5f0a72da971301c70e149eba
parent999e5b451bc5c194094e28382f54d4ffed226c8b (diff)
downloadchawan-f563d85a5f47261d7e48d9e38a3c2ff6e318bf6a.tar.gz
Update docs
-rw-r--r--Makefile3
-rw-r--r--README.md4
-rw-r--r--doc/api.md7
-rw-r--r--doc/cha-api.72
-rw-r--r--doc/cha-config.52
-rw-r--r--doc/cha-localcgi.514
-rw-r--r--doc/cha-mailcap.58
-rw-r--r--doc/cha-terminal.72
-rw-r--r--doc/cha-troubleshooting.76
-rw-r--r--doc/cha-urimethodmap.52
-rw-r--r--doc/config.md2
-rw-r--r--doc/localcgi.md2
-rw-r--r--doc/mailcap.md4
-rw-r--r--doc/terminal.md7
-rw-r--r--doc/troubleshooting.md3
-rw-r--r--doc/urimethodmap.md7
16 files changed, 62 insertions, 13 deletions
diff --git a/Makefile b/Makefile
index 7a129061..7013884e 100644
--- a/Makefile
+++ b/Makefile
@@ -10,6 +10,7 @@ MANPREFIX1 ?= $(MANPREFIX)/man1
 MANPREFIX5 ?= $(MANPREFIX)/man5
 MANPREFIX7 ?= $(MANPREFIX)/man7
 TARGET ?= release
+PANDOC ?= pandoc
 
 # Note: this is not a real shell substitution.
 # The default setting is at {the binary's path}/../libexec/chawan.
@@ -198,7 +199,7 @@ $(OBJDIR)/man/cha-%.md: doc/%.md md2manpreproc
 	./md2manpreproc $< > $@
 
 $(OBJDIR)/man/cha-%.md.roff: $(OBJDIR)/man/cha-%.md
-	pandoc --standalone --to man $< -o $@
+	$(PANDOC) --standalone --to man $< -o $@
 
 doc/cha-%.5: $(OBJDIR)/man/cha-%.md.roff
 	awk 'last=="T}" && $$1=="T{" {print "_"} {last=$$1} 1' $< > $@
diff --git a/README.md b/README.md
index 293ef0d4..fc87a34b 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,3 @@
-# Chawan
-
 [Chawan](https://sr.ht/~bptato/chawan) is a TUI web (and (S)FTP, Gopher,
 Gemini, ...) browser with CSS, inline image and JavaScript support.
 
@@ -78,7 +76,7 @@ Currently implemented features are:
 
 ## Bugs, technical issues, etc.
 
-First, check the [troubleshooting](doc/troubleshooting.md) document.
+First, read the [troubleshooting](doc/troubleshooting.md) document.
 If it doesn't help, [open a ticket](https://todo.sr.ht/~bptato/chawan).
 
 When using the ticket tracker, please make sure your tickets are valid
diff --git a/doc/api.md b/doc/api.md
index 901a21fd..6eb0dd77 100644
--- a/doc/api.md
+++ b/doc/api.md
@@ -748,3 +748,10 @@ Following properties (functions/getters) are defined by `LineEdit`:
 </tr>
 
 </table>
+
+<!-- MANON
+
+## See also
+
+**cha**(1) **cha-config**(5)
+MANOFF -->
diff --git a/doc/cha-api.7 b/doc/cha-api.7
index 3c39986d..777720a6 100644
--- a/doc/cha-api.7
+++ b/doc/cha-api.7
@@ -973,3 +973,5 @@ Jump to the previous/next history entry.
 T}@T{
 T}
 .TE
+.SS See also
+\f[B]cha\f[R](1) \f[B]cha\-config\f[R](5)
diff --git a/doc/cha-config.5 b/doc/cha-config.5
index 9ba5d4ce..5ccba84f 100644
--- a/doc/cha-config.5
+++ b/doc/cha-config.5
@@ -2320,4 +2320,4 @@ A big word is a sequence of non\-whitespace characters.
 It is essentially the same as a w3m word, but with symbols being defined
 as non\-whitespace.
 .SS See also
-\f[B]cha\f[R](1)
+\f[B]cha\f[R](1) \f[B]cha\-api\f[R](7)
diff --git a/doc/cha-localcgi.5 b/doc/cha-localcgi.5
index 9e33aa7b..fe75ca12 100644
--- a/doc/cha-localcgi.5
+++ b/doc/cha-localcgi.5
@@ -9,6 +9,9 @@ All local CGI scripts must be placed in a directory specified in
 \f[CR]external.cgi\-dir\f[R].
 Multiple directories can be specified in an array too, and directories
 specified first have higher precedence.
+.PD 0
+.P
+.PD
 By default, this is set to \f[CR]$CHA_DIR/cgi\-bin\f[R] (i.e.
 \f[CR]\[ti]/.chawan/cgi\-bin\f[R] or
 \f[CR]\[ti]/.config/chawan/cgi\-bin\f[R], depending on
@@ -88,6 +91,9 @@ before that.
 Parameter 1 is the error code, see below.
 If any following parameters are given, they are concatenated to form a
 custom error message.
+.PD 0
+.P
+.PD
 Note: short but descriptive error messages are preferred, messages that
 do not fit on the screen are currently truncated.
 (TODO fix this somehow :P)
@@ -97,6 +103,9 @@ sent; this means that \f[CR]Cha\-Control\f[R] and \f[CR]Status\f[R]
 headers sent after this must be interpreted as regular headers (and thus
 e.g.\ will be available for JS code calling the script using the fetch
 API).
+.PD 0
+.P
+.PD
 WARNING: this header must be sent before any non\-hardcoded headers that
 take external input.
 For example, an HTTP client would have to send
@@ -238,6 +247,9 @@ Note: the path name is percent\-encoded.
 \f[CR]example\f[R].
 Note that, unlike in JavaScript, no question mark is prepended to the
 string.
+.PD 0
+.P
+.PD
 The query string is percent\-encoded as well.
 .PP
 Note: the fragment part is omitted intentionally.
@@ -293,4 +305,4 @@ This means that either \f[CR]pipe\f[R] or \f[CR]fork\f[R] failed.
 Something strange is going on with your system; we recommend exorcism.
 (Maybe you are running out of memory?)
 .SS See also
-\f[B]cha\f[R](1)
+\f[B]cha\f[R](1) \f[B]cha\-urimethodmap\f[R](5)
diff --git a/doc/cha-mailcap.5 b/doc/cha-mailcap.5
index decd41d3..1b894d23 100644
--- a/doc/cha-mailcap.5
+++ b/doc/cha-mailcap.5
@@ -10,9 +10,8 @@ displaying them in Chawan.
 Note that Chawan\[cq]s default mime.types file only recognizes a few
 file extensions, which may result in your entries not being executed if
 your system lacks an /etc/mime.types file.
-Please consult the
-.PP
-\f[B]cha\-mime.types\f[R](5) documentation for details.
+Please consult the \f[B]cha\-mime.types\f[R](5) documentation for
+details.
 .PP
 For an exact description of the mailcap format, see \c
 .UR https://www.rfc-editor.org/rfc/rfc1524
@@ -71,6 +70,9 @@ are also recognized.
 .IP \[bu] 2
 When the \f[CR]test\f[R] named field is specified, the mailcap entry is
 only used if the test command returns 0.
+.PD 0
+.P
+.PD
 Warning: as of now, \f[CR]%s\f[R] does not work with \f[CR]test\f[R];
 \f[CR]test\f[R] named fields with a \f[CR]%s\f[R] template are skipped,
 and no data is piped into \f[CR]test\f[R] commands.
diff --git a/doc/cha-terminal.7 b/doc/cha-terminal.7
index 16c7da16..c32fd520 100644
--- a/doc/cha-terminal.7
+++ b/doc/cha-terminal.7
@@ -74,3 +74,5 @@ However, a real ADM\-3A would likely be confused by non\-ASCII
 characters.
 .PP
 Patches for other terminals (hardware or software alike) are welcome.
+.SS See also
+\f[B]cha\f[R](1)
diff --git a/doc/cha-troubleshooting.7 b/doc/cha-troubleshooting.7
index 17e581b8..d6c2173f 100644
--- a/doc/cha-troubleshooting.7
+++ b/doc/cha-troubleshooting.7
@@ -3,6 +3,12 @@
 .TH "cha\-troubleshooting" "7" "" "" "Troubleshooting Chawan"
 .SH Troubleshooting Chawan
 This document lists common problems you may run into when using Chawan.
+.PP
+If you encounter a problem not described in this document, please open a
+ticket at \c
+.UR https://todo.sr.ht/~bptato/chawan
+.UE \c
+\&.
 .SS I can\[cq]t select/copy text with my mouse?
 Right click \-> select text, then right click \-> copy selection.
 .PP
diff --git a/doc/cha-urimethodmap.5 b/doc/cha-urimethodmap.5
index fa521dcd..8c7dcdcd 100644
--- a/doc/cha-urimethodmap.5
+++ b/doc/cha-urimethodmap.5
@@ -128,3 +128,5 @@ just use omni\-rules instead of urimethodmap + local CGI redirection.
 Rule of thumb: if you find yourself writing local CGI scripts that just
 send a \f[CR]Location:\f[R] header, maybe consider just using an
 omni\-rule.
+.SS See also
+\f[B]cha\f[R](1) \f[B]cha\-localcgi\f[R](5)
diff --git a/doc/config.md b/doc/config.md
index 0e50b080..a2e43077 100644
--- a/doc/config.md
+++ b/doc/config.md
@@ -1753,5 +1753,5 @@ as non-whitespace.
 
 ## See also
 
-**cha**(1)
+**cha**(1) **cha-api**(7)
 MANOFF -->
diff --git a/doc/localcgi.md b/doc/localcgi.md
index 0c41fbb9..f067456a 100644
--- a/doc/localcgi.md
+++ b/doc/localcgi.md
@@ -225,5 +225,5 @@ with your system; we recommend exorcism. (Maybe you are running out of memory?)
 <!-- MANON
 ## See also
 
-**cha**(1)
+**cha**(1) **cha-urimethodmap**(5)
 MANOFF -->
diff --git a/doc/mailcap.md b/doc/mailcap.md
index ed35ef40..47718acb 100644
--- a/doc/mailcap.md
+++ b/doc/mailcap.md
@@ -11,8 +11,8 @@ in Chawan.
 
 Note that Chawan's default mime.types file only recognizes a few file
 extensions, which may result in your entries not being executed if your
-system lacks an /etc/mime.types file. Please consult the
-<!-- MANOFF -->[mime.types](mime.types.md)<!-- MANON -->
+system lacks an /etc/mime.types file.  Please consult
+the <!-- MANOFF -->[mime.types](mime.types.md)<!-- MANON -->
 <!-- MANON **cha-mime.types**(5) MANOFF --> documentation for details.
 
 For an exact description of the mailcap format, see
diff --git a/doc/terminal.md b/doc/terminal.md
index 1ad28611..e1e30ce3 100644
--- a/doc/terminal.md
+++ b/doc/terminal.md
@@ -66,3 +66,10 @@ Sitaker's `admu` emulator.  However, a real ADM-3A would likely be
 confused by non-ASCII characters.
 
 Patches for other terminals (hardware or software alike) are welcome.
+
+<!-- MANON
+
+## See also
+
+**cha**(1)
+MANOFF -->
diff --git a/doc/troubleshooting.md b/doc/troubleshooting.md
index c659131f..29e25ee8 100644
--- a/doc/troubleshooting.md
+++ b/doc/troubleshooting.md
@@ -6,6 +6,9 @@ MANOFF -->
 
 This document lists common problems you may run into when using Chawan.
 
+If you encounter a problem not described in this document, please open a
+ticket at <https://todo.sr.ht/~bptato/chawan>.
+
 ## I can't select/copy text with my mouse?
 
 Right click -> select text, then right click -> copy selection.
diff --git a/doc/urimethodmap.md b/doc/urimethodmap.md
index f2af3c3a..63d4b698 100644
--- a/doc/urimethodmap.md
+++ b/doc/urimethodmap.md
@@ -130,3 +130,10 @@ urimethodmap + local CGI redirection.
 
 Rule of thumb: if you find yourself writing local CGI scripts that just
 send a `Location:` header, maybe consider just using an omni-rule.
+
+<!-- MANON
+
+## See also
+
+**cha**(1) **cha-localcgi**(5)
+MANOFF -->