Difference between revisions of "Doc:Synfig CLI Syntax"
From Synfig Studio :: Documentation
m (despam) |
m (add "extract alpha") |
||
| (31 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
| + | <!-- Page info --> | ||
| + | {{Title|Synfig CLI syntax}} | ||
| + | {{Category|Manual}} | ||
| + | {{NewTerminology}} | ||
| + | <!-- Page info end --> | ||
| + | |||
<pre>syntax: synfig [DEFAULT OPTIONS] ([SIF FILE] [SPECIFIC OPTIONS])... | <pre>syntax: synfig [DEFAULT OPTIONS] ([SIF FILE] [SPECIFIC OPTIONS])... | ||
| Line 14: | Line 20: | ||
-T <# of threads> Enable multithreaded renderer using specified # of threads | -T <# of threads> Enable multithreaded renderer using specified # of threads | ||
-b Print Benchmarks | -b Print Benchmarks | ||
| + | -x Shortcut for "--extract-alpha" | ||
--fps <framerate> Set the frame rate | --fps <framerate> Set the frame rate | ||
--time <time> Render a single frame at <seconds> | --time <time> Render a single frame at <seconds> | ||
--begin-time <time> Set the starting time | --begin-time <time> Set the starting time | ||
| + | --start-time <time> Set the starting time | ||
--end-time <time> Set the ending time | --end-time <time> Set the ending time | ||
| − | --dpi <res> Set the dots-per-inch | + | --dpi <res> Set the physical resolution (dots-per-inch) |
| + | --dpi-x <res> Set the physical X resolution (dots-per-inch) | ||
| + | --dpi-y <res> Set the physical Y resolution (dots-per-inch) | ||
| + | --extract-alpha Allows to extract alpha information into separate "alpha" suffixed file | ||
| + | --list-canvases List the exported canvases in the composition | ||
| + | --canvas-info <fields> Print out specified details of the root canvas | ||
--append <filename> Append layers in <filename> to composition | --append <filename> Append layers in <filename> to composition | ||
--layer-info <layer> Print out layer's description, parameter info, etc. | --layer-info <layer> Print out layer's description, parameter info, etc. | ||
| Line 31: | Line 44: | ||
</pre> | </pre> | ||
<small>(copied from the output of <code>synfig --help</code> .)</small> | <small>(copied from the output of <code>synfig --help</code> .)</small> | ||
| + | |||
| + | <pre>synfig 0.62.00 | ||
| + | Revision: 20100103 | ||
| + | Branch: master | ||
| + | Revision ID: fb90766f1019b0f6038b7004b250502f4833d4e2 | ||
| + | |||
| + | Compiled on Jan 4 2010 with GCC 4.3.3 | ||
| + | Copyright (c) 2001-2005 Robert B. Quattlebaum Jr., Adrian Bentley | ||
| + | </pre> | ||
| + | <small> (copied from the output of <code> synfig--info</code> might be different in your version.) </small> | ||
| + | |||
| + | ==Example== | ||
| + | to render myanimation.sifz to myanimation.ogg | ||
| + | <pre> | ||
| + | synfig myanimation.sifz -t ffmpeg -vc mpeg4 -vb 1000 -o myanimation.ogg | ||
| + | </pre> | ||
| + | to know which codecs are available instead of mpeg4. Replace 1000 by the desired bitrate | ||
| + | <pre> | ||
| + | synfig --target-video-codecs | ||
| + | </pre> | ||
| + | |||
| + | ''The {{l|Environment Variables}} text that used to be here has been moved.'' | ||
Latest revision as of 10:54, 19 December 2014
syntax: synfig [DEFAULT OPTIONS] ([SIF FILE] [SPECIFIC OPTIONS])... -t <output type> Specify output target (Default:unknown) -w <pixel width> Set the image width (Use zero for file default) -h <pixel height> Set the image height (Use zero for file default) -s <image dist> Set the diagonal size of image window (Span) -a <1...30> Set antialias amount for parametric renderer. -Q <0...10> Specify image quality for accelerated renderer (default=2) -g <amount> Gamma (default=2.2) -v Verbose Output (add more for more verbosity) -q Quiet mode (No progress/time-remaining display) -c <canvas id> Render the canvas with the given id instead of the root. -o <output file> Specify output filename -T <# of threads> Enable multithreaded renderer using specified # of threads -b Print Benchmarks -x Shortcut for "--extract-alpha" --fps <framerate> Set the frame rate --time <time> Render a single frame at <seconds> --begin-time <time> Set the starting time --start-time <time> Set the starting time --end-time <time> Set the ending time --dpi <res> Set the physical resolution (dots-per-inch) --dpi-x <res> Set the physical X resolution (dots-per-inch) --dpi-y <res> Set the physical Y resolution (dots-per-inch) --extract-alpha Allows to extract alpha information into separate "alpha" suffixed file --list-canvases List the exported canvases in the composition --canvas-info <fields> Print out specified details of the root canvas --append <filename> Append layers in <filename> to composition --layer-info <layer> Print out layer's description, parameter info, etc. --layers Print out the list of available layers --targets Print out the list of available targets --importers Print out the list of available importers --valuenodes Print out the list of available ValueNodes --modules Print out the list of loaded modules --version Print out version information --info Print out misc build information --license Print out license information
(copied from the output of synfig --help .)
synfig 0.62.00 Revision: 20100103 Branch: master Revision ID: fb90766f1019b0f6038b7004b250502f4833d4e2 Compiled on Jan 4 2010 with GCC 4.3.3 Copyright (c) 2001-2005 Robert B. Quattlebaum Jr., Adrian Bentley
(copied from the output of synfig--info might be different in your version.)
Example
to render myanimation.sifz to myanimation.ogg
synfig myanimation.sifz -t ffmpeg -vc mpeg4 -vb 1000 -o myanimation.ogg
to know which codecs are available instead of mpeg4. Replace 1000 by the desired bitrate
synfig --target-video-codecs
The Environment Variables text that used to be here has been moved.
