contrib/eqn2graph/eqn2graph.1.man

   1 .TH EQN2GRAPH @MAN1EXT@ "@MDATE@" "groff @VERSION@"
   2 .SH NAME
   3 eqn2graph \- convert an EQN equation into a cropped image
   4 .
   5 .
   6 .\" ====================================================================
   7 .\" Legal Terms
   8 .\" ====================================================================
   9 .\"
  10 .\" This documentation is released to the public domain.
  11 .
  12 .
  13 .\" ====================================================================
  14 .SH SYNOPSIS
  15 .\" ====================================================================
  16 .
  17 .SY eqn2graph
  18 .OP \-format output-format
  19 .RI [ convert-arguments ]
  20 .YS
  21 .
  22 .SY eqn2graph
  23 .B \-\-help
  24 .YS
  25 .
  26 .SY eqn2graph
  27 .B \-v
  28 .SY eqn2graph
  29 .B \-\-version
  30 .YS
  31 .
  32 .
  33 .\" ====================================================================
  34 .SH DESCRIPTION
  35 .\" ====================================================================
  36 .
  37 .I eqn2graph
  38 reads a one-line
  39 .IR @g@eqn (@MAN1EXT@)
  40 equation from the standard input and writes an image file,
  41 by default in Portable Network Graphics (PNG) format,
  42 to the standard output.
  43 .
  44 .
  45 .PP
  46 The input EQN code should
  47 .I not
  48 be preceded by the
  49 .B \&.EQ
  50 macro that normally precedes it within
  51 .IR groff (@MAN1EXT@)
  52 macros;
  53 nor do you need to have dollar-sign or other delimiters around the
  54 equation.
  55 .
  56 .
  57 .\" FIXME: How old?  This text hasn't been touched since 2008 at latest.
  58 .\" Older versions of
  59 .\" .I \%convert
  60 .\" will produce a black-on-white graphic; newer ones may produce a
  61 .\" black-on-transparent graphic.
  62 .
  63 .PP
  64 Arguments not recognized by
  65 .I eqn2graph
  66 are passed to the ImageMagick or GraphicsMagick program
  67 .IR \%convert (1).
  68 .
  69 .
  70 By specifying these, you can give your image a border,
  71 .\" Transparent backgrounds are the default in 2018.
  72 .\" force the background transparent,
  73 set the image's pixel density,
  74 or perform other useful transformations.
  75 .
  76 .
  77 .PP
  78 The output image is clipped using
  79 .IR \%convert 's
  80 .B \-trim
  81 option to the smallest possible bounding box that contains all the black
  82 pixels.
  83 .
  84 .
  85 .\" ====================================================================
  86 .SH OPTIONS
  87 .\" ====================================================================
  88 .
  89 .TP
  90 .BI "\-format " output-format
  91 Write the image in
  92 .IR output-format ,
  93 which must be understood by
  94 .IR \%convert ;
  95 the default is PNG.
  96 .
  97 .
  98 .TP
  99 .B \-\-help
 100 Display a usage message and exit.
 101 .
 102 .
 103 .TP
 104 .B \-v
 105 .TQ
 106 .B \-\-version
 107 Display version information and exit.
 108 .
 109 .
 110 .\" ====================================================================
 111 .SH ENVIRONMENT
 112 .\" ====================================================================
 113 .
 114 .TP
 115 .I \%GROFF_TMPDIR
 116 .TQ
 117 .I \%TMPDIR
 118 .TQ
 119 .I TMP
 120 .TQ
 121 .I TEMP
 122 These environment variables are searched in the given order to determine
 123 the directory where temporary files will be created.
 124 .
 125 If none are set,
 126 .I /tmp
 127 is used.
 128 .
 129 .
 130 .\" ====================================================================
 131 .SH AUTHORS
 132 .\" ====================================================================
 133 .
 134 .I eqn2graph
 135 was written by
 136 .MT esr@\:thyrsus.com
 137 Eric S.\& Raymond
 138 .ME ,
 139 based on a recipe for
 140 .IR pic2graph (@MAN1EXT@),
 141 by W.\& Richard Stevens.
 142 .
 143 .
 144 .\" ====================================================================
 145 .SH "SEE ALSO"
 146 .\" ====================================================================
 147 .
 148 .IR pic2graph (@MAN1EXT@),
 149 .IR grap2graph (@MAN1EXT@),
 150 .IR @g@eqn (@MAN1EXT@),
 151 .IR groff (@MAN1EXT@),
 152 .IR \%convert (1)
 153 .
 154 .
 155 .\" Local Variables:
 156 .\" mode: nroff
 157 .\" End:
 158 .\" vim: set filetype=groff: