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