Code

Display CMS adjustment per-desktop view
[inkscape.git] / inkscape.pod
index 5b23dfd9b29bed95ee9109ee3fd9df74156e7538..66da34d4c626b5f682a2d3ea32b5641180394b7f 100644 (file)
@@ -9,12 +9,11 @@ C<inkscape [options] [filename ...]>
 
 options:
 
-    -?, --help         
+    -?, --help        
         --usage       
     -V, --version
 
     -f, --file=FILENAME               
-    -s, --slideshow                   
 
     -e, --export-png=FILENAME         
     -a, --export-area=x0:y0:x1:y1     
@@ -48,6 +47,10 @@ options:
 
     -x, --extension-directory
 
+        --verb-list
+        --verb=VERB-ID
+        --select=OBJECT-ID
+
     -p, --print=PRINTER
 
     -g, --with-gui                    
@@ -167,12 +170,35 @@ show in export even if they overlay the exported object. Without --export-id, th
 
 Export document(s) to plain SVG format, without sodipodi: or inkscape: namespaces and without RDF metadata.
 
-=item B<-l>, B<--extension-directory>
+=item B<-x>, B<--extension-directory>
 
 Lists the current extension directory that Inkscape is configured to use and
 then exits.  This is used for external extension to use the same configuration
 as the original Inkscape installation.
 
