k3d(1) - f7

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. K-3D is capable of producing motion-picture-qual‐
17       ity output when paired with  a  RenderMan  Interface  compliant  render
18       engine such as Aqsis.
19
20       Please visit http://www.k-3d.org for more information.
21
22

OPTIONS

24       --color
25              Color-codes  log  messages based on their priority.  Requires an
26              ANSI color-capable terminal.
27
28       --exit
29              Exits the program (useful after running scripts in batch mode).
30
31       -h, --help
32              Prints this help information and exits.
33
34       --log-level [level]
35              Specifies the minimum message priority to log (valid values  are
36              "warning", "information", or "debug").
37
38       -n, --new
39              Creates a new document after startup.
40
41       -o, --open [file]
42              Opens the given file after startup.
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       --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       --version
84              Prints program version information and exits.
85
86

USER INTERFACE OPTIONS

88       --batch
89              Operate in batch (no user intervention) mode.
90
91       --no-custom-layouts
92              Disable  custom user interface layouts (useful when playing-back
93              recorded tutorials, which rely on the default layout).
94
95       --no-splash
96              Disables the startup splash screen.
97
98       --record-tutorials
99              Opens the tutorial recorder immediately following startup.
100
101       --show-tutorials
102              Opens the tutorials menu immediately following startup.
103
104       --tutorials [path]
105              Overrides the path for loading interactive tutorials (this over‐
106              rides both defaults and the K3D_TUTORIALS_PATH environment vari‐
107              able, below).
108
109

ENVIRONMENT VARIABLES

111       K3D_OPTIONS_PATH
112              Overrides the path for storing user options (this overrides  the
113              default, but can be overridden by the --options option, above).
114
115       K3D_PLUGIN_PATHS
116              Overrides  the  path(s) for loading plugin libraries (this over‐
117              rides the default,  but  can  be  overridden  by  the  --plugins
118              option,  above).   Multiple  colon-delimited  paths are allowed.
119              Use "&" as a synonym for the default paths.
120
121       K3D_SHADER_CACHE_PATH
122              Overrides the path where compiled shaders are cached (this over‐
123              rides  the  default,  but can be overridden by the --shadercache
124              option, above).
125
126       K3D_SHARE_PATH
127              Overrides the path for loading shared data files (this overrides
128              the  default,  but  can  be  overridden  by  the --share option,
129              above).
130
131       K3D_TUTORIALS_PATH
132              Overrides the path for loading interactive tutorials (this over‐
133              rides  the  default,  but  can  be overridden by the --tutorials
134              option, above).
135
136       K3D_USER_INTERFACE_PATH
137              Overrides the path to the user interface plugin (this  overrides
138              the default, but can be overridden by the --ui option, above).
139
140

AUTHORS

142       Written by Timothy M. Shead <tshead@k-3d.com>, and many others.
143
144

REPORTING BUGS

146       Report bugs to <k3d-development@lists.sourceforge.net>
147
148

COPYRIGHT

150       Copyright (c) 1995-2006, Timothy M. Shead
151       This software is licensed under the GNU General Public License; see the
152       source for copying conditions.  There is NO warranty; not even for MER‐
153       CHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
154
155