Warning, /graphics/glaxnimate/external/potrace/README is written in an unsupported language. File is not indexed.

0001 
0002            POTRACE - transform bitmaps into vector graphics
0003                         
0004                                 * * *
0005            
0006 DESCRIPTION
0007 
0008  Potrace is a tool for tracing a bitmap, which means, transforming a
0009  bitmap into a smooth, scalable image.  The input is a bitmap (PBM,
0010  PGM, PPM, or BMP), and the output is one of several vector file
0011  formats.  A typical use is to create SVG or PDF files from scanned
0012  data, such as company or university logos, handwritten notes, etc.
0013  The resulting image is not "jaggy" like a bitmap, but smooth. It can
0014  then be rendered at any resolution.
0015 
0016  Potrace can currently produce the following output formats: SVG, PDF,
0017  EPS, PostScript, DXF, GeoJSON, PGM (for easy antialiasing of
0018  pixel-based images), Gimppath, and XFig. Additional backends might be
0019  added in the future.
0020 
0021  A separate program, mkbitmap, is also provided. This program can act
0022  as a pre-processor for Potrace, applying scaling and various filters
0023  to an image before converting it to a bitmap. This is useful for
0024  potracing greyscale and color images.
0025 
0026 DEPENDENCIES
0027 
0028  Potrace relies on the zlib library for PostScript level 3
0029  compression. This library is pre-installed on most modern systems. 
0030  If not present, it can be obtained from http://www.gzip.org/zlib/.
0031 
0032 COMPILATION
0033 
0034  For generic compilation instructions, see the file INSTALL.  In
0035  addition, the following compile time options (options to ./configure)
0036  are supported. 
0037 
0038   --with-libpotrace       install Potrace library and headers (default: no)
0039   --disable-zlib          disable PostScript level 3 compression
0040   --enable-metric         use metric units (centimeters) as default
0041   --enable-a4             use a4 as the default papersize
0042   --enable-dumb-tty       use simplified ASCII-only progress bar
0043   --with-included-getopt  avoid using the system-wide getopt library
0044 
0045  See also ./configure --help.
0046 
0047 INSTALLING
0048 
0049  If you are installing from sources, just do "make install" as root.
0050  If you are installing from a binary distribution, just copy the
0051  "potrace" and "mkbitmap" binaries to a place where the operating
0052  system expects them, such as /usr/local/bin. Also copy the files
0053  "potrace.1" and "mkbitmap.1" to a directory where the operating
0054  system looks for man pages, such as /usr/local/man/man1. For
0055  instructions on installing Potrace under Windows, see the file
0056  README-WIN
0057 
0058 USAGE
0059 
0060  For more detailed usage information, see the man page.
0061 
0062  Usage: potrace [options] [filename...]
0063  General options:
0064   -h, --help                 - print this help message and exit
0065   -v, --version              - print version info and exit
0066   -l, --license              - print license info and exit
0067  File selection:
0068   <filename>                 - an input file
0069   -o, --output <filename>    - write all output to this file
0070   --                         - end of options; 0 or more input filenames follow
0071  Backend selection:
0072   -b, --backend <name>       - select backend by name
0073   -b svg, -s, --svg          - SVG backend (scalable vector graphics)
0074   -b pdf                     - PDF backend (portable document format)
0075   -b pdfpage                 - fixed page-size PDF backend
0076   -b eps, -e, --eps          - EPS backend (encapsulated PostScript) (default)
0077   -b ps, -p, --postscript    - PostScript backend
0078   -b pgm, -g, --pgm          - PGM backend (portable greymap)
0079   -b dxf                     - DXF backend (drawing interchange format)
0080   -b geojson                 - GeoJSON backend
0081   -b gimppath                - Gimppath backend (GNU Gimp)
0082   -b xfig                    - XFig backend
0083  Algorithm options:
0084   -z, --turnpolicy <policy>  - how to resolve ambiguities in path decomposition
0085   -t, --turdsize <n>         - suppress speckles of up to this size (default 2)
0086   -a, --alphamax <n>         - corner threshold parameter (default 1)
0087   -n, --longcurve            - turn off curve optimization
0088   -O, --opttolerance <n>     - curve optimization tolerance (default 0.2)
0089   -u, --unit <n>             - quantize output to 1/unit pixels (default 10)
0090   -d, --debug <n>            - produce debugging output of type n (n=1,2,3)
0091  Scaling and placement options:
0092   -P, --pagesize <format>    - page size (default is letter)
0093   -W, --width <dim>          - width of output image
0094   -H, --height <dim>         - height of output image
0095   -r, --resolution <n>[x<n>] - resolution (in dpi) (dimension-based backends)
0096   -x, --scale <n>[x<n>]      - scaling factor (pixel-based backends)
0097   -S, --stretch <n>          - yresolution/xresolution
0098   -A, --rotate <angle>       - rotate counterclockwise by angle
0099   -M, --margin <dim>         - margin
0100   -L, --leftmargin <dim>     - left margin
0101   -R, --rightmargin <dim>    - right margin
0102   -T, --topmargin <dim>      - top margin
0103   -B, --bottommargin <dim>   - bottom margin
0104   --tight                    - remove whitespace around the input image
0105  Color options, supported by some backends:
0106   -C, --color #rrggbb        - set foreground color (default black)
0107   --fillcolor #rrggbb        - set fill color (default transparent)
0108   --opaque                   - make white shapes opaque
0109  SVG options:
0110   --group                    - group related paths together
0111   --flat                     - whole image as a single path
0112  Postscript/EPS/PDF options:
0113   -c, --cleartext            - do not compress the output
0114   -2, --level2               - use postscript level 2 compression (default)
0115   -3, --level3               - use postscript level 3 compression
0116   -q, --longcoding           - do not optimize for file size
0117  PGM options:
0118   -G, --gamma <n>            - gamma value for anti-aliasing (default 2.2)
0119  Frontend options:
0120   -k, --blacklevel <n>       - black/white cutoff in input file (default 0.5)
0121   -i, --invert               - invert bitmap
0122  Progress bar options:
0123   --progress                 - show progress bar
0124   --tty <mode>               - progress bar rendering: vt100 or dumb
0125  
0126  Dimensions can have optional units, e.g. 6.5in, 15cm, 100pt.
0127  Default is inches (or pixels for pgm, dxf, and gimppath backends).
0128  Possible input file formats are: pnm (pbm, pgm, ppm), bmp.
0129  Backends are: svg, pdf, pdfpage, eps, postscript, ps, dxf, geojson, pgm,
0130  gimppath, xfig.
0131 
0132 POTRACE LIBRARY (FOR DEVELOPERS)
0133 
0134  As of Potrace release 1.6, the Potrace core functionality has been
0135  separated into a library libpotrace.a. This makes it easy to integrate
0136  tracing functionality into other GPL programs. The API of the library
0137  is defined in the header file potracelib.h, and is documented in
0138  doc/potracelib.pdf. It is not by default installed, but can be
0139  installed with the --with-libpotrace configuration option.
0140 
0141 DOCUMENTATION
0142 
0143  Usage information is contained in the man page:
0144  http://potrace.sourceforge.net/potrace.html
0145 
0146  Many common questions are answered in the FAQ:
0147  http://potrace.sourceforge.net/faq.html
0148 
0149  Some examples are given on the following web pages:
0150  http://potrace.sourceforge.net/samples.html
0151  http://potrace.sourceforge.net/mkbitmap.html
0152 
0153  The inner workings of the potrace algorithm are explained here:
0154  http://potrace.sourceforge.net/potrace.pdf
0155 
0156  The potrace library is documented here:
0157  http://potrace.sourceforge.net/potracelib.pdf
0158 
0159 COPYRIGHT
0160 
0161  Copyright (C) 2001-2019 Peter Selinger
0162 
0163  The use of the name "Potrace" is governed by a separate policy, see
0164  TRADEMARKS below.
0165 
0166  This program is free software; you can redistribute it and/or modify
0167  it under the terms of the GNU General Public License as published by
0168  the Free Software Foundation; either version 2 of the License, or (at
0169  your option) any later version.
0170 
0171  This program is distributed in the hope that it will be useful, but
0172  WITHOUT ANY WARRANTY; without even the implied warranty of
0173  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0174  General Public License for more details.
0175 
0176  You should have received a copy of the GNU General Public License
0177  along with this program; if not, write to the Free Software Foundation, 
0178  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. 
0179  See also http://www.gnu.org/.
0180 
0181  See the file COPYING for details.
0182 
0183 TRADEMARKS
0184 
0185  "Potrace" is a trademark of Peter Selinger.
0186 
0187  Policy on using the name "Potrace". If you are planning to modify
0188  Potrace, including making a port of Potrace to another programming
0189  language, please be aware of the following. While the source code of
0190  Potrace is licensed under the GNU General Public License, the name
0191  "Potrace" is my trademark, and may only be used with my permission.
0192 
0193  In practice, I will permit the use of the name "Potrace" in
0194  connection with a port of Potrace to another programming language,
0195  provided that the port complies with the term of the GNU General
0196  Public License and produces the same high quality vectorized output
0197  as the original Potrace. Ports that are buggy or do not produce high
0198  quality output are not permitted to use the name "Potrace". To ensure
0199  compliance with this policy, please run your port by me before making
0200  it public. Also, if you use the "Potrace" name (or any derivative,
0201  such as "MyPotrace"), you must provide a name and email address where
0202  I can reach you. Derivatives of Potrace that are posted anonymously
0203  or where the authors cannot be reached or do not reply to email or
0204  bug reports are not permitted to use the name "Potrace".
0205 
0206  The purpose of this policy is to allow people to port Potrace to as
0207  many programming languages as possible, while also ensuring that all
0208  such ports are of the same high quality that has come to be
0209  associated with the name "Potrace".
0210 
0211 GPG KEY
0212 
0213  The key fingerprint of Peter Selinger's GPG key is:
0214  12A2 4B3C 3790 B688 E484  7A98 A68B CC37 CA31 696A
0215  This may be useful for authenticating future versions of Potrace.