Difference between revisions of "Doc:Synfig CLI Syntax"

From Synfig Studio :: Documentation
Jump to: navigation, search
m (SYNFIG_ENABLE_POPUP_MENU_IN_ALL_TOOLS=1)
m (add "extract alpha")
 
(12 intermediate revisions by 5 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>
== Environment Variables ==
 
In addition to these command line options that Synfig understands, several environment variables can be set to affect the behaviour of Synfig Studio:-
 
  
The following affect the display of tools in the main dialog window:-<br>
+
<pre>synfig 0.62.00
<code>export SYNFIG_ENABLE_POLYGON=1<br>
+
Revision: 20100103
export SYNFIG_ENABLE_DRAW=1<br>
+
Branch: master
export SYNFIG_ENABLE_SKETCH=1<br>
+
Revision ID: fb90766f1019b0f6038b7004b250502f4833d4e2
export SYNFIG_ENABLE_WIDTH=1</code>
+
  
These two allow you to tweak the height of the timetrack so that it aligns with the parameters dialog <br>
+
Compiled on Jan  4 2010 with GCC 4.3.3
<code>export SYNFIG_TIMETRACK_ROW_HEIGHT=21<br>
+
Copyright (c) 2001-2005 Robert B. Quattlebaum Jr., Adrian Bentley
export SYNFIG_TIMETRACK_HEADER_HEIGHT=25</code>
+
</pre>
 +
<small> (copied from the output of <code> synfig--info</code> might be different in your version.) </small>
  
For the more recent SVN versions<br>
+
==Example==
<code>export SYNFIG_DISABLE_POPUP_WINDOWS=1</code><br> to make splash screen etc. less obtrusive ...
+
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>
  
Beginning with SVN version r1127 <br>
+
''The {{l|Environment Variables}} text that used to be here has been moved.''
Addressing bug 1829182: the popup caret menu has been disabled for several
+
tools. There's no comment in the code saying why. Dooglus has added an environment variable which re-enables the popup menu when set. Export
+
SYNFIG_ENABLE_POPUP_MENU_IN_ALL_TOOLS=1 to try it, and report your findings back
+
to the bug report as to whether this should be the default or not.<br>
+

Latest revision as of 10:54, 19 December 2014

Languages Language: 

English • română



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.


Languages Language: 

English • română