lix/doc/manual/render-manpage.sh

#!/bin/sh

set -euo pipefail

lowdown_args=

if [ "$1" = --out-no-smarty ]; then
    lowdown_args=--out-no-smarty
    shift
fi

[ "$#" = 4 ] || {
    echo "wrong number of args passed" >&2
    exit 1
}

title="$1"
section="$2"
infile="$3"
outfile="$4"

(
    printf "Title: %s\n\n" "$title"
    cat "$infile"
) | lowdown -sT man --nroff-nolinks $lowdown_args -M section="$section" -o "$outfile"
build: extract make "functions" into scripts we'll want to use these for the meson builds, and probably eventually rewrite them in something that isn't plain shell. diffoscope confirms that out/share and doc/share are equal before and after these changes Change-Id: I49aa418fc8615cad86d67328e08c28a7405ec952 2024-03-29 19:06:55 +00:00			`#!/bin/sh`

			`set -euo pipefail`

doc: remove the -- unescaping hack lowdown has an option to disable this behavior. use it. Change-Id: I06d4201b7f528021ddb8e94ac6baff385402e080 2024-03-30 16:38:36 +00:00			`lowdown_args=`
build: extract make "functions" into scripts we'll want to use these for the meson builds, and probably eventually rewrite them in something that isn't plain shell. diffoscope confirms that out/share and doc/share are equal before and after these changes Change-Id: I49aa418fc8615cad86d67328e08c28a7405ec952 2024-03-29 19:06:55 +00:00
doc: remove the -- unescaping hack lowdown has an option to disable this behavior. use it. Change-Id: I06d4201b7f528021ddb8e94ac6baff385402e080 2024-03-30 16:38:36 +00:00			`if [ "$1" = --out-no-smarty ]; then`
			`lowdown_args=--out-no-smarty`
build: extract make "functions" into scripts we'll want to use these for the meson builds, and probably eventually rewrite them in something that isn't plain shell. diffoscope confirms that out/share and doc/share are equal before and after these changes Change-Id: I49aa418fc8615cad86d67328e08c28a7405ec952 2024-03-29 19:06:55 +00:00			`shift`
			`fi`

docs: redo content generation for mdbook and manual manpages can be rendered using the markdown output of mdbook, the rest of the manual can generated out of the main doc/manual source tree. we still use lowdown to actually render manpages instead of eg mdbook-man because lowdown does generate reasonably good manpages (though that is also somewhat debatable, but they're a lot better than mdbook-man). doing this not only lets us drastically simplify the lowdown pipeline, but also remove all custom {{#include}} handling since now mdbook does all of it, even for the manpage builds. even the lowdown wrapper isn't entirely necessary because lowdown can take all wrapper arguments with command line flags rather than bits of input file content. This also implements running mdbook in Meson, in order to generate the manpages. The mdbook outputs are also installed in the usual location. Co-authored-by: Qyriad <qyriad@qyriad.me> Change-Id: I60193f9fd0f15d48872f071af35855cda2a0f40b 2024-04-08 19:44:40 +00:00			`[ "$#" = 4 ] \|\| {`
			`echo "wrong number of args passed" >&2`
			`exit 1`
			`}`

build: extract make "functions" into scripts we'll want to use these for the meson builds, and probably eventually rewrite them in something that isn't plain shell. diffoscope confirms that out/share and doc/share are equal before and after these changes Change-Id: I49aa418fc8615cad86d67328e08c28a7405ec952 2024-03-29 19:06:55 +00:00			`title="$1"`
			`section="$2"`
			`infile="$3"`
docs: redo content generation for mdbook and manual manpages can be rendered using the markdown output of mdbook, the rest of the manual can generated out of the main doc/manual source tree. we still use lowdown to actually render manpages instead of eg mdbook-man because lowdown does generate reasonably good manpages (though that is also somewhat debatable, but they're a lot better than mdbook-man). doing this not only lets us drastically simplify the lowdown pipeline, but also remove all custom {{#include}} handling since now mdbook does all of it, even for the manpage builds. even the lowdown wrapper isn't entirely necessary because lowdown can take all wrapper arguments with command line flags rather than bits of input file content. This also implements running mdbook in Meson, in order to generate the manpages. The mdbook outputs are also installed in the usual location. Co-authored-by: Qyriad <qyriad@qyriad.me> Change-Id: I60193f9fd0f15d48872f071af35855cda2a0f40b 2024-04-08 19:44:40 +00:00			`outfile="$4"`
build: extract make "functions" into scripts we'll want to use these for the meson builds, and probably eventually rewrite them in something that isn't plain shell. diffoscope confirms that out/share and doc/share are equal before and after these changes Change-Id: I49aa418fc8615cad86d67328e08c28a7405ec952 2024-03-29 19:06:55 +00:00
docs: redo content generation for mdbook and manual manpages can be rendered using the markdown output of mdbook, the rest of the manual can generated out of the main doc/manual source tree. we still use lowdown to actually render manpages instead of eg mdbook-man because lowdown does generate reasonably good manpages (though that is also somewhat debatable, but they're a lot better than mdbook-man). doing this not only lets us drastically simplify the lowdown pipeline, but also remove all custom {{#include}} handling since now mdbook does all of it, even for the manpage builds. even the lowdown wrapper isn't entirely necessary because lowdown can take all wrapper arguments with command line flags rather than bits of input file content. This also implements running mdbook in Meson, in order to generate the manpages. The mdbook outputs are also installed in the usual location. Co-authored-by: Qyriad <qyriad@qyriad.me> Change-Id: I60193f9fd0f15d48872f071af35855cda2a0f40b 2024-04-08 19:44:40 +00:00			`(`
			`printf "Title: %s\n\n" "$title"`
			`cat "$infile"`
			`) \| lowdown -sT man --nroff-nolinks $lowdown_args -M section="$section" -o "$outfile"`