inkscape.pod

   1
   2 =head1 NAME
   3
   4 Inkscape - an SVG (Scalable Vector Graphics) editing program.
   5
   6 =head1 SYNOPSIS
   7
   8 C<inkscape [options] [filename ...]>
   9
  10 options:
  11
  12     -?, --help
  13         --usage
  14     -V, --version
  15
  16     -f, --file=FILENAME
  17     -s, --slideshow
  18
  19     -e, --export-png=FILENAME
  20     -a, --export-area=x0:y0:x1:y1
  21     -C, --export-area-canvas
  22     -D, --export-area-drawing
  23         --export-area-snap
  24     -i, --export-id=ID
  25     -j, --export-id-only
  26     -t, --export-use-hints
  27     -b, --export-background=COLOR
  28     -y, --export-background-opacity=VALUE
  29     -d, --export-dpi=DPI
  30     -w, --export-width=WIDTH
  31     -h, --export-height=HEIGHT
  32
  33     -P, --export-ps=FILENAME
  34     -E, --export-eps=FILENAME
  35     -T, --export-text-to-path
  36     -B, --export-bbox-page
  37
  38     -l, --export-plain-svg=FILENAME
  39
  40     -I, --query-id=ID
  41     -X, --query-x
  42     -Y, --query-y
  43     -W, --query-width
  44     -H, --query-height
  45
  46     -x, --extension-directory
  47
  48     -p, --print=PRINTER
  49
  50     -g, --with-gui
  51     -z, --without-gui
  52
  53         --vacuum-defs
  54
  55         --g-fatal-warnings
  56
  57 =head1 DESCRIPTION
  58
  59 B<Inkscape> is a GUI editor for B<Scalable Vector Graphics (SVG)> format
  60 drawing files, with capabilities similar to B<Adobe Illustrator>,
  61 B<CorelDraw>, B<Visio>, etc. Inkscape features include versatile
  62 shapes, bezier paths, freehand drawing, multi-line text, text on path,
  63 alpha blending, arbitrary affine transforms, gradient and pattern fills, node
  64 editing, SVG-to-PNG export, grouping, layers, live clones, and more.  The interface is
  65 designed to be comfortable and efficient for skilled users, while
  66 remaining conformant to B<GNOME> standards so that users familiar with
  67 other GNOME applications can learn its interface rapidly.
  68
  69 B<SVG> is a W3C standard XML format for 2D vector drawing. It allows
  70 defining objects in the drawing using points, paths, and primitive
  71 shapes.  Colors, fonts, stroke width, and so forth are specified as
  72 `style' attributes to these objects.  The intent is that since SVG is a
  73 standard, and since its files are text/xml, it will be
  74 possible to use SVG files in a sizeable number of programs and for a
  75 wide range of uses.
  76
  77 B<Inkscape> uses SVG as its native document format, and has the goal of
  78 becoming the most fully compliant drawing program for SVG files
  79 available in the Open Source community.
  80
  81
  82 =head1 OPTIONS
  83
  84 =over 8
  85
  86 =item B<-?>, B<--help>
  87
  88 Show help message
  89
  90 =item B<-V>, B<--version>
  91
  92 Show Inkscape version and build date.
  93
  94 =item B<-a> I<x0:y0:x1:y1>, B<--export-area>=I<x0:y0:x1:y1>
  95
  96 In PNG export, set the exported area in SVG user units (anonymous length units normally used
  97 in Inkscape SVG).  The default is to export the entire document canvas.  The point (0,0)
  98 is the lower-left corner.
  99
 100 =item B<-C>, B<--export-area-canvas>
 101
 102 In PNG export, exported area is the entire canvas (page). Usually this is the default, so you
 103 don't need to specify this unless you are using --export-id to export a specific object.
 104
 105 =item B<-D>, B<--export-area-drawing>
 106
 107 In PNG export, exported area is the entire drawing (not canvas), i.e. the bounding box
 108 of all objects of the document. With this option, the exported image will
 109 display just the visible objects of the document without margins or cropping. Can be
 110 used in combination wtih --export-use-hints.
 111
 112 =item B<--export-area-snap>
 113
 114 Snap the export area outwards to the nearest integer SVG user unit (px) values. If you are using the
 115 default export resolution of 90dpi and your graphics are pixel-snapped to minimize antialiasing, this switch
 116 allows you to preserve this alignment even if you are exporting some object's bounding
 117 box (with --export-id or --export-area-drawing) which is itself not pixel-aligned.
 118
 119 =item B<-b> I<COLOR>, B<--export-background>=I<COLOR>
 120
 121 Background color of exported PNG.
 122 This may be any SVG supported color string, for example "#ff007f" or "rgb(255, 0, 128)".
 123 If not set,
 124 then the page color set in Inkscape in the Document Options dialog will be used (stored in the pagecolor= attribute of sodipodi:namedview).
 125
 126 =item B<-d> I<DPI>, B<--export-dpi>=I<DPI>
 127
 128 The resolution used for bitmap export.
 129 The default is 90, which corresponds to 1 SVG user unit
 130 (px, also called "user unit") exporting to 1 bitmap pixel.
 131 This value overrides the DPI hint if used with --export-use-hints.
 132
 133 =item B<-e> I<FILENAME>, B<--export-png>=I<FILENAME>
 134
 135 Specify the filename for PNG export.
 136 If it already exists, the file will be overwritten without asking.
 137
 138 =item B<-f> I<FILENAME>, B<--file>=I<FILENAME>
 139
 140 Open specified document(s).
 141 Option string may be omitted, i.e. you can list the filenames without -f.
 142
 143 =item B<-g>, B<--with-gui>
 144
 145 Try to use the GUI (on Unix, use the X server even if $DISPLAY is not set).
 146
 147 =item B<-h> I<HEIGHT>, B<--export-height>=I<HEIGHT>
 148
 149 The height of generated bitmap in pixels.
 150 This value overrides the --export-dpi setting (or the DPI hint if used with --export-use-hints).
 151
 152 =item B<-i> I<ID>, B<--export-id>=I<ID>
 153
 154 The id attribute value of the object that you want to export from the document.  By
 155 default the exported area is the bounding box of the object; you can override this using
 156 --export-area, --export-area-canvas, or --export-area-drawing.
 157
 158 =item B<-j>, B<--export-id-only>
 159
 160 Only export the object whose id is given in --export-id. All other objects are hidden and won't
 161 show in export even if they overlay the exported object. Without --export-id, this option is ignored.
 162
 163 =item B<-l>, B<--export-plain-svg>=I<FILENAME>
 164
 165 Export document(s) to plain SVG format, without sodipodi: or inkscape: namespaces and without RDF metadata.
 166
 167 =item B<-l>, B<--extension-directory>
 168
 169 Lists the current extension directory that Inkscape is configured to use and
 170 then exits.  This is used for external extension to use the same configuration
 171 as the original Inkscape installation.
 172
 173 =item B<-p> I<PRINTER>, B<--print>=I<PRINTER>
 174
 175 Print document(s) to the specified printer using `lpr -P PRINTER'.
 176 Alternatively, use `| COMMAND' to specify a different command to pipe to,
 177 or use `> FILENAME' to write the PostScript output to a file instead of printing.
 178 Remember to do appropriate quoting for your shell, e.g.
 179
 180 inkscape --print='| ps2pdf - mydoc.pdf' mydoc.svg
 181
 182 =item B<-s>, B<--slideshow>
 183
 184 Show given files one by one, switching to the next one by any key or mouse event.
 185
 186 =item B<-t>, B<--export-use-hints>
 187
 188 Use export filename and DPI hints stored in the exported object (only with --export-id).
 189 These hints are set automatically when you export selection from within Inkscape.
 190 So, for example, if you export a shape with id="path231" as /home/me/shape.png at 300 dpi from document.svg using Inkscape GUI, and save the document,
 191 then later you will be able to reexport that shape to the same file with the same resolution simply with
 192
 193 inkscape -i path231 -t document.svg
 194
 195 If you use --export-dpi, --export-width, or --export-height with this option,
 196 then the DPI hint will be ignored and the value from the command line will be used.
 197 If you use --export-png with this option,
 198 then the filename hint will be ignored and the filename from the command line will be used.
 199
 200 =item B<-w> I<WIDTH>, B<--export-width>=I<WIDTH>
 201
 202 The width of generated bitmap in pixels.
 203 This value overrides the --export-dpi setting (or the DPI hint if used with --export-use-hints).
 204
 205 =item B<-y> I<VALUE>, B<--export-background-opacity>=I<VALUE>
 206
 207 Opacity of the background of exported PNG.
 208 This may be a value either between 0.0 and 1.0 (0.0 meaning full transparency, 1.0 full opacity)
 209 or greater than 1 up to 255 (255 meaning full opacity).
 210 If not set and the -b option is not used,
 211 then the page opacity set in Inkscape in the Document Options dialog will be used (stored in the inkscape:pageopacity= attribute of sodipodi:namedview).
 212 If not set but the -b option is used,
 213 then the value of 255 (full opacity) will be used.
 214
 215 =item B<-P> I<FILENAME>, B<--export-ps>=I<FILENAME>
 216
 217 Export document(s) to PostScript format.
 218
 219 =item B<-E> I<FILENAME>, B<--export-eps>=I<FILENAME>
 220
 221 Export document(s) to Encapsulated PostScript format.
 222
 223 =item B<-T>, B<--export-text-to-path>
 224
 225 Convert text objects to paths on export, where applicable (currently works with EPS only).
 226
 227 =item B<-B>, B<--export-bbox-page>
 228
 229 Export files with the bounding box set to the page size, where applicable (currently works with EPS only).
 230
 231 =item B<-I>, B<--query-id>
 232
 233 Set the ID of the object whose dimensions are queried. If not set, query options will
 234 return the dimensions of the drawing (i.e. all document objects), not the page or viewbox
 235
 236 =item B<-X>, B<--query-x>
 237
 238 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).
 239
 240 =item B<-Y>, B<--query-y>
 241
 242 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).
 243
 244 =item B<-W>, B<--query-width>
 245
 246 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).
 247
 248 =item B<-H>, B<--query-height>
 249
 250 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).
 251
 252 =item B<--vacuum-defs>
 253
 254 Remove all unused items from the <lt>defs<gt> section of the SVG file.  If this
 255 option is invoked in conjunction with --export-plain-svg, only the exported file
 256 will be affected.  If it is used alone, the specified file will be modified in place.
 257
 258 =item B<-z>, B<--without-gui>
 259
 260 Do not open the GUI (on Unix, do not use X server); only process the files from console.
 261 This is assumed for -p, -e, -l, and --vacuum-defs options.
 262
 263 =item B<--g-fatal-warnings>
 264
 265 Part of the standard GTK option that are recognized.  This forces any GTK
 266 warnings to cause Inkscape to abort.  This option is listed because it gets
 267 used for debugging.
 268
 269 =item B<--usage>
 270
 271 Display a brief usage message.
 272
 273 =back
 274
 275 =head1 CONFIGURATION
 276
 277 The preferences.xml configuration file located in ~/.inkscape/ is used
 278 to customize the application settings for the user.
 279
 280 =over 8
 281
 282 =item B<interface>
 283
 284 The B<interface> element(s) of the config file is used to set parameters
 285 related to the GUI interface, such as the open/closed status of various
 286 GUI elements, etc.
 287
 288 =item B<group id="documents">
 289
 290 The documents group is used for containing the recent files list.  Each
 291 document is listed with its uri (path) and name indicated.
 292
 293 =item B<group id="template">
 294
 295 The template group is used for storing parameters related to blank
 296 documents.
 297
 298 =item B<group id="tools">
 299
 300 The tools group is used for storing the user style preferences for
 301 different event contexts (i.e., shapes, freehand or calligraphic stroke
 302 properties, etc.).
 303
 304 =item B<group id="palette">
 305
 306 The palette group allows setting of dash styles.  This allows you to
 307 define the stroke lengths for different kinds of dashes.
 308
 309 =item B<group id="dialogs">
 310
 311 The dialogs group allows persisting the position and width of each of
 312 the dialogs in the application, so that they'll start up in the last
 313 place the user had them at the next time the app is run.
 314
 315 =item B<group id="printing">
 316
 317 The printing group is for storing different printer settings.  Each
 318 setting is identified with an id.  Properties include I<bitmap>
 319 (true/false), I<resolution>, and I<destination>.
 320
 321 =item B<group id="options">
 322
 323 The options group allows persisting various user selected options
 324 including I<nudgeddistance>, I<rotationstep>, I<cursortolerance>, and
 325 I<dragtolerance>.
 326
 327 =back
 328
 329 =head1 DIAGNOSTICS
 330
 331 The program returns zero on success or non-zero on failure.
 332
 333 A variety of error messages and warnings are printed to STDERR or
 334 STDOUT.  If the program behaves erratically with a particular SVG file
 335 or crashes, it is sometimes useful to look at this output for clues.
 336
 337 =head1 EXAMPLES
 338
 339 While obviously B<Inkscape> is primarily intended as a GUI application,
 340 it can be used for doing SVG processing on the commandline as well.
 341
 342 Print an SVG file:
 343
 344     inkscape filename.svg -p '| lpr'
 345
 346 Export an SVG file into PNG with the default resolution of 90dpi (one SVG user unit translates to one bitmap pixel):
 347
 348     inkscape filename.svg --export-png=filename.png
 349
 350 Same, but force the PNG file to be 600x400 pixels:
 351
 352     inkscape filename.svg --export-png=filename.png -w600 -h400
 353
 354 Same, but export the drawing (bounding box of all objects), not the page:
 355
 356     inkscape filename.svg --export-png=filename.png --export-area-drawing
 357
 358 Export to PNG the object with id="text1555", using the output filename and
 359 the resolution that were used for that object last time when it was exported from the GUI:
 360
 361     inkscape filename.svg --export-id=text1555 --export-use-hints
 362
 363 Same, but use the default 90dpi resolution, specify the filename,
 364 and snap the exported area outwards to the nearest whole SVG user unit values
 365 (to preserve pixel-alignment of objects and thus minimize antialiasing):
 366
 367     inkscape filename.svg --export-id=text1555 --export-png=text.png --export-snap-area
 368
 369 Convert an Inkscape SVG document to plain SVG:
 370
 371     inkscape filename1.svg --export-plain-svg=filename2.svg
 372
 373 Convert an SVG document to EPS, converting all texts to paths:
 374
 375     inkscape filename.svg --export-eps=filename.eps --export-text-to-path
 376
 377 Query the width of the object with id="text1555":
 378
 379     inkscape filename.svg --query-width --query-id text1555
 380
 381
 382 =head1 ENVIRONMENT
 383
 384 B<DISPLAY> to get the default host and display number.
 385
 386 B<TMPDIR> to set the default path of the directory to use for temporary
 387 files.  The directory must exist.
 388
 389 =head1 THEMES
 390
 391 To load different icons sets instead of the default
 392 B<$PREFIX>/share/inkscape/icons/icons.svg file, the directory
 393 B<$HOME>/.inkscape/icons/ is used.  Icons are loaded by name
 394 (e.g. I<fill_none.svg>), or if not found, then from I<icons.svg>.  If the
 395 icon is not loaded from either of those locations, it falls back to the
 396 default system location.
 397
 398 The needed icons are loaded from SVG files by searching for the SVG id with
 399 the matching icon name.  (For example, to load the "fill_none" icon from
 400 a file, the bounding box seen for SVG id "fill_none" is rendered as the
 401 icon, whether it comes from I<fill_none.svg> or I<icons.svg>.)
 402
 403 =head1 FILES
 404
 405 B<$HOME>/.inkscape/preferences.xml - The user's preference settings.
 406
 407 B<$HOME>/.inkscape/extensions.xml - The filter programs to be used in
 408 the application.
 409
 410 B<$HOME>/.inkscape/icons/{*,icons}.svg - Icons to overload for themes.
 411
 412 =head1 OTHER INFO
 413
 414 The canonical place to find B<Inkscape> info is at
 415 http://www.inkscape.org/.  The website includes links to other relevant
 416 documentation, tutorials, user manual, examples, mailing list archives,
 417 the latest released version of the program, and more.
 418
 419 =head1 SEE ALSO
 420
 421 gimp(1), autotrace, potrace, frontline, ill2svg, rsvg(1), xfig(1), sodipodi,
 422 karbon14, dia(1X), batik.
 423
 424 SVG compliance test suite:  http://www.w3.org/Graphics/SVG/Test/
 425
 426 SVG validator:  http://jiggles.w3.org/svgvalidator/
 427
 428 I<Scalable Vector Graphics (SVG) 1.1 Specification>
 429 I<W3C Recommendation 14 January 2003>
 430 L<http://www.w3.org/TR/SVG11/>
 431
 432 I<Scalable Vector Graphics (SVG) 1.2 Specification>
 433 I<W3C Working Draft 13 November 2003>
 434 L<http://www.w3.org/TR/SVG12/>
 435
 436 I<SVG 1.1/1.2/2.0 Requirements>
 437 I<W3C Working Draft 22 April 2002>
 438 L<http://www.w3.org/TR/SVG2Reqs/>
 439
 440 I<Document Object Model (DOM): Level 2 Core>
 441 I<Arnaud Le Hors et al editors, W3C>
 442 L<http://www.w3.org/TR/DOM-Level-2-Core/>
 443
 444
 445 =head1 GUI NOTES
 446
 447 To learn Inkscape's GUI operation, read the tutorials in Help > Tutorials.
 448
 449 Inkscape can import (File > Import) most bitmap formats (PNG, BMP, JPG, XPM, GIF etc.),
 450 plain text (requires Perl), and AI format (Adobe Illustrator documents, versions up to 7 only;
 451 requires Perl).
 452
 453 Inkscape exports 32-bit PNG images (File > Export) as well as AI, PS, EPS, PDF (requires
 454 Ghostscript), DXF and several other formats via File > Save as.
 455
 456 Inkscape can use the pressure and tilt of a graphic tablet pen for width and angle of
 457 the Calligraphic tool.
 458
 459 Inkscape includes a GUI front-end to the Potrace bitmap tracing engine
 460 (http://potrace.sf.net) which is embedded into Inkscape.
 461
 462 Inkscape can use external scripts (stdin-to-stdout filters) that are represented by
 463 commands in the Effects menu. A script can have a GUI dialog for setting various
 464 parameters and can get the IDs of the selected objects on which to act via the command
 465 line. Inkscape comes with an assortment of effects written in Python, mostly for path
 466 manipulation.
 467
 468 =head1 KEYBINDINGS
 469
 470 To get a complete list of keyboard and mouse shortcuts, view doc/keys.html, or use the Keys and Mouse command in Help menu from the GUI to see an SVG chart.
 471
 472 =head1 BUGS
 473
 474 Many bugs are known; please refer to the website (inkscape.org) for reviewing the reported ones and to
 475 report newly found issues.  See also the Known Issues section in the Release Notes for
 476 your version (file `NEWS').
 477
 478 =head1 AUTHORS
 479
 480 This codebase owes its existance to a large number of contributors
 481 throughout its various incarnations.  The following list is certainly
 482 incomplete, but serves to recognize the many shoulders on which this
 483 application sits:
 484
 485 [% INCLUDE "AUTHORS" %]
 486
 487 This man page was put together by Bryce Harrington
 488 E<lt>brycehar@bryceharrington.comE<gt>.
 489
 490 =head1 HISTORY
 491
 492 The codebase that would become Inkscape began life in 1999 as the
 493 program Gill, the GNOME Illustrator application, created by Raph
 494 Levien.  The stated objective for Gill was to eventually support all of
 495 SVG.  Raph implemented the PostScript bezier imaging model, including
 496 stroking and filling, line cap style, line join style, text, etc.
 497 Raph's Gill page is at http://www.levien.com/svg/.  Work on Gill appears
 498 to have slowed or ceased in 2000.
 499
 500 The next incarnation of the codebase was to become the highly popular
 501 program Sodipodi, led by Lauris Kaplinski.  The codebase was turned
 502 into a powerful illustration program over the course of several
 503 year's work, adding several new features, multi-lingual support, porting
 504 to Windows and other operating systems, and eliminating dependencies.
 505
 506 Inkscape was formed in 2003 by four active Sodipodi developers, Bryce
 507 Harrington, MenTaLguY, Nathan Hurst, and Ted Gould, wanting to take a
 508 different direction with the codebase in terms of focus on
 509 SVG compliance, interface look-and-feel, and a desire to open
 510 development opportunities to more participants.
 511
 512 =head1 COPYRIGHT AND LICENSE
 513
 514 B<Copyright (C)> 1999-2005 by Authors.
 515
 516 B<Inkscape> is free software; you can redistribute it and/or modify it
 517 under the terms of the GPL.
 518
 519
 520 =for comment
 521 $Date$