Using the Command Line - Revision history

Tavmjong: /* What can you do with the command line? */

2022-01-27T09:36:03Z

What can you do with the command line?

← Older revision		Revision as of 09:36, 27 January 2022
Line 18:		Line 18:
	* Help (list of command line options): '''inkscape --help''' or '''inkscape -?'''		* Help (list of command line options): '''inkscape --help''' or '''inkscape -?'''
	* Inkscape version: '''inkscape --version'''		* Inkscape version: '''inkscape --version'''
	* Extension directory: '''inkscape --extension-directory''' or '''inkscape -x'''		*Debug information inskscape (library versions) '''--debug-info'''
	* List of available verbs (very long): '''inkscape --verb-list'''		*System data directory '''--system-data-directory'''
	* List of available actions: '''inkscape --action-list'''		*User data directory '''--user-data-directory'''
			* <s>Extension directory: '''inkscape --extension-directory''' or '''inkscape -x'''</s>
			* <s>List of available verbs (very long): '''inkscape --verb-list'''</s> ''Verbs removed in 1.2''
			* List of available actions (very long): '''inkscape --action-list'''

	==Query geometry information==		==Query geometry information==
Line 84:		Line 87:

	The main difference to commands in the normal mode is that you need to explicitly indicate when you want to open a file, e.g. <code>file-open:filename.svg; select:flowRootID; query-height</code>.		The main difference to commands in the normal mode is that you need to explicitly indicate when you want to open a file, e.g. <code>file-open:filename.svg; select:flowRootID; query-height</code>.

			= Changes from 1.1 =

			* Verbs have been removed. Use actions instead.

	= Changes from 0.92 =		= Changes from 0.92 =

Nathanal: /* Via export options */ Add pipe examples from man page

2020-07-30T11:25:22Z

Via export options: Add pipe examples from man page

