contrib/groff/contrib/eqn2graph/eqn2graph.man

   1 .\" $Id: eqn2graph.man,v 1.2 2002/08/21 17:29:17 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 "SEE ALSO"
  86 .BR @g@eqn (@MAN1EXT@),
  87 .BR groff (@MAN1EXT@),
  88 .BR gs (1),
  89 .BR convert (1).
  90 .
  91 .
  92 .SH AUTHOR
  93 Eric S. Raymond <esr@thyrsus.com>.
  94 .
  95 .\" Local Variables:
  96 .\" mode: nroff
  97 .\" End: