Documentation/make-cg-ref-asciidoc

   1 #!/usr/bin/env bash
   2 #
   3 # Generate asciidoc manpage markup from Cogito quick reference file.
   4 # Copyright (c) Jonas Fonseca, 2006
   5 #
   6 # Takes the path to the reference file. Prints the manpage to stdout.
   7
   8 PACKAGE=${CGPACKAGE:-cogito}
   9
  10 ref=$1
  11
  12 cat <<__END__
  13 cg-ref(7)
  14 =========
  15
  16 NAME
  17 ----
  18 cg-ref - Cogito quick reference
  19
  20 SYNOPSIS
  21 --------
  22 A list of frequently used commands grouped with related commands.
  23
  24 DESCRIPTION
  25 -----------
  26
  27 __END__
  28
  29 sed '
  30         0,/^$/d
  31         /^`---/d
  32         /frame="none"/,1d
  33         s/\\$//
  34         s/[*]\([^*]*\)[*]/\1/g
  35         s/[`]\([^`]*\)[`]/\1/g
  36         s/['\'']\([^'\'']*\)['\'']/\1/g
  37 ' < "$ref" | \
  38 while read line; do
  39         col1=$(echo "$line" | cut -f 1)
  40         case "$line" in
  41         *":")
  42                 echo "$line"
  43                 echo "$line" | sed "s/[^~]/~/g"
  44                 echo
  45                 echo "[verse]"
  46                 continue
  47                 ;;
  48         "-----"*|"")
  49                 echo "$line" | sed 's/-/./g'
  50                 continue
  51                 ;;
  52         "{cg-refopt}"*)
  53                 col1=$(echo "$col1" | sed 's/.*cg-refopt}/   /')
  54                 ;;
  55         esac
  56         col2=$(echo "$line" | sed 's/.*[        ]\+//')
  57         printf "%-30s  %s\n" "$col1" "$col2"
  58 done
  59
  60 cat << __END__
  61
  62 COPYRIGHT
  63 ---------
  64 Copyright (C) Jonas Fonseca, 2006.
  65
  66 SEE ALSO
  67 --------
  68 gitlink:cg-ref[7] is part of gitlink:${PACKAGE}[7],
  69 a toolkit for managing gitlink:git[7] trees.
  70 __END__