xref: /netbsd-src/external/gpl2/groff/dist/contrib/grap2graph/grap2graph.man (revision 89a07cf815a29524268025a1139fac4c5190f765)
Id: grap2graph.man,v 1.3 2003/10/28 07:46:23 wlemb Exp
This documentation is released to the public domain.
. .
GRAP2GRAPH @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
grap2graph
NAME
grap2graph - convert a grap diagram into a cropped bitmap image . .
SYNOPSIS
grap2graph [ -unsafe ] [ -resolution M|MxN ] [ -format fmt ] . .
DESCRIPTION
Reads a grap program as input; produces an image file (by default in Portable Network Graphics format) suitable for the Web as output. For a description of the grap language, see grap (1).

Your graph specification should not be wrapped with the .G1 and .G2 macros that normally guard it within groff (@MAN1EXT@) macros.

The output image will be a black-on-white graphic clipped to the smallest possible bounding box that contains all the black pixels. By specifying command-line options to be passed to convert (1) you can give it a border, set the background transparent, set the image's pixel density, or perform other useful transformations.

This program uses grap (1), @g@pic (@MAN1EXT@), groff (@MAN1EXT@), and the ImageMagick convert (1) program. These programs must be installed on your system and accessible on your $PATH for grap2graph to work. . .

OPTIONS

-unsafe Run @g@pic (@MAN1EXT@) and groff (@MAN1EXT@) in the `unsafe' mode enabling the PIC macro sh to execute arbitrary commands. The default is to forbid this.

-format fmt Specify an output format; the default is PNG (Portable Network Graphics). Any format that convert (1) can emit is supported.

Command-line switches and arguments not listed above are passed to convert (1). . .

ENVIRONMENT

GROFF_TMPDIR The directory in which temporary files will be created. If this is not set grap2graph searches the environment variables \%TMPDIR , TMP , and TEMP (in that order). Otherwise, temporary files will be created in /tmp . . .

"SEE ALSO"
pic2graph (@MAN1EXT@), eqn2graph (@MAN1EXT@), @g@pic (@MAN1EXT@), groff (@MAN1EXT@), gs (1), convert (1). . .
AUTHOR
Eric S. Raymond <esr@thyrsus.com> . Local Variables:
mode: nroff
End: