about summary refs log tree commit diff
path: root/ops
diff options
context:
space:
mode:
authorsterni <sternenseemann@systemli.org>2021-03-11T14·16+0100
committersterni <sternenseemann@systemli.org>2021-03-11T14·31+0000
commitb3f686995fe3321b7f62f0247391cc2afd8b4d8c (patch)
tree3108af52e23fc73ebd112f78d211f1250e431e6f /ops
parent2cd2b58a04cd86e8bf1d72e9c0a67ad8c8e9c8dd (diff)
feat(users/sterni/htmlman): hyperlink .Xr macro in output r/2277
We make use of the -O man=… option of mandoc(1) which allows to convert
cross references via the .Xr macro into actual hyperlinks in the output.
This can be disabled (by passing "none") or done in two modes:

* all: links all .Xr cross references as if they were in
  $out/%N.%S.html. This will lead to broken links of course.
* inManDir: only link to files in $out if the man page is found in
  manDir, use the template defined in linkXrFallback if not.

all is the default, since we don't require all man pages to be in
manDir, so it would be potentially confusing if the path attribute was
used in the pages list.

linkXrFallback uses the debian online man viewer by default currently,
since it can be decently hyperlinked and debian has a lot of packages.
Other options would be:

* https://manpages.ubuntu.com/manpages/latest/en/man%S/%N.%S.html
* https://man.archlinux.org/man/%N.%S.en
* https://man.openbsd.org/%N.%S
* https://www.man7.org/linux/man-pages/man%S/%N.%S.html

Change-Id: I1363b9dfdda25cb7383c7310b8115c335444bd3d
Reviewed-on: https://cl.tvl.fyi/c/depot/+/2597
Tested-by: BuildkiteCI
Reviewed-by: sterni <sternenseemann@systemli.org>
Diffstat (limited to 'ops')
0 files changed, 0 insertions, 0 deletions