contrib/bc/manpage.sh

   1 #! /bin/sh
   2 #
   3 # SPDX-License-Identifier: BSD-2-Clause
   4 #
   5 # Copyright (c) 2018-2020 Gavin D. Howard and contributors.
   6 #
   7 # Redistribution and use in source and binary forms, with or without
   8 # modification, are permitted provided that the following conditions are met:
   9 #
  10 # * Redistributions of source code must retain the above copyright notice, this
  11 #   list of conditions and the following disclaimer.
  12 #
  13 # * Redistributions in binary form must reproduce the above copyright notice,
  14 #   this list of conditions and the following disclaimer in the documentation
  15 #   and/or other materials provided with the distribution.
  16 #
  17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  18 # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 # ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  21 # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  22 # CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23 # SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24 # INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  25 # CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26 # ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  27 # POSSIBILITY OF SUCH DAMAGE.
  28 #
  29
  30 usage() {
  31         printf "usage: %s manpage\n" "$0" 1>&2
  32         exit 1
  33 }
  34
  35 gen_manpage() {
  36
  37         _gen_manpage_args="$1"
  38         shift
  39
  40         _gen_manpage_status="$ALL"
  41         _gen_manpage_out="$manualsdir/$manpage/$_gen_manpage_args.1"
  42         _gen_manpage_md="$manualsdir/$manpage/$_gen_manpage_args.1.md"
  43         _gen_manpage_temp="$manualsdir/temp.1.md"
  44         _gen_manpage_ifs="$IFS"
  45
  46         rm -rf "$_gen_manpage_out" "$_gen_manpage_md"
  47
  48         while IFS= read -r line; do
  49
  50                 if [ "$line" = "{{ end }}" ]; then
  51
  52                         if [ "$_gen_manpage_status" -eq "$ALL" ]; then
  53                                 err_exit "{{ end }} tag without corresponding start tag" 2
  54                         fi
  55
  56                         _gen_manpage_status="$ALL"
  57
  58                 elif [ "${line#\{\{* $_gen_manpage_args *\}\}}" != "$line" ]; then
  59
  60                         if [ "$_gen_manpage_status" -ne "$ALL" ]; then
  61                                 err_exit "start tag nested in start tag" 3
  62                         fi
  63
  64                         _gen_manpage_status="$NOSKIP"
  65
  66                 elif [ "${line#\{\{*\}\}}" != "$line" ]; then
  67
  68                         if [ "$_gen_manpage_status" -ne "$ALL" ]; then
  69                                 err_exit "start tag nested in start tag" 3
  70                         fi
  71
  72                         _gen_manpage_status="$SKIP"
  73
  74                 else
  75                         if [ "$_gen_manpage_status" -ne "$SKIP" ]; then
  76                                 printf '%s\n' "$line" >> "$_gen_manpage_temp"
  77                         fi
  78                 fi
  79
  80         done < "$manualsdir/${manpage}.1.md.in"
  81
  82         uniq "$_gen_manpage_temp" "$_gen_manpage_md"
  83         rm -rf "$_gen_manpage_temp"
  84
  85         IFS="$_gen_manpage_ifs"
  86
  87         cat "$manualsdir/header.txt" > "$_gen_manpage_out"
  88         cat "$manualsdir/header_${manpage}.txt" >> "$_gen_manpage_out"
  89
  90         pandoc -f markdown -t man "$_gen_manpage_md" >> "$_gen_manpage_out"
  91 }
  92
  93 set -e
  94
  95 script="$0"
  96 scriptdir=$(dirname "$script")
  97 manualsdir="$scriptdir/manuals"
  98
  99 . "$scriptdir/functions.sh"
 100
 101 ARGS="A E H N P EH EN EP HN HP NP EHN EHP ENP HNP EHNP"
 102 ALL=0
 103 NOSKIP=1
 104 SKIP=2
 105
 106 test "$#" -eq 1 || usage
 107
 108 manpage="$1"
 109 shift
 110
 111 for a in $ARGS; do
 112         gen_manpage "$a"
 113 done