Code

These files were separated out from filedialog.cpp and filedialog.h, so to facilitate...
[inkscape.git] / inkscape.pod
index 429b598170f6b72d105caf54c718ea82fe231cc9..33c89a2b4d72c759316cfecde69795ee1905ec10 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     
@@ -32,8 +31,11 @@ options:
 
     -P, --export-ps=FILENAME
     -E, --export-eps=FILENAME
+    -A, --export-pdf=FILENAME
+
     -T, --export-text-to-path
     -B, --export-bbox-page 
+    -F, --export-embed-fonts
 
     -l, --export-plain-svg=FILENAME             
 
@@ -44,6 +46,10 @@ options:
     -H, --query-height
 
     -x, --extension-directory
+        --verb-list
+
+        --verb=VERB-ID
+        --select=OBJECT-ID
 
     -p, --print=PRINTER
 
@@ -99,7 +105,8 @@ is the lower-left corner.
 
 =item B<-C>, B<--export-area-canvas>
 
-In PNG export, exported area is the entire canvas.
+In PNG export, exported area is the entire canvas (page). Usually this is the default, so you
+don't need to specify this unless you are using --export-id to export a specific object.
 
 =item B<-D>, B<--export-area-drawing>
 
@@ -150,8 +157,9 @@ This value overrides the --export-dpi setting (or the DPI hint if used with --ex
 
 =item B<-i> I<ID>, B<--export-id>=I<ID>
 
-The id attribute value of the object that you want to export from the document.
-By default the exported area is the bounding box of the object. 
+The id attribute value of the object that you want to export from the document.  By
+default the exported area is the bounding box of the object; you can override this using
+--export-area, --export-area-canvas, or --export-area-drawing.
 
 =item B<-j>, B<--export-id-only>
 
@@ -162,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 like 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'.
@@ -177,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).
@@ -212,19 +239,27 @@ then the value of 255 (full opacity) will be used.
 
 =item B<-P> I<FILENAME>, B<--export-ps>=I<FILENAME>
 
-Export document(s) to PostScript format.
+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.
 
 =item B<-E> I<FILENAME>, B<--export-eps>=I<FILENAME>
 
-Export document(s) to Encapsulated PostScript format.
+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.
+
+=item B<-A> I<FILENAME>, B<--export-pdf>=I<FILENAME>
+
+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).
 
 =item B<-T>, B<--export-text-to-path>
 
-Convert text objects to paths on export, where applicable (currently works with EPS only).
+Convert text objects to paths on export, where applicable (currently works for PS, EPS, and PDF export).
 
 =item B<-B>, B<--export-bbox-page>
 
-Export files with the bounding box set to the page size, where applicable (currently works with EPS only).
+Export files with the bounding box set to the page size, where applicable (currently works for PS and EPS export).
+
+=item B<-F>, B<--export-embed-fonts>
+
+Embed fonts used in the document into exported PS/EPS file. Note: only Type 1 fonts can be embedded, not TrueType.
 
 =item B<-I>, B<--query-id>