Running K-3D

From K-3D

Revision as of 15:11, 9 July 2006 by Tshead (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Running K-3D from a Desktop

  • On the desktop, double-click the K-3D icon.

Quitting K-3D

  • Select File > Quit. If you have made any changes, you are prompted to save the document.

Running K-3D from a Command Line

At a terminal or command-shell, enter the following:

k3d [options]

Options

--color

Color-codes log messages based on their priority. Requires an ANSI color-capable terminal.

--exit

Exits the program (useful after running scripts in batch mode).

-h, --help

Prints this help information and exits.

--log-level [level]

Specifies the minimum message priority to log (valid values are "warning", "information", or "debug").

-n, --new

Creates a new document after startup.

-o, --open [file]

Opens the given file after startup.

--options [path]

Overrides the filepath for storing user options (this overrides both defaults and the K3D_OPTIONS_PATH environment variable, below).

--plugins [path]

Overrides the path(s) for loading plugin libraries (this overrides both defaults and the K3D_PLUGIN_PATHS environment variable, below). Multiple colon-delimited paths are allowed. Use "&" as a synonym for the default paths.

--script [file]

Play the given script after startup (use - for stdin).

--shadercache [path]

Overrides the path where compiled shaders will be cached (this overrides both defaults and the K3D_SHADER_CACHE_PATH environment variable, below).

--share [path]

Overrides the path for loading shared data files (this overrides both defaults and the K3D_SHARE_PATH environment variable, below).

--show-process

Prints the process name next to log messages.

--show-timestamps

Prints timestamps next to log messages.

--syslog

Logs messages to syslog.

--ui [ui path]

Specifies the path to a user interface plugin (this overrides both the default and the K3D_USER_INTERFACE_PATH environment variable, below).

--version

Prints program version information and exits.

User Interface Options

--batch

Operate in batch (no user intervention) mode. This is useful when running tutorials from the command-line as automated regression tests, so they don't block waiting for user input.

--no-custom-layouts

Disable any user-customized user interface layouts. This is useful when running tutorials from the command-line as automated regression tests, since tutorials usually rely on the default UI layout in order to function.

--no-splash

Disables the startup splash screen.

--record-tutorials

Opens the tutorial recorder immediately following startup.

--show-tutorials

Opens the tutorials menu immediately following startup.

--tutorials [path]

Overrides the path for loading interactive tutorials (this overrides both defaults and the K3D_TUTORIALS_PATH environment variable, below).

K-3D Environment Variables

K3D_OPTIONS_PATH

Overrides the path for storing user options (this overrides the default, but can be overridden by the --options option, above).

K3D_PLUGIN_PATHS

Overrides the path(s) for loading plugin libraries (this overrides the default, but can be overridden by the --plugins option, above). Multiple colon-delimited paths are allowed. Use "&" as a synonym for the default paths.

K3D_SHADER_CACHE_PATH

Overrides the path where compiled shaders are cached (this overrides the default, but can be overridden by the --shadercache option, above).

K3D_SHARE_PATH

Overrides the path for loading shared data files (this overrides the default, but can be overridden by the --share option, above).

K3D_TUTORIALS_PATH

Overrides the path for loading interactive tutorials (this overrides the default, but can be overridden by the --tutorials option, above).

K3D_USER_INTERFACE_PATH

Overrides the path to the user interface plugin (this overrides the default, but can be overridden by the --ui option, above).
Personal tools