1K3D(1)                                                                  K3D(1)
2
3
4

NAME

6       k3d - 3D modeling and animation system.
7

SYNOPSIS

9       k3d [OPTIONS]
10

DESCRIPTION

12       K-3D is the free (as in freedom) 3D modeling, animation, and rendering
13       system for systems including GNU/Linux, Mac OSX, Windows, and others.
14       K-3D features a robust, object-oriented plugin architecture and is
15       capable of producing motion-picture-quality output when paired with a
16       RenderMan Interface compliant render engine such as Aqsis.
17

OPTIONS

19       --add-path=PATH
20           Prepends a filesystem path to the PATH environment variable.
21
22       --batch
23           Enables batch (no user intervention) mode.
24
25       --color
26           Color-codes log messages based on their priority. Requires an ANSI
27           color-capable terminal.
28
29       --disable-gl-extension=EXTENSION
30           Disables the given OpenGL extension (whether it is supported by the
31           underlyinghardware or not).
32
33       --enable-gl-extension=EXTENSION
34           Enables the given OpenGL extension (whether it is supported by the
35           underlying hardware or not).
36
37       --exit
38           Exits the program after startup (useful when running scripts in
39           batch mode).
40
41       -h, --help
42           Prints this help information and exits.
43
44       --list-gl-extensions
45           List available OpenGL extensions and exit.
46
47       --locale=PATH
48           Overrides the path for loading locales.
49
50       --log-level=LEVEL
51           Specifies the minimal message priority to display: warning,
52           information or debug. Defaults to warning.
53
54       --options=PATH
55           Overrides the filepath for storing user options (this overrides the
56           default and the K3D_OPTIONS_PATH environment variable).
57
58       --plugins=PATHS
59           Overrides the path(s) for loading plugin libraries (this overrides
60           the default and the K3D_PLUGIN_PATHS environment variable).
61           Multiple colon-delimited paths are allowed. Use "&" as a synonym
62           for the default paths.
63
64       --no-color
65           Disable color-coding of log messages based on their priority.
66
67       -e, --script=SCRIPT
68           Executes the given script text after startup.
69
70       -f, --script-file=PATH
71           Executes the given script file after startup (use - for stdin).
72
73       --setenv=ARG
74           Set an environment variable using name=value syntax.
75
76       --shadercache=PATH
77           Overrides the path where compiled shaders will be cached (this
78           overrides the default and the K3D_SHADER_CACHE_PATH environment
79           variable).
80
81       --share=PATH
82           Overrides the path for loading shared data files (this overrides
83           the default and the K3D_SHARE_PATH environment variable).
84
85       --show-process
86           Prints the process name next to log messages.
87
88       --show-timestamps
89           Prints timestamps next to log messages.
90
91       --syslog
92           Logs messages to syslog.
93
94       -u, --ui=ARG
95           Specifies the user interface to use at startup: nui, ngui, qtui,
96           pyui, or the path to a user interface plugin (this overrides the
97           default and the K3D_USER_INTERFACE_PATH environment variable).
98
99       -H, --user-interface-help
100           Prints additional command line options based on the the current
101           choice of user interface, and exits.
102
103       --version
104           Prints program version information and exits.
105

ENVIRONMENT VARIABLES

107       K3D_EXTRA_OPTIONS
108           Provides additional options that are appended to the command-line
109           at startup. Note that unlike other K-3D environment variables,
110           options specified via K3D_EXTRA_OPTIONS will override options
111           specified on the command line. Typically used to pass command-line
112           arguments when running the program from the build tree.
113
114       K3D_OPTIONS_PATH
115           Overrides the path for storing user options (this overrides the
116           default, but can be overridden by the --options option).
117
118       K3D_PLUGIN_PATHS
119           Overrides the path(s) for loading plugin libraries (this overrides
120           the default, but can be overridden by the --plugins option).
121           Multiple colon-delimited paths are allowed. Use "&" as a synonym
122           for the default paths.
123
124       K3D_SHADER_CACHE_PATH
125           Overrides the path where compiled shaders are cached (this
126           overrides the default, but can be overridden by the --shadercache
127           option).
128
129       K3D_SHARE_PATH
130           Overrides the path for loading shared data files (this overrides
131           the default, but can be overridden by the --share option).
132
133       K3D_USER_INTERFACE_PATH
134           Overrides the path to the user interface plugin (this overrides the
135           default, but can be overridden by the --ui option).
136

EXIT STATUS

138       0
139           Success
140
141       Non-zero
142           Failure (syntax or usage error; configuration error; runtime
143           failure; unexpected error).
144

BUGS

146       See the K-3D tracker at http://developer.k-3d.org/tracker and report
147       bugs to <k3d-development@lists.sourceforge.net>
148

AUTHORS

150       K-3D by Timothy M. Shead <tshead@k-3d.com>, and many others.
151

RESOURCES

153       K-3D home page: http://www.k-3d.org
154

COPYING

156       Copyright (c) 1995-2010, Timothy M. Shead. All Rights Reserved. This
157       software is licensed under the terms of the GNU General Public License;
158       see the source for copying conditions. There is NO warranty; not even
159       for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
160
161
162
163                                  02/20/2019                            K3D(1)
Impressum