tor/doc/asciidoc-helper.sh
skaluzka eac7bdce91
Clear asciidoc-helper.sh syntax
Remove all unnecessary ";" characters at the end of several lines.
Align all indentations to 4 spaces.
Update console messages related to XML_CATALOG_FILES and
.bashrc file.

Signed-off-by: skaluzka <skaluzka@protonmail.com>
2021-09-08 22:32:46 +02:00

68 lines
1.9 KiB
Bash
Executable File

#!/bin/sh
# Copyright (c) The Tor Project, Inc.
# See LICENSE for licensing information
# Run this to generate .html.in or .1.in files from asciidoc files.
# Arguments:
# html|man asciidocpath outputfile
set -e
if [ $# != 3 ]; then
exit 1
fi
output=$3
if [ "$1" = "html" ]; then
input=${output%%.html.in}.1.txt
base=${output%%.html.in}
if [ "$2" != none ]; then
TZ=UTC "$2" -d manpage -o "$output" "$input"
else
echo "=================================="
echo
echo "You need asciidoc installed to be able to build the manpage."
echo "To build without manpages, use the --disable-asciidoc argument"
echo "when calling configure."
echo
echo "=================================="
exit 1
fi
elif [ "$1" = "man" ]; then
input=${output%%.1.in}.1.txt
base=${output%%.1.in}
if test "$2" = none; then
echo "=================================="
echo
echo "You need asciidoc installed to be able to build the manpage."
echo "To build without manpages, use the --disable-asciidoc argument"
echo "when calling configure."
echo
echo "=================================="
exit 1
fi
if "$2" -f manpage "$input"; then
mv "$base.1" "$output"
else
cat<<EOF
==================================
You need a working asciidoc installed to be able to build the manpage.
a2x is installed, but for some reason it isn't working. Sometimes
this happens because required docbook support files are missing.
Please install docbook-xsl, docbook-xml, and xmlto (Debian) or
similar. If you use homebrew on Mac OS X, install the docbook formula
and add "export XML_CATALOG_FILES=/usr/local/etc/xml/catalog" to your
.bashrc file.
Alternatively, to build without manpages, use the --disable-asciidoc
argument when calling configure.
==================================
EOF
exit 1
fi
fi