← Older revision		Revision as of 11:25, 30 July 2020
Line 55:		Line 55:
	* Export more than one object to SVG files: '''inkscape --export-type="svg" --export-id="MyTriangle;MyRectangle" --export-id-only my_file.svg''' CRASH: FIXME		* Export more than one object to SVG files: '''inkscape --export-type="svg" --export-id="MyTriangle;MyRectangle" --export-id-only my_file.svg''' CRASH: FIXME
	: This will produce two SVG files, one with just the triangle, the other with just the rectangle.		: This will produce two SVG files, one with just the triangle, the other with just the rectangle.
			* Read an SVG from standard input (stdin) and export it to PDF format: '''cat my_file.svg \| inkscape --pipe --export-filename=my_file.pdf'''
			* Export an SVG to PNG format and write it to standard output (stdout), then convert it to JPG format with ImageMagick's convert program: '''inkscape --export-type=png --export-filename=- my_file.svg \| convert - filename.jpg'''
			: If used with file read from standard input (stdin), '''--export-filename''' can be omitted

	=== Via actions ===		=== Via actions ===

Nathanal: export-id uses ; not , to separate ids

2020-06-08T14:00:37Z

export-id uses ; not , to separate ids

← Older revision		Revision as of 14:00, 8 June 2020
Line 51:		Line 51:
	* Export one object from the file to a PNG, hiding all other objects: '''inkscape --export-type="png" --export-id="MyTriangle" --export-id-only my_file.svg'''		* Export one object from the file to a PNG, hiding all other objects: '''inkscape --export-type="png" --export-id="MyTriangle" --export-id-only my_file.svg'''
	: This will produce a PNG with a file name '''my_file_MyTriangle.png''' which tightly wraps the object. Only the triangle is shown.		: This will produce a PNG with a file name '''my_file_MyTriangle.png''' which tightly wraps the object. Only the triangle is shown.
	* Export more than one object at a time to PNG files: '''inkscape --export-type="png" --export-id="MyTriangle,MyRectangle" my_file.svg'''		* Export more than one object at a time to PNG files: '''inkscape --export-type="png" --export-id="MyTriangle;MyRectangle" my_file.svg'''
	: This will produce two PNG files, one tightly wrapping the triangle, the other the rectangle.		: This will produce two PNG files, one tightly wrapping the triangle, the other the rectangle.
	* Export more than one object to SVG files: '''inkscape --export-type="svg" --export-id="MyTriangle,MyRectangle" --export-id-only my_file.svg''' CRASH: FIXME		* Export more than one object to SVG files: '''inkscape --export-type="svg" --export-id="MyTriangle;MyRectangle" --export-id-only my_file.svg''' CRASH: FIXME
	: This will produce two SVG files, one with just the triangle, the other with just the rectangle.		: This will produce two SVG files, one with just the triangle, the other with just the rectangle.

Patrick87: oops, use language-neutral link instead

2020-05-17T10:56:40Z

oops, use language-neutral link instead

← Older revision		Revision as of 10:56, 17 May 2020
Line 2:		Line 2:
	This is a <span style="color:darkred">'''''Work in Progress'''</span>.		This is a <span style="color:darkred">'''''Work in Progress'''</span>.

	For the full and up-to-date command line reference, see <code>man inkscape</code> or the constantly updated online copy of the manual at https://inkscape.org~~/de~~/doc/inkscape-man.html.		For the full and up-to-date command line reference, see <code>man inkscape</code> or the constantly updated online copy of the manual at https://inkscape.org/doc/inkscape-man.html.

	=Background=		=Background=

Patrick87: Link to manpage

2020-05-17T10:49:58Z

Link to manpage

← Older revision		Revision as of 10:49, 17 May 2020
Line 1:		Line 1:

	This is a <span style="color:darkred">'''''Work in Progress'''</span>.		This is a <span style="color:darkred">'''''Work in Progress'''</span>.

			For the full and up-to-date command line reference, see <code>man inkscape</code> or the constantly updated online copy of the manual at https://inkscape.org/de/doc/inkscape-man.html.

	=Background=		=Background=

Patrick87: Fix some remaining --export-file, clarify some things

2020-05-17T10:41:50Z

Fix some remaining --export-file, clarify some things

← Older revision		Revision as of 10:41, 17 May 2020
Line 100:		Line 100:
	: Note, most verbs require a GUI (even if they don't use it). To close the GUI automatically at the end of processing, use <code>--batch-process</code>.		: Note, most verbs require a GUI (even if they don't use it). To close the GUI automatically at the end of processing, use <code>--batch-process</code>.
	* <code>--export-png</code>, <code>--export-ps</code>, <code>--export-eps</code>, <code>--export-pdf</code>, <code>--export-emf</code>, <code>--export-wmf</code>, <code>--export-xaml</code> must be replaced by one of:		* <code>--export-png</code>, <code>--export-ps</code>, <code>--export-eps</code>, <code>--export-pdf</code>, <code>--export-emf</code>, <code>--export-wmf</code>, <code>--export-xaml</code> must be replaced by one of:
	** <code>--export-~~file~~=MyOutput.xxx</code> to export a single file of type xxx		** <code>--export-filename=MyOutput.xxx</code> to export a single file of type xxx
	** <code>--export-type="xxx"</code> to batch export a list of input files to type xxx.		** <code>--export-type="xxx"</code> to batch export a list of input files to type xxx.
	* <code>--usage</code> option was removed		* The <code>--without-gui</code> option has been removed. Most parameters trigger Inkscape to run without GUI by default now. Instead enable GUI mode specifically using <code>--with-gui</code> if needed.
	* ~~'''Attention''': the~~ <code>-p</code> option for printing has changed meaning! It now means 'pipe', see below. There is no replacement available for printing.		* The <code>--usage</code> option was removed
	* The ~~option~~ <code>--file</code>, <code>-f</code> ~~has~~ been dropped. To select a file to open, simply write it as the first argument to the <code>inkscape</code> command.		* The <code>-p</code> option for printing has changed meaning! It now means 'pipe', see below. There is no replacement available for printing.
	* ~~the command~~ <code>-x</code> / <code>-~~-extension-directory~~</code> that printed out the system extension directory~~, where~~ Inkscape's stock extensions ~~are installed, has~~ been removed. ~~It has~~ been replaced by <code>--system-data-directory</code> and <code>--user-data-directory</code>, which print out the Inkscape installation's data directory and the user's ~~custom data~~ directory		* The <code>--file<code>/</code>-f</code> options have been dropped. To select a file to open, simply write it as the first argument to the <code>inkscape</code> command.
			: You can also specify multiple files to process as a (space-separated) list or by using globs/wildcards like "*.svg" (only in compatible shell environments, ''not'' when using cmd.exe on Windows).
			* The <code>--extension-directory</code>/<code>-x</code> options that printed out the system extension directory containing Inkscape's stock extensions have been removed.
			: They have been replaced by <code>--system-data-directory</code> and <code>--user-data-directory</code>, which print out the Inkscape installation's data directory and the user's profile directory respectively.

	== New options ==		== New options ==

			* <code>--export-type="xxx"</code>: Export a single file or a list of input files to type xxx. (output name is derived from input name; multiple export formats for batch export to all of them can specified as a comma-separated list)
			* <code>--export-filename=MyOutput.xxx</code>: Export a single file of type xxx (svg, png, ps, eps, pdf, emf, wmf, xaml)
			* <code>--actions</code>: chain actions from the action list. Actions can take an argument, like rotation angle, or element type. Conversion of verbs to actions is ongoing.
	* <code>--action-list</code>: list available actions		* <code>--action-list</code>: list available actions
	* <code>--actions</code>: chain actions from the action list. Actions can take an argument, like rotation angle, or element type. Conversion of verbs to actions is ongoing.
	* <code>-p, --pipe</code>: Reads input file from standard input (stdin).		* <code>-p, --pipe</code>: Reads input file from standard input (stdin).
	* <code>--pdf-page=PAGE</code>: Imports the given page of a pdf file. Numbering starts with 1.		* <code>--pdf-page=PAGE</code>: Imports the given page of a pdf file. Numbering starts with 1.
	* <code>--pdf-poppler</code>: Imports a pdf via an external (poppler with cairo backend) library. Text consists of groups containing cloned glyphs where each glyph is a path.		* <code>--pdf-poppler</code>: Imports a pdf via an external (poppler with cairo backend) library. Text consists of groups containing cloned glyphs where each glyph is a path.
	Images are stored internally. Meshes cause entire document to be rendered as a raster image.		Images are stored internally. Meshes cause entire document to be rendered as a raster image.
	* <code>--batch-process</code>: Close GUI when done		* <code>--batch-process</code>: Close GUI when done. Only use this when you actually need a GUI. Otherwise you usually don't need (or want) this option, as it forces the GUI to show (similar to <code>--with-gui</code>).
	* <code>--export-file=MyOutput.~~xxx</code>: Export~~ a ~~single file of type xxx~~ (~~svg~~, ~~png, ps, eps, pdf, emf, wmf, xaml)~~
	* <code>--~~export~~-~~type="xxx"~~</code>~~: Batch export a list of input files to type xxx~~.
	* <code>--export-ps-level>={2,3}</code>: choose PostScript level		* <code>--export-ps-level>={2,3}</code>: choose PostScript level

Moini: /* Deprecations and Replacements */

2020-03-02T12:01:35Z

Deprecations and Replacements

← Older revision		Revision as of 12:01, 2 March 2020
Line 105:		Line 105:
	* '''Attention''': the <code>-p</code> option for printing has changed meaning! It now means 'pipe', see below. There is no replacement available for printing.		* '''Attention''': the <code>-p</code> option for printing has changed meaning! It now means 'pipe', see below. There is no replacement available for printing.
	* The option <code>--file</code>, <code>-f</code> has been dropped. To select a file to open, simply write it as the first argument to the <code>inkscape</code> command.		* The option <code>--file</code>, <code>-f</code> has been dropped. To select a file to open, simply write it as the first argument to the <code>inkscape</code> command.
	* the command <code>-x</code> / <code>--extension-directory</code> that printed out the system extension directory, where Inkscape's stock extensions are installed, has been removed. It has been replaced by <code>--system-data-directory</code> and <code>--user-data-directory</code>, which print out the Inkscape installation's data directory and the user's custom data directory ~~[waiting for merge 2020-02-25]~~		* the command <code>-x</code> / <code>--extension-directory</code> that printed out the system extension directory, where Inkscape's stock extensions are installed, has been removed. It has been replaced by <code>--system-data-directory</code> and <code>--user-data-directory</code>, which print out the Inkscape installation's data directory and the user's custom data directory

	== New options ==		== New options ==

Moini: /* Deprecations and Replacements */

2020-02-25T00:39:13Z

Deprecations and Replacements

← Older revision		Revision as of 00:39, 25 February 2020
Line 105:		Line 105:
	* '''Attention''': the <code>-p</code> option for printing has changed meaning! It now means 'pipe', see below. There is no replacement available for printing.		* '''Attention''': the <code>-p</code> option for printing has changed meaning! It now means 'pipe', see below. There is no replacement available for printing.
	* The option <code>--file</code>, <code>-f</code> has been dropped. To select a file to open, simply write it as the first argument to the <code>inkscape</code> command.		* The option <code>--file</code>, <code>-f</code> has been dropped. To select a file to open, simply write it as the first argument to the <code>inkscape</code> command.
	* the command <code>-x</code> / <code>--extension-directory</code> that printed out the system extension directory, where Inkscape's stock extensions are installed, has been removed. It has been replaced by <code>--system-data-directory</code> and <code>--user-data-directory</code>, which print out the Inkscape installation's data directory and the user's custom data directory.		* the command <code>-x</code> / <code>--extension-directory</code> that printed out the system extension directory, where Inkscape's stock extensions are installed, has been removed. It has been replaced by <code>--system-data-directory</code> and <code>--user-data-directory</code>, which print out the Inkscape installation's data directory and the user's custom data directory [waiting for merge 2020-02-25]

	== New options ==		== New options ==

Moini: /* Deprecations and Replacements */

2020-02-25T00:36:30Z

Deprecations and Replacements

← Older revision		Revision as of 00:36, 25 February 2020
Line 105:		Line 105:
	* '''Attention''': the <code>-p</code> option for printing has changed meaning! It now means 'pipe', see below. There is no replacement available for printing.		* '''Attention''': the <code>-p</code> option for printing has changed meaning! It now means 'pipe', see below. There is no replacement available for printing.
	* The option <code>--file</code>, <code>-f</code> has been dropped. To select a file to open, simply write it as the first argument to the <code>inkscape</code> command.		* The option <code>--file</code>, <code>-f</code> has been dropped. To select a file to open, simply write it as the first argument to the <code>inkscape</code> command.
			* the command <code>-x</code> / <code>--extension-directory</code> that printed out the system extension directory, where Inkscape's stock extensions are installed, has been removed. It has been replaced by <code>--system-data-directory</code> and <code>--user-data-directory</code>, which print out the Inkscape installation's data directory and the user's custom data directory.

	== New options ==		== New options ==

Moini: /* Via export options */

2020-02-24T19:57:45Z

Via export options

← Older revision		Revision as of 19:57, 24 February 2020
Line 39:		Line 39:

	Some options are exclusive.		Some options are exclusive.
	* If both '''--export-~~file~~''' and '''--export-type''' are given, the file name extension must match the type.		* If both '''--export-filename''' and '''--export-type''' are given, the file name extension must match the type.
	* Only one of '''--export-area''', '''--export-area-page''', '''-export-area-drawing''', '''--export-use-hints''' will be used to determine the export area. (Which one?)		* Only one of '''--export-area''', '''--export-area-page''', '''-export-area-drawing''', '''--export-use-hints''' will be used to determine the export area. (Which one?)