summaryrefslogtreecommitdiff
path: root/build-aux
diff options
context:
space:
mode:
authorLasse Collin <lasse.collin@tukaani.org>2010-09-28 11:40:12 +0300
committerLasse Collin <lasse.collin@tukaani.org>2010-09-28 11:40:12 +0300
commit9166682dc601fd42c1b9510572e3f917d18de504 (patch)
treebfb375ceca9e23ac6946c61ecf14987368f622a8 /build-aux
parent17d3c61edd35de8fa884944fc70d1db86daa5dd8 (diff)
downloadxz-9166682dc601fd42c1b9510572e3f917d18de504.tar.gz
Create the PDF versions of the man pages better.
Diffstat (limited to 'build-aux')
-rw-r--r--build-aux/manconv.sh58
1 files changed, 58 insertions, 0 deletions
diff --git a/build-aux/manconv.sh b/build-aux/manconv.sh
new file mode 100644
index 0000000..e53b026
--- /dev/null
+++ b/build-aux/manconv.sh
@@ -0,0 +1,58 @@
+#!/bin/sh
+#
+###############################################################################
+#
+# Wrapper for GNU groff to convert man pages to a few formats
+#
+# Usage: manconv.sh FORMAT [PAPER_SIZE] < in.1 > out.suffix
+#
+# FORMAT can be ascii, utf8, ps, or pdf. PAPER_SIZE can be anything that
+# groff accepts, e.g. a4 or letter. See groff_font(5). PAPER_SIZE defaults
+# to a4 and is used only when FORMAT is ps (PostScript) or pdf.
+#
+# Multiple man pages can be given at once e.g. to create a single PDF file
+# with continuous page numbering.
+#
+###############################################################################
+#
+# Author: Lasse Collin
+#
+# This file has been put into the public domain.
+# You can do whatever you want with this file.
+#
+###############################################################################
+
+FORMAT=$1
+PAPER=${2-a4}
+
+# Make PostScript and PDF output more readable:
+# - Use 11 pt font instead of the default 10 pt.
+# - Use larger paragraph spacing than the default 0.4v (man(7) only).
+FONT=11
+PD=0.8
+
+SED_PD="
+/^\\.TH /s/\$/\\
+.PD $PD/
+s/^\\.PD\$/.PD $PD/"
+
+case $FORMAT in
+ ascii)
+ groff -t -mandoc -Tascii | col -bx
+ ;;
+ utf8)
+ groff -t -mandoc -Tutf8 | col -bx
+ ;;
+ ps)
+ sed "$SED_PD" | groff -dpaper=$PAPER -t -mandoc \
+ -rC1 -rS$FONT -Tps -P-p$PAPER
+ ;;
+ pdf)
+ sed "$SED_PD" | groff -dpaper=$PAPER -t -mandoc \
+ -rC1 -rS$FONT -Tps -P-p$PAPER | ps2pdf - -
+ ;;
+ *)
+ echo 'Invalid arguments' >&2
+ exit 1
+ ;;
+esac