Apple Shake 4 User Manual
Page 1021
Appendix A
The Shake Command-Line Manual
1021
-fo
FileOut. Writes the image to disk in the format of the file extension.
If no extension is given, it is saved in .iff format.
-savescript
Saves all of the previous commands into a script for later execution.
Also helpful to get scripting formats.
-script
Reads a script and tests it. All branches are viewed; all FileOut
nodes are rendered to disk.
Viewing Controls
Description
-compare
Example:
shake bg.iff -blur 20 -compare
bg.iff
Allows you to compare two images. Option-click or Alt-click (Shift-
Control-click on Linux) to drag between the images. Press H or V to
split the screen between horizontal and vertical splits.
-fps
Frames per second for the playback. You can also press + or – on
the number keypad to set this. The actual and target fps are
displayed at the top of the Flipbook.
-gui
Launches your functions in the interface.
-monitor [keepFrames] [w] [h]
With no options, this only displays the current frame, discarding
the frame when you go to the next frame. When keepFrames is set
to 1, it keeps all frames in memory. When set to 0, it discards them.
You can also specify the width and height of the monitor window.
-view [zoom]
Can be used to view intermediate stages of a string of nodes. You
can also list an optional zoom level for the Viewer.
Information Controls
Description
-doc
Launches this fine and flawless documentation.
-help, -h [functionName]
Without any arguments, lists all functions available in Shake. When
you supply a string, it matches any functions with that string in it.
See “
-info
Lists size, type, bit depth, and channel information regarding your
image.
-version
Prints the version of Shake.
-v, -vv
Verbose. When -v is on, the rendering time is printed for each
frame. -vv displays a percentage of render completion as it renders.
Render Controls
Description
-cpus
The number of CPUs to use. Default is 1.
-createdirs
Used with -renderproxies to create the necessary subdirectories for
the proxies. It does not affect FileOut renders.
-fldr
Turns on field rendering. 1 = odd/PAL, 0 = even/NTSC.
-mem
Sets the maximum amount of memory to use.
I/O Functions
Description