diff options
author | bptato <nincsnevem662@gmail.com> | 2024-04-26 19:35:21 +0200 |
---|---|---|
committer | bptato <nincsnevem662@gmail.com> | 2024-04-26 19:45:53 +0200 |
commit | 601ad98818f3b966686181445339c52f74f75979 (patch) | |
tree | 3f245aacb085ccbee7e7b7c5efbf5b7cd318a5c1 /doc/build.md | |
parent | 83dae4a87a78190262317eca15cbb5d25989d41b (diff) | |
download | chawan-601ad98818f3b966686181445339c52f74f75979.tar.gz |
doc: include auto-generated manpages in repository
The 100kb or so doesn't hurt as much as not having manual pages at all without pandoc (+ not auto-updating them through make all) does.
Diffstat (limited to 'doc/build.md')
-rw-r--r-- | doc/build.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/build.md b/doc/build.md index 3d337d82..2fe463b8 100644 --- a/doc/build.md +++ b/doc/build.md @@ -35,6 +35,8 @@ also override them by setting an environment variable with the same name. `/tmp/usr/local/bin/cha`. * `MANPREFIX`, `MANPREFIX1`, `MANPREFIX5`: prefixes for the installation of man pages. The default setting expands to `/usr/local/share/man/man1`, etc. + (Normally you shouldn't have to set `MANPREFIX1` or `MANPREFIX5` at all, + as these are derived from `MANPREFIX`.) * `CURLLIBNAME`: Change the name of the libcurl shared object file. * `LIBEXECDIR`: Path to your libexec directory; by default, it is relative to wherever the binary is placed when it is executed. (i.e. after installation @@ -52,7 +54,9 @@ also override them by setting an environment variable with the same name. * `all`: build all required executables * `clean`: remove OBJDIR, OUTDIR, and the QuickJS library -* `manpage`: build man pages; note that this is not part of `all` +* `manpage`: rebuild man pages; note that this is not part of `all`. + Manual pages are included in the repository, so this only needs to be called + when you modify the documentation. * `install`: install the `cha` binary, and if man pages were generated, those as well * `uninstall`: remove the `cha` binary and Chawan man pages |