contrib/groff/contrib/eqn2graph/eqn2graph.man

   1 .\" $Id: eqn2graph.man,v 1.4 2003/10/28 07:46:23 wlemb Exp $
   2 .\" This documentation is released to the public domain.
   3 .
   4 .
   5 .\" Like TP, but if specified indent is more than half
   6 .\" the current line-length - indent, use the default indent.
   7 .de Tp
   8 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
   9 .el .TP "\\$1"
  10 ..
  11 .
  12 .
  13 .TH EQN2GRAPH @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
  14 .IX eqn2graph
  15 .SH NAME
  16 eqn2graph \- convert an EQN equation into a cropped image
  17 .
  18 .
  19 .SH SYNOPSIS
  20 .B eqn2graph
  21 [
  22 .B \-unsafe
  23 ]
  24 [
  25 .BI \-format\  fmt
  26 ]
  27 .
  28 .
  29 .SH DESCRIPTION
  30 Reads an EQN equation (one line) as input; produces an image
  31 file (by default in Portable Network Graphics format) suitable for the
  32 Web as output.
  33 .P
  34 Your input EQN code should \fInot\fR have the \&.EQ/.EN preamble that
  35 that normally precedes it within
  36 .BR groff (@MAN1EXT@)
  37 macros; nor do you need to have dollar-sign or other delimiters
  38 around the equation.
  39 .P
  40 The output image will be a black-on-white graphic clipped to the
  41 smallest possible bounding box that contains all the black pixels.
  42 By specifying command-line options to be passed to
  43 .BR convert (1)
  44 you can give it a border, set the background transparent, set the
  45 image's pixel density, or perform other useful transformations.
  46 .P
  47 This program uses
  48 .BR @g@eqn (@MAN1EXT@),
  49 .BR groff (@MAN1EXT@),
  50 and the ImageMagick
  51 .BR convert (1)
  52 program.
  53 These programs must be installed on your system and accessible on your
  54 $PATH for \fBeqn2graph\fR to work.
  55 .
  56 .
  57 .SH OPTIONS
  58 .TP
  59 .B \-unsafe
  60 Run
  61 .BR groff (@MAN1EXT@)
  62 in the `unsafe' mode enabling the PIC macro
  63 .B sh
  64 to execute arbitrary commands.
  65 The default is to forbid this.
  66 .TP
  67 .BI \-format\  fmt
  68 Specify an output format; the default is PNG (Portable Network Graphics).
  69 Any format that
  70 .BR convert (1)
  71 can emit is supported.
  72 .PP
  73 Command-line switches and arguments not listed above are passed to
  74 .BR convert (1).
  75 .
  76 .
  77 .SH FILES
  78 .Tp \w'\fB@MACRODIR@/eqnrc'u+2n
  79 .B @MACRODIR@/eqnrc
  80 The
  81 .BR @g@eqn (@MAN1EXT@)
  82 initialization file.
  83 .
  84 .
  85 .SH ENVIRONMENT
  86 .TP
  87 .B GROFF_TMPDIR
  88 The directory in which temporary files will be created.
  89 If this is not set
  90 .B eqn2graph
  91 searches the environment variables
  92 .BR \%TMPDIR ,
  93 .BR TMP ,
  94 and
  95 .B TEMP
  96 (in that order).
  97 Otherwise, temporary files will be created in
  98 .BR /tmp .
  99 .
 100 .
 101 .SH "SEE ALSO"
 102 .BR pic2graph (@MAN1EXT@),
 103 .BR grap2graph (@MAN1EXT@),
 104 .BR @g@eqn (@MAN1EXT@),
 105 .BR groff (@MAN1EXT@),
 106 .BR gs (1),
 107 .BR convert (1).
 108 .
 109 .
 110 .SH AUTHOR
 111 Eric S. Raymond <esr@thyrsus.com>.
 112 .
 113 .\" Local Variables:
 114 .\" mode: nroff
 115 .\" End: