360
by bryce
Rewriting manpage from scratch |
1 |
=head1 NAME |
2 |
||
3 |
Inkscape - an SVG (Scalable Vector Graphics) editing program. |
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
4 |
|
360
by bryce
Rewriting manpage from scratch |
5 |
=head1 SYNOPSIS |
6 |
||
7 |
C<inkscape [options] [filename ...]> |
|
8 |
||
9 |
options: |
|
10 |
||
11 |
-?, --help |
|
11415
by gouldtj
r14942@tres: ted | 2007-03-20 23:50:23 -0700 |
12 |
--usage |
4004
by buliabyak
new options and many edits in the man page |
13 |
-V, --version |
5161
by nemies
Adding --version to pod docs |
14 |
|
4004
by buliabyak
new options and many edits in the man page |
15 |
-f, --file=FILENAME |
16 |
||
17 |
-e, --export-png=FILENAME |
|
18 |
-a, --export-area=x0:y0:x1:y1 |
|
360
by bryce
Rewriting manpage from scratch |
19 |
-C, --export-area-canvas |
8990
by acspike
Added --export-area-canvas (-C). |
20 |
-D, --export-area-drawing |
6607
by buliabyak
--export-area-drawing |
21 |
--export-area-snap |
7966
by buliabyak
remove obsolete info, add more examples |
22 |
-i, --export-id=ID |
4004
by buliabyak
new options and many edits in the man page |
23 |
-j, --export-id-only |
4292
by buliabyak
added --export-id-only to export only the specified object and hide all others |
24 |
-t, --export-use-hints |
4004
by buliabyak
new options and many edits in the man page |
25 |
-b, --export-background=COLOR |
360
by bryce
Rewriting manpage from scratch |
26 |
-y, --export-background-opacity=VALUE |
4004
by buliabyak
new options and many edits in the man page |
27 |
-d, --export-dpi=DPI |
360
by bryce
Rewriting manpage from scratch |
28 |
-w, --export-width=WIDTH |
4004
by buliabyak
new options and many edits in the man page |
29 |
-h, --export-height=HEIGHT |
360
by bryce
Rewriting manpage from scratch |
30 |
|
6600
by buliabyak
more query options, man update |
31 |
-P, --export-ps=FILENAME |
6592
by cth103
Update for new PS/EPS export features. |
32 |
-E, --export-eps=FILENAME |
33 |
-A, --export-pdf=FILENAME |
|
9997
by buliabyak
pdf export from commandline |
34 |
|
35 |
-T, --export-text-to-path |
|
6592
by cth103
Update for new PS/EPS export features. |
36 |
-B, --export-bbox-page |
37 |
-F, --export-embed-fonts |
|
10982
by buliabyak
man page update for 0.45 |
38 |
|
4004
by buliabyak
new options and many edits in the man page |
39 |
-l, --export-plain-svg=FILENAME |
40 |
||
41 |
-I, --query-id=ID |
|
6600
by buliabyak
more query options, man update |
42 |
-X, --query-x |
43 |
-Y, --query-y |
|
44 |
-W, --query-width |
|
45 |
-H, --query-height |
|
46 |
-S, --query-all |
|
13034
by bryce
Man page entry for --query-all option |
47 |
|
6600
by buliabyak
more query options, man update |
48 |
-x, --extension-directory |
6553
by gouldtj
Adding documentation for the --extension-directory command line arguement. |
49 |
|
12388
by buliabyak
various updates |
50 |
--verb-list |
11415
by gouldtj
r14942@tres: ted | 2007-03-20 23:50:23 -0700 |
51 |
--verb=VERB-ID |
52 |
--select=OBJECT-ID |
|
53 |
||
6553
by gouldtj
Adding documentation for the --extension-directory command line arguement. |
54 |
-p, --print=PRINTER |
4004
by buliabyak
new options and many edits in the man page |
55 |
|
56 |
-g, --with-gui |
|
57 |
-z, --without-gui |
|
360
by bryce
Rewriting manpage from scratch |
58 |
|
59 |
--vacuum-defs |
|
7089
by buliabyak
vacuum defs to work without GUI and without --export-plain-svg |
60 |
|
61 |
--g-fatal-warnings |
|
5556
by nemies
Documenting theme support, as it is... |
62 |
|
63 |
=head1 DESCRIPTION |
|
360
by bryce
Rewriting manpage from scratch |
64 |
|
65 |
B<Inkscape> is a GUI editor for B<Scalable Vector Graphics (SVG)> format |
|
66 |
drawing files, with capabilities similar to B<Adobe Illustrator>, |
|
388
by bryce
Incorporating Alan's suggestions |
67 |
B<CorelDraw>, B<Visio>, etc. Inkscape features include versatile |
4004
by buliabyak
new options and many edits in the man page |
68 |
shapes, bezier paths, freehand drawing, multi-line text, text on path, |
5502
by buliabyak
default dpi 90 on commandline export |
69 |
alpha blending, arbitrary affine transforms, gradient and pattern fills, node |
70 |
editing, SVG-to-PNG export, grouping, layers, live clones, and more. The interface is |
|
71 |
designed to be comfortable and efficient for skilled users, while |
|
388
by bryce
Incorporating Alan's suggestions |
72 |
remaining conformant to B<GNOME> standards so that users familiar with |
73 |
other GNOME applications can learn its interface rapidly. |
|
1890
by bryce
Adding a work-around for bug [ 850924 ] problem with gradients |
74 |
|
360
by bryce
Rewriting manpage from scratch |
75 |
B<SVG> is a W3C standard XML format for 2D vector drawing. It allows |
4004
by buliabyak
new options and many edits in the man page |
76 |
defining objects in the drawing using points, paths, and primitive |
360
by bryce
Rewriting manpage from scratch |
77 |
shapes. Colors, fonts, stroke width, and so forth are specified as |
4004
by buliabyak
new options and many edits in the man page |
78 |
`style' attributes to these objects. The intent is that since SVG is a |
79 |
standard, and since its files are text/xml, it will be
|
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
80 |
possible to use SVG files in a sizeable number of programs and for a
|
360
by bryce
Rewriting manpage from scratch |
81 |
wide range of uses.
|
82 |
||
83 |
B<Inkscape> uses SVG as its native document format, and has the goal of
|
|
84 |
becoming the most fully compliant drawing program for SVG files
|
|
85 |
available in the Open Source community.
|
|
86 |
||
87 |
||
88 |
=head1 OPTIONS
|
|
89 |
||
90 |
=over 8
|
|
91 |
||
92 |
=item B<-?>, B<--help>
|
|
93 |
||
94 |
Show help message
|
|
95 |
||
96 |
=item B<-V>, B<--version>
|
|
5161
by nemies
Adding --version to pod docs |
97 |
|
98 |
Show Inkscape version and build date.
|
|
99 |
||
100 |
=item B<-a> I<x0:y0:x1:y1>, B<--export-area>=I<x0:y0:x1:y1>
|
|
360
by bryce
Rewriting manpage from scratch |
101 |
|
102 |
In PNG export, set the exported area in SVG user units (anonymous length units normally used
|
|
7966
by buliabyak
remove obsolete info, add more examples |
103 |
in Inkscape SVG). The default is to export the entire document canvas. The point (0,0)
|
6607
by buliabyak
--export-area-drawing |
104 |
is the lower-left corner.
|
105 |
||
106 |
=item B<-C>, B<--export-area-canvas>
|
|
8990
by acspike
Added --export-area-canvas (-C). |
107 |
|
108 |
In PNG export, exported area is the entire canvas (page). Usually this is the default, so you
|
|
8991
by buliabyak
better explanation of --export-area-canvas |
109 |
don't need to specify this unless you are using --export-id to export a specific object. |
110 |
||
8990
by acspike
Added --export-area-canvas (-C). |
111 |
=item B<-D>, B<--export-area-drawing> |
6607
by buliabyak
--export-area-drawing |
112 |
|
113 |
In PNG export, exported area is the entire drawing (not canvas), i.e. the bounding box |
|
7966
by buliabyak
remove obsolete info, add more examples |
114 |
of all objects of the document. With this option, the exported image will |
115 |
display just the visible objects of the document without margins or cropping. Can be |
|
116 |
used in combination wtih --export-use-hints. |
|
117 |
||
118 |
=item B<--export-area-snap> |
|
119 |
||
120 |
Snap the export area outwards to the nearest integer SVG user unit (px) values. If you are using the |
|
121 |
default export resolution of 90dpi and your graphics are pixel-snapped to minimize antialiasing, this switch |
|
122 |
allows you to preserve this alignment even if you are exporting some object's bounding |
|
123 |
box (with --export-id or --export-area-drawing) which is itself not pixel-aligned.
|
|
124 |
||
360
by bryce
Rewriting manpage from scratch |
125 |
=item B<-b> I<COLOR>, B<--export-background>=I<COLOR>
|
126 |
||
127 |
Background color of exported PNG.
|
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
128 |
This may be any SVG supported color string, for example "#ff007f" or "rgb(255, 0, 128)".
|
129 |
If not set,
|
|
130 |
then the page color set in Inkscape in the Document Options dialog will be used (stored in the pagecolor= attribute of sodipodi:namedview).
|
|
131 |
||
360
by bryce
Rewriting manpage from scratch |
132 |
=item B<-d> I<DPI>, B<--export-dpi>=I<DPI>
|
133 |
||
134 |
The resolution used for bitmap export.
|
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
135 |
The default is 90, which corresponds to 1 SVG user unit
|
7966
by buliabyak
remove obsolete info, add more examples |
136 |
(px, also called "user unit") exporting to 1 bitmap pixel.
|
5502
by buliabyak
default dpi 90 on commandline export |
137 |
This value overrides the DPI hint if used with --export-use-hints.
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
138 |
|
360
by bryce
Rewriting manpage from scratch |
139 |
=item B<-e> I<FILENAME>, B<--export-png>=I<FILENAME>
|
140 |
||
141 |
Specify the filename for PNG export.
|
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
142 |
If it already exists, the file will be overwritten without asking.
|
143 |
||
360
by bryce
Rewriting manpage from scratch |
144 |
=item B<-f> I<FILENAME>, B<--file>=I<FILENAME>
|
145 |
||
146 |
Open specified document(s).
|
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
147 |
Option string may be omitted, i.e. you can list the filenames without -f.
|
148 |
||
4004
by buliabyak
new options and many edits in the man page |
149 |
=item B<-g>, B<--with-gui>
|
150 |
||
151 |
Try to use the GUI (on Unix, use the X server even if $DISPLAY is not set).
|
|
152 |
||
360
by bryce
Rewriting manpage from scratch |
153 |
=item B<-h> I<HEIGHT>, B<--export-height>=I<HEIGHT>
|
154 |
||
155 |
The height of generated bitmap in pixels.
|
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
156 |
This value overrides the --export-dpi setting (or the DPI hint if used with --export-use-hints).
|
157 |
||
4004
by buliabyak
new options and many edits in the man page |
158 |
=item B<-i> I<ID>, B<--export-id>=I<ID>
|
159 |
||
160 |
The id attribute value of the object that you want to export from the document. By
|
|
8991
by buliabyak
better explanation of --export-area-canvas |
161 |
default the exported area is the bounding box of the object; you can override this using
|
162 |
--export-area, --export-area-canvas, or --export-area-drawing.
|
|
163 |
||
4004
by buliabyak
new options and many edits in the man page |
164 |
=item B<-j>, B<--export-id-only>
|
4292
by buliabyak
added --export-id-only to export only the specified object and hide all others |
165 |
|
166 |
Only export the object whose id is given in --export-id. All other objects are hidden and won't |
|
167 |
show in export even if they overlay the exported object. Without --export-id, this option is ignored. |
|
168 |
||
169 |
=item B<-l>, B<--export-plain-svg>=I<FILENAME> |
|
4004
by buliabyak
new options and many edits in the man page |
170 |
|
171 |
Export document(s) to plain SVG format, without sodipodi: or inkscape: namespaces and without RDF metadata. |
|
172 |
||
173 |
=item B<-x>, B<--extension-directory> |
|
11415
by gouldtj
r14942@tres: ted | 2007-03-20 23:50:23 -0700 |
174 |
|
6553
by gouldtj
Adding documentation for the --extension-directory command line arguement. |
175 |
Lists the current extension directory that Inkscape is configured to use and |
176 |
then exits. This is used for external extension to use the same configuration |
|
177 |
as the original Inkscape installation. |
|
178 |
||
179 |
=item B<--verb-list> |
|
11415
by gouldtj
r14942@tres: ted | 2007-03-20 23:50:23 -0700 |
180 |
|
181 |
Lists all the verbs that are available in Inkscape by ID. This ID can be |
|
182 |
used in defining keymaps or menus. It can also be used with the --verb |
|
183 |
command line option. |
|
184 |
||
185 |
=item B<--verb>=I<VERB-ID>, B<--select>=I<OBJECT-ID> |
|
186 |
||
187 |
These two options work together to provide some basic scripting for |
|
188 |
Inkscape from the command line. They both can occur as many times as |
|
189 |
needed on the command line and are executed in order on every document that |
|
190 |
is specified. |
|
191 |
||
192 |
The --verb command will execute a specific verb as if it |
|
12388
by buliabyak
various updates |
193 |
was called from a menu or button. Dialogs will appear if that is part |
11415
by gouldtj
r14942@tres: ted | 2007-03-20 23:50:23 -0700 |
194 |
of the verb. To get a list of the verb IDs available, use the --verb-list |
12388
by buliabyak
various updates |
195 |
command line option. |
11415
by gouldtj
r14942@tres: ted | 2007-03-20 23:50:23 -0700 |
196 |
|
197 |
The --select command will cause objects that have the ID |
|
198 |
specified to be selected. This allows various verbs to act upon them. To |
|
199 |
remove all the selections use --verb=EditDeselect. The object IDs |
|
200 |
available are dependent on the document specified to load. |
|
201 |
||
202 |
=item B<-p> I<PRINTER>, B<--print>=I<PRINTER> |
|
4004
by buliabyak
new options and many edits in the man page |
203 |
|
204 |
Print document(s) to the specified printer using `lpr -P PRINTER'. |
|
205 |
Alternatively, use `| COMMAND' to specify a different command to pipe to, |
|
206 |
or use `> FILENAME' to write the PostScript output to a file instead of printing. |
|
207 |
Remember to do appropriate quoting for your shell, e.g.
|
|
208 |
||
209 |
inkscape --print='| ps2pdf - mydoc.pdf' mydoc.svg |
|
210 |
||
360
by bryce
Rewriting manpage from scratch |
211 |
=item B<-t>, B<--export-use-hints>
|
4004
by buliabyak
new options and many edits in the man page |
212 |
|
213 |
Use export filename and DPI hints stored in the exported object (only with --export-id).
|
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
214 |
These hints are set automatically when you export selection from within Inkscape.
|
215 |
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,
|
|
216 |
then later you will be able to reexport that shape to the same file with the same resolution simply with
|
|
217 |
||
218 |
inkscape -i path231 -t document.svg
|
|
219 |
||
220 |
If you use --export-dpi, --export-width, or --export-height with this option,
|
|
221 |
then the DPI hint will be ignored and the value from the command line will be used.
|
|
222 |
If you use --export-png with this option,
|
|
223 |
then the filename hint will be ignored and the filename from the command line will be used.
|
|
224 |
||
360
by bryce
Rewriting manpage from scratch |
225 |
=item B<-w> I<WIDTH>, B<--export-width>=I<WIDTH>
|
226 |
||
227 |
The width of generated bitmap in pixels.
|
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
228 |
This value overrides the --export-dpi setting (or the DPI hint if used with --export-use-hints).
|
229 |
||
4004
by buliabyak
new options and many edits in the man page |
230 |
=item B<-y> I<VALUE>, B<--export-background-opacity>=I<VALUE>
|
231 |
||
232 |
Opacity of the background of exported PNG.
|
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
233 |
This may be a value either between 0.0 and 1.0 (0.0 meaning full transparency, 1.0 full opacity)
|
7075
by pjrm
Clarify the meaning of --export-background-opacity=1 |
234 |
or greater than 1 up to 255 (255 meaning full opacity).
|
235 |
If not set and the -b option is not used,
|
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
236 |
then the page opacity set in Inkscape in the Document Options dialog will be used (stored in the inkscape:pageopacity= attribute of sodipodi:namedview).
|
237 |
If not set but the -b option is used,
|
|
238 |
then the value of 255 (full opacity) will be used.
|
|
239 |
||
360
by bryce
Rewriting manpage from scratch |
240 |
=item B<-P> I<FILENAME>, B<--export-ps>=I<FILENAME>
|
6592
by cth103
Update for new PS/EPS export features. |
241 |
|
242 |
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.
|
|
9997
by buliabyak
pdf export from commandline |
243 |
|
6592
by cth103
Update for new PS/EPS export features. |
244 |
=item B<-E> I<FILENAME>, B<--export-eps>=I<FILENAME>
|
245 |
||
246 |
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.
|
|
9997
by buliabyak
pdf export from commandline |
247 |
|
248 |
=item B<-A> I<FILENAME>, B<--export-pdf>=I<FILENAME>
|
|
249 |
||
250 |
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).
|
|
251 |
||
6592
by cth103
Update for new PS/EPS export features. |
252 |
=item B<-T>, B<--export-text-to-path>
|
253 |
||
254 |
Convert text objects to paths on export, where applicable (currently works for PS, EPS, and PDF export).
|
|
9997
by buliabyak
pdf export from commandline |
255 |
|
6592
by cth103
Update for new PS/EPS export features. |
256 |
=item B<-B>, B<--export-bbox-page>
|
257 |
||
258 |
Export files with the bounding box set to the page size, where applicable (currently works for PS and EPS export).
|
|
9997
by buliabyak
pdf export from commandline |
259 |
|
6600
by buliabyak
more query options, man update |
260 |
=item B<-F>, B<--export-embed-fonts>
|
10982
by buliabyak
man page update for 0.45 |
261 |
|
262 |
Embed fonts used in the document into exported PS/EPS file. Note: only Type 1 fonts can be embedded, not TrueType.
|
|
263 |
||
264 |
=item B<-I>, B<--query-id>
|
|
6600
by buliabyak
more query options, man update |
265 |
|
266 |
Set the ID of the object whose dimensions are queried. If not set, query options will
|
|
267 |
return the dimensions of the drawing (i.e. all document objects), not the page or viewbox
|
|
268 |
||
269 |
=item B<-X>, B<--query-x>
|
|
270 |
||
271 |
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).
|
|
272 |
||
273 |
=item B<-Y>, B<--query-y>
|
|
274 |
||
275 |
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).
|
|
276 |
||
277 |
=item B<-W>, B<--query-width>
|
|
278 |
||
279 |
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).
|
|
280 |
||
281 |
=item B<-H>, B<--query-height>
|
|
282 |
||
283 |
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).
|
|
284 |
||
6592
by cth103
Update for new PS/EPS export features. |
285 |
=item B<-S>, B<--query-all>
|
13034
by bryce
Man page entry for --query-all option |
286 |
|
287 |
Prints a comma delimited listing of all objects in the SVG document with
|
|
288 |
IDs defined, along with their x, y, width, and height values.
|
|
289 |
||
290 |
=item B<--vacuum-defs>
|
|
7077
by bryce
Adding Makzu's patch to implement a --vacuum-defs function |
291 |
|
292 |
Remove all unused items from the <lt>defs<gt> section of the SVG file. If this
|
|
7089
by buliabyak
vacuum defs to work without GUI and without --export-plain-svg |
293 |
option is invoked in conjunction with --export-plain-svg, only the exported file
|
294 |
will be affected. If it is used alone, the specified file will be modified in place.
|
|
295 |
||
7077
by bryce
Adding Makzu's patch to implement a --vacuum-defs function |
296 |
=item B<-z>, B<--without-gui>
|
360
by bryce
Rewriting manpage from scratch |
297 |
|
298 |
Do not open the GUI (on Unix, do not use X server); only process the files from console.
|
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
299 |
This is assumed for -p, -e, -l, and --vacuum-defs options.
|
7089
by buliabyak
vacuum defs to work without GUI and without --export-plain-svg |
300 |
|
360
by bryce
Rewriting manpage from scratch |
301 |
=item B<--g-fatal-warnings>
|
5556
by nemies
Documenting theme support, as it is... |
302 |
|
303 |
Part of the standard GTK option that are recognized. This forces any GTK
|
|
304 |
warnings to cause Inkscape to abort. This option is listed because it gets
|
|
305 |
used for debugging.
|
|
306 |
||
307 |
=item B<--usage>
|
|
360
by bryce
Rewriting manpage from scratch |
308 |
|
309 |
Display a brief usage message.
|
|
4004
by buliabyak
new options and many edits in the man page |
310 |
|
360
by bryce
Rewriting manpage from scratch |
311 |
=back
|
312 |
||
313 |
=head1 CONFIGURATION
|
|
452
by bryce
Adding documentation of preferences.xml file to Inkscape's man page |
314 |
|
315 |
The preferences.xml configuration file located in ~/.inkscape/ is used
|
|
316 |
to customize the application settings for the user.
|
|
317 |
||
318 |
=over 8
|
|
319 |
||
320 |
=item B<interface>
|
|
321 |
||
322 |
The B<interface> element(s) of the config file is used to set parameters
|
|
323 |
related to the GUI interface, such as the open/closed status of various
|
|
324 |
GUI elements, etc.
|
|
325 |
||
326 |
=item B<group id="documents">
|
|
327 |
||
328 |
The documents group is used for containing the recent files list. Each
|
|
329 |
document is listed with its uri (path) and name indicated.
|
|
330 |
||
331 |
=item B<group id="template">
|
|
332 |
||
333 |
The template group is used for storing parameters related to blank
|
|
334 |
documents.
|
|
335 |
||
336 |
=item B<group id="tools">
|
|
337 |
||
338 |
The tools group is used for storing the user style preferences for
|
|
339 |
different event contexts (i.e., shapes, freehand or calligraphic stroke
|
|
340 |
properties, etc.).
|
|
341 |
||
342 |
=item B<group id="palette">
|
|
343 |
||
344 |
The palette group allows setting of dash styles. This allows you to
|
|
345 |
define the stroke lengths for different kinds of dashes.
|
|
346 |
||
347 |
=item B<group id="dialogs">
|
|
348 |
||
349 |
The dialogs group allows persisting the position and width of each of
|
|
350 |
the dialogs in the application, so that they'll start up in the last |
|
351 |
place the user had them at the next time the app is run. |
|
352 |
||
353 |
=item B<group id="printing"> |
|
354 |
||
355 |
The printing group is for storing different printer settings. Each |
|
356 |
setting is identified with an id. Properties include I<bitmap> |
|
357 |
(true/false), I<resolution>, and I<destination>. |
|
358 |
||
359 |
=item B<group id="options"> |
|
360 |
||
361 |
The options group allows persisting various user selected options |
|
362 |
including I<nudgedistance>, I<rotationstep>, I<cursortolerance>, and |
|
12388
by buliabyak
various updates |
363 |
I<dragtolerance>. |
452
by bryce
Adding documentation of preferences.xml file to Inkscape's man page |
364 |
|
365 |
=back |
|
366 |
||
367 |
=head1 DIAGNOSTICS |
|
360
by bryce
Rewriting manpage from scratch |
368 |
|
369 |
The program returns zero on success or non-zero on failure. |
|
370 |
||
371 |
A variety of error messages and warnings may be printed to STDERR or |
|
12388
by buliabyak
various updates |
372 |
STDOUT. If the program behaves erratically with a particular SVG file |
360
by bryce
Rewriting manpage from scratch |
373 |
or crashes, it is useful to look at this output for clues. |
12388
by buliabyak
various updates |
374 |
|
360
by bryce
Rewriting manpage from scratch |
375 |
=head1 EXAMPLES |
376 |
||
377 |
While obviously B<Inkscape> is primarily intended as a GUI application, |
|
378 |
it can be used for doing SVG processing on the commandline as well. |
|
379 |
||
4004
by buliabyak
new options and many edits in the man page |
380 |
Open an SVG file in the GUI: |
12388
by buliabyak
various updates |
381 |
|
382 |
inkscape filename.svg |
|
383 |
||
384 |
Print an SVG file from the command line: |
|
385 |
||
4004
by buliabyak
new options and many edits in the man page |
386 |
inkscape filename.svg -p '| lpr' |
387 |
||
388 |
Export an SVG file into PNG with the default resolution of 90dpi (one SVG user unit translates to one bitmap pixel): |
|
7966
by buliabyak
remove obsolete info, add more examples |
389 |
|
390 |
inkscape filename.svg --export-png=filename.png |
|
391 |
||
392 |
Same, but force the PNG file to be 600x400 pixels: |
|
393 |
||
4004
by buliabyak
new options and many edits in the man page |
394 |
inkscape filename.svg --export-png=filename.png -w600 -h400 |
395 |
||
396 |
Same, but export the drawing (bounding box of all objects), not the page: |
|
7966
by buliabyak
remove obsolete info, add more examples |
397 |
|
398 |
inkscape filename.svg --export-png=filename.png --export-area-drawing |
|
399 |
||
400 |
Export to PNG the object with id="text1555", using the output filename and |
|
401 |
the resolution that were used for that object last time when it was exported from the GUI: |
|
402 |
||
403 |
inkscape filename.svg --export-id=text1555 --export-use-hints |
|
404 |
||
405 |
Same, but use the default 90dpi resolution, specify the filename, |
|
406 |
and snap the exported area outwards to the nearest whole SVG user unit values |
|
407 |
(to preserve pixel-alignment of objects and thus minimize antialiasing): |
|
408 |
||
409 |
inkscape filename.svg --export-id=text1555 --export-png=text.png --export-snap-area |
|
410 |
||
411 |
Convert an Inkscape SVG document to plain SVG: |
|
4004
by buliabyak
new options and many edits in the man page |
412 |
|
413 |
inkscape filename1.svg --export-plain-svg=filename2.svg |
|
414 |
||
360
by bryce
Rewriting manpage from scratch |
415 |
Convert an SVG document to EPS, converting all texts to paths: |
6600
by buliabyak
more query options, man update |
416 |
|
417 |
inkscape filename.svg --export-eps=filename.eps --export-text-to-path |
|
418 |
||
419 |
Query the width of the object with id="text1555": |
|
420 |
||
421 |
inkscape filename.svg --query-width --query-id text1555 |
|
422 |
||
423 |
Duplicate the object with id="path1555", rotate the duplicate 90 degrees, save SVG, and quit: |
|
12388
by buliabyak
various updates |
424 |
|
425 |
inkscape filename.svg --select=path1555 --verb=EditDuplicate --verb=ObjectRotate90 --verb=FileSave --verb=FileClose |
|
426 |
||
427 |
||
6600
by buliabyak
more query options, man update |
428 |
=head1 ENVIRONMENT |
360
by bryce
Rewriting manpage from scratch |
429 |
|
430 |
B<DISPLAY> to get the default host and display number. |
|
431 |
||
432 |
B<TMPDIR> to set the default path of the directory to use for temporary |
|
432
by bryce
Adding TMPDIR to manpage |
433 |
files. The directory must exist. |
434 |
||
435 |
=head1 THEMES |
|
5556
by nemies
Documenting theme support, as it is... |
436 |
|
437 |
To load different icons sets instead of the default |
|
438 |
B<$PREFIX>/share/inkscape/icons/icons.svg file, the directory |
|
439 |
B<$HOME>/.inkscape/icons/ is used. Icons are loaded by name |
|
440 |
(e.g. I<fill_none.svg>), or if not found, then from I<icons.svg>. If the |
|
441 |
icon is not loaded from either of those locations, it falls back to the |
|
442 |
default system location. |
|
443 |
||
444 |
The needed icons are loaded from SVG files by searching for the SVG id with |
|
445 |
the matching icon name. (For example, to load the "fill_none" icon from |
|
446 |
a file, the bounding box seen for SVG id "fill_none" is rendered as the |
|
447 |
icon, whether it comes from I<fill_none.svg> or I<icons.svg>.) |
|
448 |
||
449 |
=head1 FILES |
|
360
by bryce
Rewriting manpage from scratch |
450 |
|
451 |
B<$HOME>/.inkscape/preferences.xml - The user's preference settings. |
|
452 |
||
453 |
B<$HOME>/.inkscape/extensions/ - Directory with user's extension effects. |
|
12388
by buliabyak
various updates |
454 |
|
455 |
B<$HOME>/.inkscape/icons/ - Directory with user's icons. |
|
456 |
||
457 |
B<$HOME>/.inkscape/keys/ - Directory with user's keyboard maps. |
|
458 |
||
459 |
B<$HOME>/.inkscape/templates/ - Directory with user's new file templates. |
|
460 |
||
461 |
||
5556
by nemies
Documenting theme support, as it is... |
462 |
=head1 OTHER INFO
|
360
by bryce
Rewriting manpage from scratch |
463 |
|
464 |
The canonical place to find B<Inkscape> info is at
|
|
465 |
http://www.inkscape.org/. The website has news, documentation,
|
|
12388
by buliabyak
various updates |
466 |
tutorials, examples, mailing list archives, the latest released
|
467 |
version of the program, bugs and feature requests databases, forums,
|
|
468 |
and more.
|
|
469 |
||
360
by bryce
Rewriting manpage from scratch |
470 |
=head1 SEE ALSO
|
471 |
||
472 |
potrace, cairo, rsvg(1), batik, ghostscript, pstoedit.
|
|
12388
by buliabyak
various updates |
473 |
|
360
by bryce
Rewriting manpage from scratch |
474 |
SVG compliance test suite: http://www.w3.org/Graphics/SVG/Test/
|
450
by bryce
Adding links to a few relevant specs to the man page |
475 |
|
476 |
SVG validator: http://jiggles.w3.org/svgvalidator/
|
|
477 |
||
478 |
I<Scalable Vector Graphics (SVG) 1.1 Specification>
|
|
479 |
I<W3C Recommendation 14 January 2003>
|
|
480 |
L<http://www.w3.org/TR/SVG11/>
|
|
481 |
||
482 |
I<Scalable Vector Graphics (SVG) 1.2 Specification>
|
|
483 |
I<W3C Working Draft 13 November 2003>
|
|
484 |
L<http://www.w3.org/TR/SVG12/>
|
|
485 |
||
486 |
I<SVG 1.1/1.2/2.0 Requirements>
|
|
487 |
I<W3C Working Draft 22 April 2002>
|
|
488 |
L<http://www.w3.org/TR/SVG2Reqs/>
|
|
489 |
||
490 |
I<Document Object Model (DOM): Level 2 Core>
|
|
491 |
I<Arnaud Le Hors et al editors, W3C>
|
|
492 |
L<http://www.w3.org/TR/DOM-Level-2-Core/>
|
|
493 |
||
494 |
||
495 |
=head1 GUI NOTES
|
|
7966
by buliabyak
remove obsolete info, add more examples |
496 |
|
497 |
To learn Inkscape's GUI operation, read the tutorials in Help > Tutorials. |
|
498 |
||
499 |
Apart from SVG, Inkscape can import (File > Import) most bitmap formats |
|
12388
by buliabyak
various updates |
500 |
(PNG, BMP, JPG, XPM, GIF, etc.), plain text (requires Perl), PDF, |
501 |
and AI format (AI version 9.0 or newer). |
|
502 |
||
503 |
Inkscape exports 32-bit PNG images (File > Export) as well as AI, PS, EPS, PDF, DXF, |
|
504 |
and several other formats via File > Save as. |
|
505 |
||
506 |
Inkscape can use the pressure and tilt of a graphic tablet pen for width, angle, |
|
507 |
and force of action of several tools, including the Calligraphic pen. |
|
508 |
||
7966
by buliabyak
remove obsolete info, add more examples |
509 |
Inkscape includes a GUI front-end to the Potrace bitmap tracing engine |
510 |
(http://potrace.sf.net) which is embedded into Inkscape. |
|
511 |
||
512 |
Inkscape can use external scripts (stdin-to-stdout filters) that are represented by |
|
513 |
commands in the Effects menu. A script can have a GUI dialog for setting various |
|
514 |
parameters and can get the IDs of the selected objects on which to act via the command |
|
515 |
line. Inkscape comes with an assortment of effects written in Python. |
|
12388
by buliabyak
various updates |
516 |
|
7966
by buliabyak
remove obsolete info, add more examples |
517 |
=head1 KEYBINDINGS |
518 |
||
519 |
To get a complete list of keyboard and mouse shortcuts, view doc/keys.html, or use the Keys and Mouse command in Help menu. |
|
12388
by buliabyak
various updates |
520 |
|
2660
by bryce
Adding notes about Wacom tablets |
521 |
=head1 BUGS |
360
by bryce
Rewriting manpage from scratch |
522 |
|
523 |
Many bugs are known; please refer to the website (inkscape.org) for reviewing the reported ones and to |
|
7966
by buliabyak
remove obsolete info, add more examples |
524 |
report newly found issues. See also the Known Issues section in the Release Notes for |
525 |
your version (file `NEWS'). |
|
526 |
||
4004
by buliabyak
new options and many edits in the man page |
527 |
=head1 AUTHORS
|
360
by bryce
Rewriting manpage from scratch |
528 |
|
529 |
This codebase owes its existance to a large number of contributors
|
|
530 |
throughout its various incarnations. The following list is certainly
|
|
531 |
incomplete, but serves to recognize the many shoulders on which this
|
|
532 |
application sits:
|
|
533 |
||
534 |
[% INCLUDE "AUTHORS" %]
|
|
535 |
||
536 |
This man page was put together by Bryce Harrington
|
|
537 |
E<lt>brycehar@bryceharrington.comE<gt>.
|
|
4004
by buliabyak
new options and many edits in the man page |
538 |
|
360
by bryce
Rewriting manpage from scratch |
539 |
=head1 HISTORY
|
540 |
||
541 |
The codebase that would become Inkscape began life in 1999 as the
|
|
542 |
program Gill, the GNOME Illustrator application, created by Raph
|
|
4004
by buliabyak
new options and many edits in the man page |
543 |
Levien. The stated objective for Gill was to eventually support all of
|
360
by bryce
Rewriting manpage from scratch |
544 |
SVG. Raph implemented the PostScript bezier imaging model, including
|
545 |
stroking and filling, line cap style, line join style, text, etc.
|
|
365
by bryce
Removing sentence fragment |
546 |
Raph's Gill page is at http://www.levien.com/svg/. Work on Gill appears |
360
by bryce
Rewriting manpage from scratch |
547 |
to have slowed or ceased in 2000. |
4004
by buliabyak
new options and many edits in the man page |
548 |
|
360
by bryce
Rewriting manpage from scratch |
549 |
The next incarnation of the codebase was to become the highly popular |
550 |
program Sodipodi, led by Lauris Kaplinski. The codebase was turned |
|
4004
by buliabyak
new options and many edits in the man page |
551 |
into a powerful illustration program over the course of several |
552 |
year's work, adding several new features, multi-lingual support, porting |
|
360
by bryce
Rewriting manpage from scratch |
553 |
to Windows and other operating systems, and eliminating dependencies. |
554 |
||
555 |
Inkscape was formed in 2003 by four active Sodipodi developers, Bryce |
|
2874
by bryce
Trimming ChangeLog and creating an archive copy |
556 |
Harrington, MenTaLguY, Nathan Hurst, and Ted Gould, wanting to take a |
4004
by buliabyak
new options and many edits in the man page |
557 |
different direction with the codebase in terms of focus on |
2874
by bryce
Trimming ChangeLog and creating an archive copy |
558 |
SVG compliance, interface look-and-feel, and a desire to open |
4004
by buliabyak
new options and many edits in the man page |
559 |
development opportunities to more participants. The project progressed |
12980
by bryce
Fleshing out history section a bit |
560 |
rapidly, gaining a number of very active contributors and features. |
561 |
||
562 |
Much work in the early days of the project focused on code stablization |
|
563 |
and internationalization. The original renderer inherited from Sodipodi |
|
564 |
was laced with a number of mathematical corner cases which led to |
|
565 |
unexpected crashes when the program was pushed beyond routine uses; this |
|
566 |
renderer was replaced with Livarot which, while not perfect either, was |
|
567 |
significantly less error prone. The project also adopted a practice of |
|
568 |
committing code frequently, and encouraging users to run developmental |
|
569 |
snapshots of the program; this helped identify new bugs swiftly, and |
|
570 |
ensure it was easy for users to verify the fixes. As a result, Inkscape |
|
571 |
releases have generally earned a reputation for being robust and |
|
572 |
reliable. |
|
573 |
||
574 |
Similarly, efforts were taken to internationalize and localize the |
|
575 |
interface, which has helped the program gain contributors worldwide. |
|
576 |
||
577 |
Inkscape has had a beneficial impact on the visual attractiveness of |
|
578 |
Open Source in general, by providing a tool for creating and sharing |
|
579 |
icons, splash screens, website art, and so on. In a way, despite being |
|
580 |
"just an drawing program", Inkscape has played an important role in |
|
581 |
making Open Source more visually stimulating to larger audiences. |
|
582 |
||
360
by bryce
Rewriting manpage from scratch |
583 |
=head1 COPYRIGHT AND LICENSE |
584 |
||
585 |
B<Copyright (C)> 1999-2008 by Authors. |
|
13540
by bryce
Update copyright date to 2008 |
586 |
|
360
by bryce
Rewriting manpage from scratch |
587 |
B<Inkscape> is free software; you can redistribute it and/or modify it |
588 |
under the terms of the GPL. |
|
589 |
||
590 |
||
591 |
=for comment |
|
4090
by pjrm
Minor frobbing, including whitespace (splitting some long lines into one line per sentence/clause). |
592 |
$Date$ |
593 |