Houdini 16.5 Reference

Starting Houdini from the command line

On this page

Command line options

If you start Houdini from the command line, you can specify options, and also optionally a list of files to open (.hip scene files, .cmd or .py scripts, .hda libraries to load).

houdini [options] [file ...]

Houdini recognizes the following options.

-foreground

In Mac OS X and Linux, when you run Houdini from the command line, by default it "backgrounds" itself, returning control of the terminal to the shell. This option instead keeps Houdini in the "foreground", meaning you won’t be able to type more commands to the shell until Houdini exists or you press ⌃ Ctrl + Z to pause the foreground process.

-background

Houdini will "background" itself after starting, returning control of the terminal to the shell. This is the default.

-geometry

Define the window geometry on the screen (see also -span). For example

houdini -geometry=WxH+X+Y

(where W is width, H is height, X is horizontal position, and Y is vertical position). The geometry specification cannot have spaces. X and Y may be negative (in which case you would use - instead of + as a separator). Some window managers do not allow larger windows than the screen, overlapping of manager toolbars, and/or positioning offscreen.

-span

When you specify this option on a computer with multiple monitors, Houdini will start up spanning all monitors, so the main Houdini window fills them all (where possible, discounting resolution differences and non-rectangular layouts). This only works on some window managers, and has no effect in single-monitor setups. Cannot be used with -geometry.

-screen N

Which screen to open the main Houdini window on (for computers with multiple monitors). Note the space between the option and the screen number.

-jN

The maximum number of threads Houdini may use. Note no space between option and the number of threads.

-n

Start Houdini in "manual" cook mode.

-apprentice

Start Houdini in Apprentice mode. This will use an Apprentice or FX License.

-core

Start Houdini in Core mode. This will require a Core license, unless -force-fx-license is also used.

-indie

Start Houdini in Indie mode. This will require an Indie license, unless -force-fx-license is also used.

-force-fx-license

Force Houdini to use an FX license, even if it would not normally use one. Combine with -core to run Houdini Core using an FX license.

waitforui

If mixed in with the files to load, specifies a point at which Houdini should wait until the GUI is available before loading the rest of the files.

For example:

houdini -foreground myscript.cmd waitforui setupshelf.py my.hip

In this example, Houdini would load myscript.cmd immediately, but wait until the GUI was available before loading setupshelf.py and my.hip. This is useful for scripts that require certain UI elements to function (such as desktops, shelves, or panes).

Exit codes

If started from the command line, Houdini may exit with one of the following codes:

0

No error.

1

Generic error (catch-all code).

2

Misuse of shell built-ins (according to Bash documentation)

3

Failure to check out or verify an appropriate product license.

4

Socket communication failure.

5

Error while parsing UI definition file (.ui).

Reference

User interface

  • Menus

    Explains each of the items in the main menus.

  • Viewers

    Viewer pane types.

  • Panes

    Documents the options in various panes.

  • Windows

    Documents the options in various user interface windows.

Programming

  • Expression functions

    Expression functions let you compute the value of parameters.

  • Expression cookbook

    Tips and tricks for writing expressions to accomplish various effects.

  • Python Scripting

    How to script Houdini using Python and the Houdini Object Model.

  • VEX

    VEX is a high-performance expression language used in many places in Houdini, such as writing shaders.

  • HScript commands

    HScript is Houdini’s legacy scripting language.

Command line

Guru level