k3d(1) - f14

1k3d(1)                      General Commands Manual                     k3d(1)
2
3
4

NAME

6       k3d - 3D modeling and animation system
7
8

SYNOPSIS

10       k3d [options]
11
12

DESCRIPTION

14       K-3D  is  a  free (as in freedom) 3D modeling, animation, and rendering
15       system for GNU/Linux and Win32. K-3D features a robust, object-oriented
16       plugin  architecture and is capable of producing motion-picture-quality
17       output when paired with a RenderMan Interface compliant  render  engine
18       such as Aqsis.
19
20       Please visit http://www.k-3d.org for more information.
21
22

OPTIONS

24       --add-path [path]
25              Prepends a filesystem path to the PATH environment variable.
26
27       --color
28              Color-codes  log  messages based on their priority.  Requires an
29              ANSI color-capable terminal.
30
31       --disable-gl-extension [extension]
32              Disables the given OpenGL extension.
33
34       --exit
35              Exits the program (useful after running scripts in batch mode).
36
37       -h, --help
38              Prints this help information and exits.
39
40       --log-level [level]
41              Specifies the minimum message priority to log (valid values  are
42              "warning", "information", or "debug").
43
44       --options [path]
45              Overrides  the filepath for storing user options (this overrides
46              both defaults and  the  K3D_OPTIONS_PATH  environment  variable,
47              below).
48
49       --plugins [path]
50              Overrides  the  path(s) for loading plugin libraries (this over‐
51              rides both defaults and the K3D_PLUGIN_PATHS  environment  vari‐
52              able,  below).  Multiple colon-delimited paths are allowed.  Use
53              "&" as a synonym for the default paths.
54
55       --script [file]
56              Play the given script after startup (use - for stdin).
57
58       --shadercache [path]
59              Overrides the path where compiled shaders will be  cached  (this
60              overrides  both  defaults and the K3D_SHADER_CACHE_PATH environ‐
61              ment variable, below).
62
63       --share [path]
64              Overrides the path for loading shared data files (this overrides
65              both  defaults  and  the  K3D_SHARE_PATH  environment  variable,
66              below).
67
68       --show-process
69              Prints the process name next to log messages.
70
71       --show-timestamps
72              Prints timestamps next to log messages.
73
74       --syslog
75              Logs messages to syslog.
76
77       -u, --ui [ui path]
78              Specifies the path to a user interface  plugin  (this  overrides
79              both  the  default  and  the K3D_USER_INTERFACE_PATH environment
80              variable, below).  As a special-case the string  "none"  can  be
81              used as a synonym for the Null (no gui) User Interface.
82
83       -H, --user-interface-help
84              Prints a user-interface specific help message and exits.
85
86       --version
87              Prints program version information and exits.
88
89

USER INTERFACE OPTIONS

91       --batch
92              Operate in batch (no user intervention) mode.
93
94       -n, --new
95              Creates a new document after startup.
96
97       --no-custom-layouts
98              Disable  custom user interface layouts (useful when playing-back
99              recorded tutorials, which rely on the default layout).
100
101       --no-splash
102              Disables the startup splash screen.
103
104       -o, --open [file]
105              Opens the given file after startup.
106
107       --show-tutorials
108              Opens the tutorials menu immediately following startup.
109
110       --tutorials [path]
111              Overrides the path for loading interactive tutorials (this over‐
112              rides both defaults and the K3D_TUTORIALS_PATH environment vari‐
113              able, below).
114
115

ENVIRONMENT VARIABLES

117       K3D_EXTRA_OPTIONS
118              Provides additional options that are appended  to  the  command-
119              line  at startup.  Note that unlike other K-3D environment vari‐
120              ables, options specified  via  K3D_EXTRA_OPTIONS  will  override
121              options specified on the command line.
122
123       K3D_OPTIONS_PATH
124              Overrides  the path for storing user options (this overrides the
125              default, but can be overridden by the --options option, above).
126
127       K3D_PLUGIN_PATHS
128              Overrides the path(s) for loading plugin libraries  (this  over‐
129              rides  the  default,  but  can  be  overridden  by the --plugins
130              option, above).  Multiple  colon-delimited  paths  are  allowed.
131              Use "&" as a synonym for the default paths.
132
133       K3D_SHADER_CACHE_PATH
134              Overrides the path where compiled shaders are cached (this over‐
135              rides the default, but can be overridden  by  the  --shadercache
136              option, above).
137
138       K3D_SHARE_PATH
139              Overrides the path for loading shared data files (this overrides
140              the default, but  can  be  overridden  by  the  --share  option,
141              above).
142
143       K3D_USER_INTERFACE_PATH
144              Overrides  the path to the user interface plugin (this overrides
145              the default, but can be overridden by the --ui option, above).
146
147

AUTHORS

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

REPORTING BUGS

153       Report bugs to <k3d-development@lists.sourceforge.net>
154
155

COPYRIGHT

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