'\" t
.\"     Title: k3d
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 10/19/2018
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "K3D" "1" "10/19/2018" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
k3d \- 3D modeling and animation system\&.
.SH "SYNOPSIS"
.sp
\fBk3d\fR [\fIOPTIONS\fR]
.SH "DESCRIPTION"
.sp
K\-3D is the free (as in freedom) 3D modeling, animation, and rendering system for systems including GNU/Linux, Mac OSX, Windows, and others\&. K\-3D features a robust, object\-oriented plugin architecture and is capable of producing motion\-picture\-quality output when paired with a RenderMan Interface compliant render engine such as Aqsis\&.
.SH "OPTIONS"
.PP
\fB\-\-add\-path\fR=\fIPATH\fR
.RS 4
Prepends a filesystem path to the PATH environment variable\&.
.RE
.PP
\fB\-\-batch\fR
.RS 4
Enables batch (no user intervention) mode\&.
.RE
.PP
\fB\-\-color\fR
.RS 4
Color\-codes log messages based on their priority\&. Requires an ANSI color\-capable terminal\&.
.RE
.PP
\fB\-\-disable\-gl\-extension\fR=\fIEXTENSION\fR
.RS 4
Disables the given OpenGL extension (whether it is supported by the underlyinghardware or not)\&.
.RE
.PP
\fB\-\-enable\-gl\-extension\fR=\fIEXTENSION\fR
.RS 4
Enables the given OpenGL extension (whether it is supported by the underlying hardware or not)\&.
.RE
.PP
\fB\-\-exit\fR
.RS 4
Exits the program after startup (useful when running scripts in batch mode)\&.
.RE
.PP
\fB\-h, \-\-help\fR
.RS 4
Prints this help information and exits\&.
.RE
.PP
\fB\-\-list\-gl\-extensions\fR
.RS 4
List available OpenGL extensions and exit\&.
.RE
.PP
\fB\-\-locale\fR=\fIPATH\fR
.RS 4
Overrides the path for loading locales\&.
.RE
.PP
\fB\-\-log\-level\fR=\fILEVEL\fR
.RS 4
Specifies the minimal message priority to display:
\fIwarning\fR,
\fIinformation\fR
or
\fIdebug\fR\&. Defaults to
\fIwarning\fR\&.
.RE
.PP
\fB\-\-options\fR=\fIPATH\fR
.RS 4
Overrides the filepath for storing user options (this overrides the default and the K3D_OPTIONS_PATH environment variable)\&.
.RE
.PP
\fB\-\-plugins\fR=\fIPATHS\fR
.RS 4
Overrides the path(s) for loading plugin libraries (this overrides the default and the K3D_PLUGIN_PATHS environment variable)\&. Multiple colon\-delimited paths are allowed\&. Use "&" as a synonym for the default paths\&.
.RE
.PP
\fB\-\-no\-color\fR
.RS 4
Disable color\-coding of log messages based on their priority\&.
.RE
.PP
\fB\-e, \-\-script\fR=\fISCRIPT\fR
.RS 4
Executes the given script text after startup\&.
.RE
.PP
\fB\-f, \-\-script\-file\fR=\fIPATH\fR
.RS 4
Executes the given script file after startup (use \- for stdin)\&.
.RE
.PP
\fB\-\-setenv\fR=\fIARG\fR
.RS 4
Set an environment variable using name=value syntax\&.
.RE
.PP
\fB\-\-shadercache\fR=\fIPATH\fR
.RS 4
Overrides the path where compiled shaders will be cached (this overrides the default and the K3D_SHADER_CACHE_PATH environment variable)\&.
.RE
.PP
\fB\-\-share\fR=\fIPATH\fR
.RS 4
Overrides the path for loading shared data files (this overrides the default and the K3D_SHARE_PATH environment variable)\&.
.RE
.PP
\fB\-\-show\-process\fR
.RS 4
Prints the process name next to log messages\&.
.RE
.PP
\fB\-\-show\-timestamps\fR
.RS 4
Prints timestamps next to log messages\&.
.RE
.PP
\fB\-\-syslog\fR
.RS 4
Logs messages to syslog\&.
.RE
.PP
\fB\-u, \-\-ui\fR=\fIARG\fR
.RS 4
Specifies the user interface to use at startup:
\fInui\fR,
\fIngui\fR,
\fIqtui\fR,
\fIpyui\fR, or the path to a user interface plugin (this overrides the default and the K3D_USER_INTERFACE_PATH environment variable)\&.
.RE
.PP
\fB\-H, \-\-user\-interface\-help\fR
.RS 4
Prints additional command line options based on the the current choice of user interface, and exits\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Prints program version information and exits\&.
.RE
.SH "ENVIRONMENT VARIABLES"
.PP
\fBK3D_EXTRA_OPTIONS\fR
.RS 4
Provides additional options that are appended to the command\-line at startup\&. Note that unlike other K\-3D environment variables, options specified via K3D_EXTRA_OPTIONS will override options specified on the command line\&. Typically used to pass command\-line arguments when running the program from the build tree\&.
.RE
.PP
\fBK3D_OPTIONS_PATH\fR
.RS 4
Overrides the path for storing user options (this overrides the default, but can be overridden by the \-\-options option)\&.
.RE
.PP
\fBK3D_PLUGIN_PATHS\fR
.RS 4
Overrides the path(s) for loading plugin libraries (this overrides the default, but can be overridden by the \-\-plugins option)\&. Multiple colon\-delimited paths are allowed\&. Use "&" as a synonym for the default paths\&.
.RE
.PP
\fBK3D_SHADER_CACHE_PATH\fR
.RS 4
Overrides the path where compiled shaders are cached (this overrides the default, but can be overridden by the \-\-shadercache option)\&.
.RE
.PP
\fBK3D_SHARE_PATH\fR
.RS 4
Overrides the path for loading shared data files (this overrides the default, but can be overridden by the \-\-share option)\&.
.RE
.PP
\fBK3D_USER_INTERFACE_PATH\fR
.RS 4
Overrides the path to the user interface plugin (this overrides the default, but can be overridden by the \-\-ui option)\&.
.RE
.SH "EXIT STATUS"
.PP
\fB0\fR
.RS 4
Success
.RE
.PP
\fBNon\-zero\fR
.RS 4
Failure (syntax or usage error; configuration error; runtime failure; unexpected error)\&.
.RE
.SH "BUGS"
.sp
See the K\-3D tracker at http://developer\&.k\-3d\&.org/tracker and report bugs to <k3d\-development@lists\&.sourceforge\&.net>
.SH "AUTHORS"
.sp
K\-3D by Timothy M\&. Shead <tshead@k\-3d\&.com>, and many others\&.
.SH "RESOURCES"
.sp
K\-3D home page: http://www\&.k\-3d\&.org
.SH "COPYING"
.sp
Copyright (c) 1995\-2010, Timothy M\&. Shead\&. All Rights Reserved\&. This software is licensed under the terms of the GNU General Public License; see the source for copying conditions\&. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE\&.