#! /bin/sh # # SPDX-License-Identifier: BSD-2-Clause # # Copyright (c) 2018-2023 Gavin D. Howard and contributors. # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are met: # # * Redistributions of source code must retain the above copyright notice, this # list of conditions and the following disclaimer. # # * Redistributions in binary form must reproduce the above copyright notice, # this list of conditions and the following disclaimer in the documentation # and/or other materials provided with the distribution. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE # POSSIBILITY OF SUCH DAMAGE. # # Print the usage and exit with an error. usage() { printf "usage: %s manpage\n" "$0" 1>&2 exit 1 } # Generate a manpage and print it to a file. # @param md The markdown manual to generate a manpage for. # @param out The file to print the manpage to. gen_manpage() { _gen_manpage_md="$1" shift _gen_manpage_out="$1" shift cat "$manualsdir/header.txt" > "$_gen_manpage_out" cat "$manualsdir/header_${manpage}.txt" >> "$_gen_manpage_out" pandoc -f commonmark_x -t man "$_gen_manpage_md" >> "$_gen_manpage_out" } # Generate a manual from a template and print it to a file before generating # its manpage. # param args The type of markdown manual to generate. This is a string that # corresponds to build type (see the Build Type section of the # manuals/build.md manual). gen_manual() { _gen_manual_args="$1" shift # Set up some local variables. $manualsdir and $manpage from from the # variables outside the function. _gen_manual_out="$manualsdir/$manpage/$_gen_manual_args.1" _gen_manual_md="$manualsdir/$manpage/$_gen_manual_args.1.md" # Remove the files that will be generated. rm -rf "$_gen_manual_out" "$_gen_manual_md" # Filter the text for the build type. filter_text "$manualsdir/${manpage}.1.md.in" "$_gen_manual_md" "$_gen_manual_args" # Generate the manpage. gen_manpage "$_gen_manual_md" "$_gen_manual_out" } set -e script="$0" scriptdir=$(dirname "$script") manualsdir="$scriptdir/../manuals" . "$scriptdir/functions.sh" # Constants for use later. If the set of build types is changed, $ARGS must be # updated. ARGS="A E H N EH EN HN EHN" # Process command-line arguments. test "$#" -eq 1 || usage manpage="$1" shift if [ "$manpage" != "bcl" ]; then # Generate a manual and manpage for each build type. for a in $ARGS; do gen_manual "$a" done else # For bcl, just generate the manpage. gen_manpage "$manualsdir/${manpage}.3.md" "$manualsdir/${manpage}.3" fi