+=item B<--verb-list>
+
+Lists all the verbs that are available in Inkscape by ID.  This ID can be
+used in defining keymaps or menus.  It can also be used with the --verb
+command line option.
+
+=item B<--verb>=I<VERB-ID>, B<--select>=I<OBJECT-ID>
+
+These two options work together to provide some basic scripting for
+Inkscape from the command line.  They both can occur as many times as
+needed on the command line and are executed in order on every document that
+is specified.
+
+The --verb command will execute a specific verb as if it
+was called from a menu or button.  Dialogs will appear if that is part
+of the verb.  To get a list of the verb IDs available, use the --verb-list
+command line option.
+
+The --select command will cause objects that have the ID
+specified to be selected.  This allows various verbs to act upon them.  To
+remove all the selections use --verb=EditDeselect.  The object IDs
+available are dependent on the document specified to load.
+
 =item B<-p> I<PRINTER>, B<--print>=I<PRINTER>
 
 Print document(s) to the specified printer using `lpr -P PRINTER'.
@@ -182,10 +208,6 @@ Remember to do appropriate quoting for your shell, e.g.
 
 inkscape --print='| ps2pdf - mydoc.pdf' mydoc.svg
 
-=item B<-s>, B<--slideshow>
-
-Show given files one by one, switching to the next one by any key or mouse event.
-
 =item B<-t>, B<--export-use-hints>
 
 Use export filename and DPI hints stored in the exported object (only with --export-id).
@@ -332,7 +354,7 @@ setting is identified with an id.  Properties include I<bitmap>
 =item B<group id="options">
 
 The options group allows persisting various user selected options
-including I<nudgeddistance>, I<rotationstep>, I<cursortolerance>, and
+including I<nudgedistance>, I<rotationstep>, I<cursortolerance>, and
 I<dragtolerance>. 
 
 =back
@@ -341,16 +363,20 @@ I<dragtolerance>.
 
 The program returns zero on success or non-zero on failure.
 
-A variety of error messages and warnings are printed to STDERR or
+A variety of error messages and warnings may be printed to STDERR or
 STDOUT.  If the program behaves erratically with a particular SVG file
-or crashes, it is sometimes useful to look at this output for clues.
+or crashes, it is useful to look at this output for clues.
 
 =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.
 
-Print an SVG file:
+Open an SVG file in the GUI:
+
+    inkscape filename.svg
+
+Print an SVG file from the command line:
 
     inkscape filename.svg -p '| lpr'
 
@@ -389,6 +415,10 @@ Query the width of the object with id="text1555":
 
     inkscape filename.svg --query-width --query-id text1555
 
+Duplicate the object with id="path1555", rotate the duplicate 90 degrees, save SVG, and quit:
+
+    inkscape filename.svg --select=path1555 --verb=EditDuplicate --verb=ObjectRotate90 --verb=FileSave --verb=FileClose
+
 
 =head1 ENVIRONMENT
 
@@ -415,22 +445,26 @@ icon, whether it comes from I<fill_none.svg> or I<icons.svg>.)
 
 B<$HOME>/.inkscape/preferences.xml - The user's preference settings. 
 
-B<$HOME>/.inkscape/extensions.xml - The filter programs to be used in
-the application.
+B<$HOME>/.inkscape/extensions/ - Directory with user's extension effects.
+
+B<$HOME>/.inkscape/icons/ - Directory with user's icons.
+
+B<$HOME>/.inkscape/keys/ - Directory with user's keyboard maps.
+
+B<$HOME>/.inkscape/templates/ - Directory with user's new file templates.
 
-B<$HOME>/.inkscape/icons/{*,icons}.svg - Icons to overload for themes.
 
 =head1 OTHER INFO
 
 The canonical place to find B<Inkscape> info is at
-http://www.inkscape.org/.  The website includes links to other relevant
-documentation, tutorials, user manual, examples, mailing list archives,
-the latest released version of the program, and more. 
+http://www.inkscape.org/.  The website has news, documentation,
+tutorials, examples, mailing list archives, the latest released
+version of the program, bugs and feature requests databases, forums,
+and more.
 
 =head1 SEE ALSO
 
-gimp(1), autotrace, potrace, frontline, ill2svg, rsvg(1), xfig(1), sodipodi,
-karbon14, dia(1X), batik.
+potrace, cairo, rsvg(1), batik, ghostscript, pstoedit.
 
 SVG compliance test suite:  http://www.w3.org/Graphics/SVG/Test/
 
@@ -457,15 +491,15 @@ L<http://www.w3.org/TR/DOM-Level-2-Core/>
 
 To learn Inkscape's GUI operation, read the tutorials in Help > Tutorials.
 
-Inkscape can import (File > Import) most bitmap formats (PNG, BMP, JPG, XPM, GIF etc.),
-plain text (requires Perl), and AI format (Adobe Illustrator documents, versions up to 7 only;
-requires Perl). 
+Apart from SVG, Inkscape can import (File > Import) most bitmap formats 
+(PNG, BMP, JPG, XPM, GIF, etc.), plain text (requires Perl), PDF, 
+and AI format (AI version 9.0 or newer). 
 
-Inkscape exports 32-bit PNG images (File > Export) as well as AI, PS, EPS, PDF (requires
-Ghostscript), DXF and several other formats via File > Save as.
+Inkscape exports 32-bit PNG images (File > Export) as well as AI, PS, EPS, PDF, DXF, 
+and several other formats via File > Save as.
 
-Inkscape can use the pressure and tilt of a graphic tablet pen for width and angle of
-the Calligraphic tool.
+Inkscape can use the pressure and tilt of a graphic tablet pen for width, angle,
+and force of action of several tools, including the Calligraphic pen.
 
 Inkscape includes a GUI front-end to the Potrace bitmap tracing engine
 (http://potrace.sf.net) which is embedded into Inkscape.
@@ -473,12 +507,11 @@ Inkscape includes a GUI front-end to the Potrace bitmap tracing engine
 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
 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, mostly for path
-manipulation.
+line. Inkscape comes with an assortment of effects written in Python.
 
 =head1 KEYBINDINGS
 
-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.
+To get a complete list of keyboard and mouse shortcuts, view doc/keys.html, or use the Keys and Mouse command in Help menu.
 
 =head1 BUGS
 
@@ -522,7 +555,7 @@ development opportunities to more participants.
 
 =head1 COPYRIGHT AND LICENSE
 
-B<Copyright (C)> 1999-2005 by Authors.  
+B<Copyright (C)> 1999-2007 by Authors.  
 
 B<Inkscape> is free software; you can redistribute it and/or modify it
 under the terms of the GPL.