diff --git a/inkscape.pod b/inkscape.pod
index a1e56cf9d0c4cc7954f9517510cdfcba944462d1..8a41508119a84d664dddcc609d6e8ffc8dee025d 100644 (file)
--- a/inkscape.pod
+++ b/inkscape.pod
-e, --export-png=FILENAME
-a, --export-area=x0:y0:x1:y1
- -C, --export-area-canvas
+ -C, --export-area-page
-D, --export-area-drawing
--export-area-snap
-i, --export-id=ID
-P, --export-ps=FILENAME
-E, --export-eps=FILENAME
-A, --export-pdf=FILENAME
+ --export-latex
-T, --export-text-to-path
+ --export-ignore-filters
-l, --export-plain-svg=FILENAME
=item B<-a> I<x0:y0:x1:y1>, B<--export-area>=I<x0:y0:x1:y1>
In PNG export, set the exported area in SVG user units (anonymous length units normally used
-in Inkscape SVG). The default is to export the entire document canvas. The point (0,0)
+in Inkscape SVG). The default is to export the entire document page. The point (0,0)
is the lower-left corner.
-=item B<-C>, B<--export-area-canvas>
+=item B<-C>, B<--export-area-page>
-In PNG, PDF, PS, and EPS export, exported area is the canvas (page). This is the default
+In PNG, PDF, PS, and EPS export, exported area is the page. This is the default
for PNG, PDF, and PS, so you don't need to specify this unless you are using --export-id
to export a specific object. In EPS, however, this is not the default; moreover, for EPS,
the specification of the format does not allow its bounding box to extend beyond its content.
-This means that when --export-area-canvas is used with EPS export, the canvas bounding box
+This means that when --export-area-page is used with EPS export, the page bounding box
will be trimmed inwards to the bounding box of the content if it is smaller.
=item B<-D>, B<--export-area-drawing>
-In PNG, PDF, PS, and EPS export, exported area is the drawing (not canvas), i.e. the bounding box
+In PNG, PDF, PS, and EPS export, exported area is the drawing (not page), i.e. the bounding box
of all objects of the document (or of the exported object if --export-id is used).
With this option, the exported image will
display all the visible objects of the document without margins or cropping. This is the default
-export area for EPS. For PNG, it can be used in combination wtih --export-use-hints.
+export area for EPS. For PNG, it can be used in combination with --export-use-hints.
=item B<--export-area-snap>
For PNG export, snap the export area outwards to the nearest integer SVG user unit (px) values. If you are using the
-default export resolution of 90dpi and your graphics are pixel-snapped to minimize antialiasing, this switch
+default export resolution of 90 dpi and your graphics are pixel-snapped to minimize antialiasing, this switch
allows you to preserve this alignment even if you are exporting some object's bounding
box (with --export-id or --export-area-drawing) which is itself not pixel-aligned.
=item B<-d> I<DPI>, B<--export-dpi>=I<DPI>
The resolution used for PNG export.
-The default is 90, which corresponds to 1 SVG user unit
+It is also used for fallback rasterization of filtered objects
+when exporting to PS, EPS, or PDF (unless you specify --export-ignore-filters to suppress
+rasterization). The default is 90 dpi, which corresponds to 1 SVG user unit
(px, also called "user unit") exporting to 1 bitmap pixel.
This value overrides the DPI hint if used with --export-use-hints.
@@ -167,7 +171,7 @@ This value overrides the --export-dpi setting (or the DPI hint if used with --ex
For PNG, PS, EPS, and PDF export, the id attribute value of the object that you want
to export from the document; all other objects are not exported. By
default the exported area is the bounding box of the object; you can override this using
---export-area (PNG only) or --export-area-canvas.
+--export-area (PNG only) or --export-area-page.
=item B<-j>, B<--export-id-only>
=item B<-P> I<FILENAME>, B<--export-ps>=I<FILENAME>
-Export document(s) to PostScript format. Note that PostScript does not support transparency, so any transparent objects in the original SVG will be automatically rasterized. Used fonts are subset and embedded. The default export area is canvas; you can set it to drawing by --export-area-drawing. You can
+Export document(s) to PostScript format. Note that PostScript does not support transparency, so any transparent objects in the original SVG will be automatically rasterized. Used fonts are subset and embedded. The default export area is page; you can set it to drawing by --export-area-drawing. You can
specify --export-id to export a single object (all other are hidden); in that case
-export area is that object's bounding box, but can be set to canvas by --export-area-canvas.
+export area is that object's bounding box, but can be set to page by --export-area-page.
=item B<-E> I<FILENAME>, B<--export-eps>=I<FILENAME>
-Export document(s) to Encapsulated PostScript format. Note that PostScript does not support transparency, so any transparent objects in the original SVG will be automatically rasterized. Used fonts are subset and embedded. The default export area is drawing; you can set it to canvas, however see --export-area-canvas for applicable limitation. You can specify --export-id to export a single object (all other are hidden).
+Export document(s) to Encapsulated PostScript format. Note that PostScript does not support transparency, so any transparent objects in the original SVG will be automatically rasterized. Used fonts are subset and embedded. The default export area is drawing; you can set it to page, however see --export-area-page for applicable limitation. You can specify --export-id to export a single object (all other are hidden).
=item B<-A> I<FILENAME>, B<--export-pdf>=I<FILENAME>
Export document(s) to PDF format. This format preserves the
transparency in the original SVG. Used fonts are subset and embedded.
-The default export area is canvas; you can set it to drawing by --export-area-drawing. You can
+The default export area is page; you can set it to drawing by --export-area-drawing. You can
specify --export-id to export a single object (all other are hidden); in that case
-export area is that object's bounding box, but can be set to canvas by --export-area-canvas.
+export area is that object's bounding box, but can be set to page by --export-area-page.
+
+=item B<--export-latex>
+
+(for PS, EPS, and PDF export)
+Used for creating images for LaTeX documents, where the image's text is typeset by LaTeX.
+When exporting to PDF/PS/EPS format, this option splits the output into a PDF/PS/EPS file
+(e.g. as specified by --export-pdf) and a LaTeX file. Text will not be output in
+the PDF/PS/EPS file, but instead will appear in the LaTeX file. This LaTeX file
+includes the PDF/PS/EPS. Inputting (\input{image.tex}) the LaTeX file in your LaTeX
+document will show the image and all text will be typeset by LaTeX. See the
+resulting LaTeX file for more information.
+Also see GNUPlot's `epslatex' output terminal.
=item B<-T>, B<--export-text-to-path>
-Convert text objects to paths on export, where applicable (currently works for PS, EPS, and PDF export).
+Convert text objects to paths on export, where applicable (for PS, EPS, and PDF export).
+
+=item B<--export-ignore-filters>
+
+Export filtered objects (e.g. those with blur) as vectors, ignoring the filters (for PS, EPS, and PDF export).
+By default, all filtered objects are rasterized at --export-dpi (default 90 dpi), preserving the appearance.
=item B<-I>, B<--query-id>
@@ -275,19 +296,19 @@ return the dimensions of the drawing (i.e. all document objects), not the page o
=item B<-X>, B<--query-x>
-Query the X coordinate of of the drawing or, if specified, of the object with --query-id. The returned value is in px (SVG user units).
+Query the X coordinate of the drawing or, if specified, of the object with --query-id. The returned value is in px (SVG user units).
=item B<-Y>, B<--query-y>
-Query the Y coordinate of of the drawing or, if specified, of the object with --query-id. The returned value is in px (SVG user units).
+Query the Y coordinate of the drawing or, if specified, of the object with --query-id. The returned value is in px (SVG user units).
=item B<-W>, B<--query-width>
-Query the width of of the drawing or, if specified, of the object with --query-id. The returned value is in px (SVG user units).
+Query the width of the drawing or, if specified, of the object with --query-id. The returned value is in px (SVG user units).
=item B<-H>, B<--query-height>
-Query the height of of the drawing or, if specified, of the object with --query-id. The returned value is in px (SVG user units).
+Query the height of the drawing or, if specified, of the object with --query-id. The returned value is in px (SVG user units).
=item B<-S>, B<--query-all>
=head1 CONFIGURATION
-The main configuration file is located in ~/.config/Inkscape/preferences.xml; it stores
+The main configuration file is located in ~/.config/inkscape/preferences.xml; it stores
a variety of customization settings that you can change in Inkscape (mostly in the
Inkscape Preferences dialog). Also in the subdirectories there, you can place your own:
-B<$HOME>/.config/Inkscape/extensions/ - extension effects.
+B<$HOME>/.config/inkscape/extensions/ - extension effects.
-B<$HOME>/.config/Inkscape/icons/ - icons.
+B<$HOME>/.config/inkscape/icons/ - icons.
-B<$HOME>/.config/Inkscape/keys/ - keyboard maps.
+B<$HOME>/.config/inkscape/keys/ - keyboard maps.
-B<$HOME>/.config/Inkscape/templates/ - new file templates.
+B<$HOME>/.config/inkscape/templates/ - new file templates.
=head1 DIAGNOSTICS
=head1 EXAMPLES
While obviously B<Inkscape> is primarily intended as a GUI application,
-it can be used for doing SVG processing on the commandline as well.
+it can be used for doing SVG processing on the command line as well.
Open an SVG file in the GUI:
@@ -379,13 +400,13 @@ the resolution that were used for that object last time when it was exported fro
inkscape filename.svg --export-id=text1555 --export-use-hints
-Same, but use the default 90dpi resolution, specify the filename,
+Same, but use the default 90 dpi resolution, specify the filename,
and snap the exported area outwards to the nearest whole SVG user unit values
-(to preserve pixel-alignment of objects and thus minimize antialiasing):
+(to preserve pixel-alignment of objects and thus minimize aliasing):
- inkscape filename.svg --export-id=text1555 --export-png=text.png --export-snap-area
+ inkscape filename.svg --export-id=text1555 --export-png=text.png --export-area-snap
-Convert an Inkscape SVG document to plain SVG:
+Convert an Inkscape SVG document to plain SVG:
inkscape filename1.svg --export-plain-svg=filename2.svg
To load different icons sets instead of the default
B<$PREFIX>/share/inkscape/icons/icons.svg file, the directory
-B<$HOME>/.inkscape/icons/ is used. Icons are loaded by name
+B<$HOME>/.config/inkscape/icons/ is used. Icons are loaded by name
(e.g. I<fill_none.svg>), or if not found, then from I<icons.svg>. If the
icon is not loaded from either of those locations, it falls back to the
default system location.
Apart from SVG, Inkscape can import (File > Import) most bitmap formats
(PNG, BMP, JPG, XPM, GIF, etc.), plain text (requires Perl), PS and EPS (requires Ghostscript), PDF
-and AI format (AI version 9.0 or newer).
+and AI format (AI version 9.0 or newer).
Inkscape exports 32-bit PNG images (File > Export) as well as AI, PS, EPS, PDF, DXF,
and several other formats via File > Save as.
(http://potrace.sf.net) which is embedded into Inkscape.
Inkscape can use external scripts (stdin-to-stdout filters) that are represented by
-commands in the Effects menu. A script can have a GUI dialog for setting various
+commands in the Extensions menu. A script can have a GUI dialog for setting various
parameters and can get the IDs of the selected objects on which to act via the command
line. Inkscape comes with an assortment of effects written in Python.
=head1 AUTHORS
-This codebase owes its existance to a large number of contributors
+This codebase owes its existence to a large number of contributors
throughout its various incarnations. The following list is certainly
incomplete, but serves to recognize the many shoulders on which this
application sits:
program Gill, the GNOME Illustrator application, created by Raph
Levien. The stated objective for Gill was to eventually support all of
SVG. Raph implemented the PostScript bezier imaging model, including
-stroking and filling, line cap style, line join style, text, etc.
+stroking and filling, line cap style, line join style, text, etc.
Raph's Gill page is at http://www.levien.com/svg/. Work on Gill appears
to have slowed or ceased in 2000.
development opportunities to more participants. The project progressed
rapidly, gaining a number of very active contributors and features.
-Much work in the early days of the project focused on code stablization
+Much work in the early days of the project focused on code stabilization
and internationalization. The original renderer inherited from Sodipodi
was laced with a number of mathematical corner cases which led to
unexpected crashes when the program was pushed beyond routine uses; this
=head1 COPYRIGHT AND LICENSE
-B<Copyright (C)> 1999-2008 by Authors.
+B<Copyright (C)> 1999-2010 by Authors.
B<Inkscape> is free software; you can redistribute it and/or modify it
-under the terms of the GPL.
+under the terms of the GPL.
=for comment