/contrib/groff/contrib/grap2graph/grap2graph.man
Unknown | 105 lines | 105 code | 0 blank | 0 comment | 0 complexity | 0dd048dbbc38523f0314da997d23597f MD5 | raw file
1.\" $Id: grap2graph.man,v 1.3 2003/10/28 07:46:23 wlemb Exp $ 2.\" This documentation is released to the public domain. 3. 4. 5.TH GRAP2GRAPH @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@" 6.IX grap2graph 7.SH NAME 8grap2graph \- convert a grap diagram into a cropped bitmap image 9. 10. 11.SH SYNOPSIS 12.B grap2graph 13[ 14.B \-unsafe 15] 16[ 17.BI \-resolution\ M\fR|\fPMxN 18] 19[ 20.BI \-format\ fmt 21] 22. 23. 24.SH DESCRIPTION 25Reads a grap program as input; produces an image file (by default in 26Portable Network Graphics format) suitable for the Web as output. 27For a description of the grap language, see 28.BR grap (1). 29.P 30Your graph specification should \fInot\fR be wrapped with the \&.G1 and 31\&.G2 macros that normally guard it within 32.BR groff (@MAN1EXT@) 33macros. 34.P 35The output image will be a black-on-white graphic clipped to the 36smallest possible bounding box that contains all the black pixels. 37By specifying command-line options to be passed to 38.BR convert (1) 39you can give it a border, set the background transparent, set the 40image's pixel density, or perform other useful transformations. 41.P 42This program uses 43.BR grap (1), 44.BR @g@pic (@MAN1EXT@), 45.BR groff (@MAN1EXT@), 46and the ImageMagick 47.BR convert (1) 48program. 49These programs must be installed on your system and accessible on your 50$PATH for \fBgrap2graph\fR to work. 51. 52. 53.SH OPTIONS 54.TP 55.B \-unsafe 56Run 57.BR @g@pic (@MAN1EXT@) 58and 59.BR groff (@MAN1EXT@) 60in the `unsafe' mode enabling the PIC macro 61.B sh 62to execute arbitrary commands. 63The default is to forbid this. 64.TP 65.BI \-format\ fmt 66Specify an output format; the default is PNG (Portable Network Graphics). 67Any format that 68.BR convert (1) 69can emit is supported. 70.PP 71Command-line switches and arguments not listed above are passed to 72.BR convert (1). 73. 74. 75.SH ENVIRONMENT 76.TP 77.B GROFF_TMPDIR 78The directory in which temporary files will be created. 79If this is not set 80.B grap2graph 81searches the environment variables 82.BR \%TMPDIR , 83.BR TMP , 84and 85.B TEMP 86(in that order). 87Otherwise, temporary files will be created in 88.BR /tmp . 89. 90. 91.SH "SEE ALSO" 92.BR pic2graph (@MAN1EXT@), 93.BR eqn2graph (@MAN1EXT@), 94.BR @g@pic (@MAN1EXT@), 95.BR groff (@MAN1EXT@), 96.BR gs (1), 97.BR convert (1). 98. 99. 100.SH AUTHOR 101Eric S. Raymond <esr@thyrsus.com> 102. 103.\" Local Variables: 104.\" mode: nroff 105.\" End: