diff options
Diffstat (limited to 'contrib/grap2graph')
| -rw-r--r-- | contrib/grap2graph/grap2graph.1.man | 205 | ||||
| -rw-r--r-- | contrib/grap2graph/grap2graph.am | 40 | ||||
| -rw-r--r-- | contrib/grap2graph/grap2graph.sh | 107 |
3 files changed, 352 insertions, 0 deletions
diff --git a/contrib/grap2graph/grap2graph.1.man b/contrib/grap2graph/grap2graph.1.man new file mode 100644 index 0000000..e7e87f3 --- /dev/null +++ b/contrib/grap2graph/grap2graph.1.man @@ -0,0 +1,205 @@ +.TH grap2graph @MAN1EXT@ "@MDATE@" "groff @VERSION@" +.SH Name +grap2graph \- convert a +.I grap +diagram into a cropped image +. +. +.\" ==================================================================== +.\" Legal Terms +.\" ==================================================================== +.\" +.\" This documentation is released to the public domain. +. +. +.\" Save and disable compatibility mode (for, e.g., Solaris 10/11). +.do nr *groff_grap2graph_1_man_C \n[.cp] +.cp 0 +. +.\" Define fallback for groff 1.23's MR macro if the system lacks it. +.nr do-fallback 0 +.if !\n(.f .nr do-fallback 1 \" mandoc +.if \n(.g .if !d MR .nr do-fallback 1 \" older groff +.if !\n(.g .nr do-fallback 1 \" non-groff *roff +.if \n[do-fallback] \{\ +. de MR +. ie \\n(.$=1 \ +. I \%\\$1 +. el \ +. IR \%\\$1 (\\$2)\\$3 +. . +.\} +.rr do-fallback +. +. +.\" ==================================================================== +.SH Synopsis +.\" ==================================================================== +. +.SY grap2graph +.RB [ \-unsafe ] +.RB [ \-format\~\c +.IR output-format ] +.RI [ convert-argument \~.\|.\|.] +.YS +. +. +.SY grap2graph +.B \-\-help +.YS +. +. +.SY grap2graph +.B \-v +. +.SY grap2graph +.B \-\-version +.YS +. +. +.\" ==================================================================== +.SH Description +.\" ==================================================================== +. +.I grap2graph +reads a +.MR grap 1 +program from the standard input and writes an image file, +by default in Portable Network Graphics (PNG) format, +to the standard output. +. +. +.PP +The input GRAP code should +.I not +be wrapped with the +.B .G1 +and +.B .G2 +macros that normally guard it within +.MR groff @MAN1EXT@ +documents. +. +. +.\" FIXME: How old? This text hasn't been touched since 2008 at latest. +.\" Older versions of +.\" .I \%convert +.\" will produce a black-on-white graphic; newer ones may produce a +.\" black-on-transparent graphic. +. +.PP +Arguments not recognized by +.I grap2graph +are passed to the ImageMagick or GraphicsMagick program +.MR convert 1 . +. +. +By specifying these, you can give your image a border, +.\" Transparent backgrounds are the default in 2018. +.\" force the background transparent, +set the image's pixel density, +or perform other useful transformations. +. +. +.PP +The output image is clipped using +.IR \%convert 's +.B \-trim +option to the smallest possible bounding box that contains all the black +pixels. +. +. +.\" ==================================================================== +.SH Options +.\" ==================================================================== +. +.B \-\-help +displays a usage message, +while +.B \-v +and +.B \-\-version +show version information; +all exit afterward. +. +. +.TP +.BI \-format\~ output-format +Write the image in +.IR output-format , +which must be understood by +.IR \%convert ; +the default is PNG. +. +. +.TP +.B \-unsafe +Run +.I groff +in +.I unsafe +mode, enabling the PIC command +.B sh +to execute arbitrary Unix shell commands. +. +The +.I groff +default is to forbid this. +. +. +.\" ==================================================================== +.SH Environment +.\" ==================================================================== +. +.TP +.I \%GROFF_TMPDIR +.TQ +.I \%TMPDIR +.TQ +.I TMP +.TQ +.I TEMP +These environment variables are searched in the given order to determine +the directory where temporary files will be created. +. +If none are set, +.I /tmp +is used. +. +. +.\" ==================================================================== +.SH Authors +.\" ==================================================================== +. +.I grap2graph +was written by +.MT esr@\:thyrsus\:.com +Eric S.\& Raymond +.ME , +based on a recipe for +.MR pic2graph @MAN1EXT@ , +by W.\& Richard Stevens. +. +. +.\" ==================================================================== +.SH "See also" +.\" ==================================================================== +. +.MR pic2graph @MAN1EXT@ , +.MR eqn2graph @MAN1EXT@ , +.MR grap 1 , +.MR @g@pic @MAN1EXT@ , +.MR groff @MAN1EXT@ , +.MR convert 1 +. +. +.\" Restore compatibility mode (for, e.g., Solaris 10/11). +.cp \n[*groff_grap2graph_1_man_C] +.do rr *groff_grap2graph_1_man_C +. +. +.\" Local Variables: +.\" fill-column: 72 +.\" mode: nroff +.\" End: +.\" vim: set filetype=groff textwidth=72: diff --git a/contrib/grap2graph/grap2graph.am b/contrib/grap2graph/grap2graph.am new file mode 100644 index 0000000..6025aa2 --- /dev/null +++ b/contrib/grap2graph/grap2graph.am @@ -0,0 +1,40 @@ +# Copyright (C) 2003-2020 Free Software Foundation, Inc. +# +# This file is part of groff. +# +# groff is free software; you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# groff is distributed in the hope that it will be useful, but WITHOUT ANY +# WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +# for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. +# +# grap2graph.am +# + +grap2graph_srcdir = $(top_srcdir)/contrib/grap2graph +bin_SCRIPTS += grap2graph +man1_MANS += contrib/grap2graph/grap2graph.1 +EXTRA_DIST += \ + $(grap2graph_srcdir)/grap2graph.sh \ + $(grap2graph_srcdir)/grap2graph.1.man + +grap2graph: $(grap2graph_srcdir)/grap2graph.sh + $(AM_V_GEN)sed -e "s|[@]g[@]|$(g)|g" \ + -e "s|[@]VERSION[@]|$(VERSION)|" \ + -e $(SH_SCRIPT_SED_CMD) $(grap2graph_srcdir)/grap2graph.sh \ + >$@ \ + && chmod +x $@ + + +# Local Variables: +# fill-column: 72 +# mode: makefile-automake +# End: +# vim: set autoindent filetype=automake textwidth=72: diff --git a/contrib/grap2graph/grap2graph.sh b/contrib/grap2graph/grap2graph.sh new file mode 100644 index 0000000..29df25b --- /dev/null +++ b/contrib/grap2graph/grap2graph.sh @@ -0,0 +1,107 @@ +#! /bin/sh +# +# grap2graph -- compile graph description descriptions to bitmap images +# +# by Eric S. Raymond <esr@thyrsus.com>, May 2003 +# +# In Unixland, the magic is in knowing what to string together... +# +# Take grap description on stdin, emit cropped bitmap on stdout. +# The grap markup should *not* be wrapped in .G1/.G2, this script will do that. +# A -U option on the command line enables gpic/groff "unsafe" mode. +# A -format FOO option changes the image output format to any format +# supported by convert(1). All other options are passed to convert(1). +# The default format is PNG. +# + +# Requires the groff suite and the ImageMagick tools. Both are open source. +# This code is released to the public domain. +# +# Here are the assumptions behind the option processing: +# +# 1. None of the options of grap(1) are relevant. +# +# 2. Only the -U option of groff(1) is relevant. +# +# 3. Many options of convert(1) are potentially relevant, (especially +# -density, -interlace, -transparency, -border, and -comment). +# +# Thus, we pass -U to groff(1), and everything else to convert(1). +# +groff_opts="" +convert_opts="" +convert_trim_arg="-trim" +format="png" + +while [ "$1" ] +do + case $1 in + -unsafe) + groff_opts="-U";; + -format) + format=$2 + shift;; + -v | --version) + echo "GNU grap2graph (groff) version @VERSION@" + exit 0;; + --help) + echo "usage: grap2graph [ option ...] < in > out" + exit 0;; + *) + convert_opts="$convert_opts $1";; + esac + shift +done + +# create temporary directory +tmp= +for d in "$GROFF_TMPDIR" "$TMPDIR" "$TMP" "$TEMP" /tmp +do + test -n "$d" && break +done + +if ! test -d "$d" +then + echo "$0: error: temporary directory \"$d\" does not exist or is" \ + "not a directory" >&2 + exit 1 +fi + +if ! tmp=`(umask 077 && mktemp -d -q "$d/grap2graph-XXXXXX") 2> /dev/null` +then + # mktemp failed--not installed or is a version that doesn't support those + # flags? Fall back to older method which uses more predictable naming. + # + # $RANDOM is a Bashism. The fallback of $PPID is not good pseudorandomness, + # but is supported by the stripped-down dash shell, for instance. + tmp="$d/grap2graph$$-${RANDOM:-$PPID}" + (umask 077 && mkdir "$tmp") 2> /dev/null +fi + +if ! test -d "$tmp" +then + echo "$0: error: cannot create temporary directory \"$tmp\"" >&2 + exit 1 +fi + +# See if the installed version of convert(1) is new enough to support the -trim +# option. Versions that didn't were described as "old" as early as 2008. +is_convert_recent=`convert -help | grep -e -trim` +if test -z "$is_convert_recent" +then + echo "$0: warning: falling back to old '-crop 0x0' trim method" >&2 + convert_trim_arg="-crop 0x0" +fi + +trap 'exit_status=$?; rm -rf "$tmp" && exit $exit_status' EXIT INT TERM + +# Here goes: +# 1. Add .G1/.G2. +# 2. Process through grap(1) to emit pic markup. +# 3. Process through groff(1) with pic preprocessing to emit Postscript. +# 4. Use convert(1) to crop the Postscript and turn it into a bitmap. +(echo ".G1"; cat; echo ".G2") | grap | groff -p $groff_opts -Tps -P-pletter | \ + convert -trim $convert_opts - "$tmp"/grap2graph.$format \ + && cat "$tmp"/grap2graph.$format + +# End |