Release commit, 2.63!
[blender.git] / doc / manpage / blender.1
1 .TH "BLENDER" "1" "April 26, 2012" "Blender Blender 2\&.63 (sub 0)
2         build date: 2012-04-26
3         build time: 19:38:31
4         build revision: 45987
5         build platform: Linux
6         build type: Debug
7         build c flags:  -fopenmp  -msse2  -msse -pipe -fPIC -funsigned-char -fno-strict-aliasing  -Wall -Wcast-align -Werror=declaration-after-statement -Werror=implicit-function-declaration -Werror=return-type -Wstrict-prototypes -Wno-char-subscripts -Wno-unknown-pragmas -Wpointer-arith -Wunused-parameter -Wwrite-strings
8         build c++ flags:  -D__STDC_CONSTANT_MACROS -fopenmp  -msse2  -msse -pipe -fPIC -funsigned-char -fno-strict-aliasing  -Wall -Wno-invalid-offsetof -Wno-sign-compare
9         build link flags: -pthread
10         build system: CMake"
11
12 .SH NAME
13 blender \- a 3D modelling and rendering package
14 .SH SYNOPSIS
15 .B blender [args ...] [file] [args ...]
16 .br
17 .SH DESCRIPTION
18 .PP
19 .B blender
20 is a 3D modelling and rendering package. It is the in-house software of a high quality animation studio, Blender has proven to be an extremely fast and versatile design instrument. The software has a personal touch, offering a unique approach to the world of Three Dimensions.
21
22 Use Blender to create TV commercials, to make technical visualizations, business graphics, to do some morphing, or design user interfaces. You can easy build and manage complex environments. The renderer is versatile and extremely fast. All basic animation principles (curves & keys) are well implemented.
23
24 http://www.blender.org
25 .SH OPTIONS
26
27 Blender 2.63 (sub 0)
28 Usage: blender [args ...] [file] [args ...]
29 .br
30 .SS "Render Options:"
31
32 .TP
33 .B \-b or \-\-background <file>
34 .br
35 Load <file> in background (often used for UI\-less rendering)
36 .br
37
38 .TP
39 .B \-a or \-\-render\-anim
40 .br
41 Render frames from start to end (inclusive)
42 .br
43
44 .TP
45 .B \-S or \-\-scene <name>
46 .br
47 Set the active scene <name> for rendering
48 .br
49
50 .TP
51 .B \-f or \-\-render\-frame <frame>
52 .br
53 Render frame <frame> and save it.
54 .br
55 +<frame> start frame relative, \-<frame> end frame relative.
56 .br
57
58 .TP
59 .B \-s or \-\-frame\-start <frame>
60 .br
61 Set start to frame <frame> (use before the \-a argument)
62 .br
63
64 .TP
65 .B \-e or \-\-frame\-end <frame>
66 .br
67 Set end to frame <frame> (use before the \-a argument)
68 .br
69
70 .TP
71 .B \-j or \-\-frame\-jump <frames>
72 .br
73 Set number of frames to step forward after each rendered frame
74 .br
75
76 .TP
77 .B \-o or \-\-render\-output <path>
78 .br
79 Set the render path and file name.
80 .br
81 Use // at the start of the path to
82 .br
83     render relative to the blend file.
84 .br
85 The # characters are replaced by the frame number, and used to define zero padding.
86 .br
87     ani_##_test.png becomes ani_01_test.png
88 .br
89     test\-######.png becomes test\-000001.png
90 .br
91     When the filename does not contain #, The suffix #### is added to the filename
92 .br
93 The frame number will be added at the end of the filename.
94 .br
95     eg: blender \-b foobar.blend \-o //render_ \-F PNG \-x 1 \-a
96 .br
97     //render_ becomes //render_####, writing frames as //render_0001.png//
98 .br
99
100 .TP
101 .B \-E or \-\-engine <engine>
102 .br
103 Specify the render engine
104 .br
105 use \-E help to list available engines
106 .br
107
108 .IP
109
110 .SS "Format Options:"
111
112 .TP
113 .B \-F or \-\-render\-format <format>
114 .br
115 Set the render format, Valid options are...
116 .br
117     TGA IRIS JPEG MOVIE IRIZ RAWTGA
118 .br
119     AVIRAW AVIJPEG PNG BMP FRAMESERVER
120 .br
121 (formats that can be compiled into blender, not available on all systems)
122 .br
123     HDR TIFF EXR MULTILAYER MPEG AVICODEC QUICKTIME CINEON DPX DDS
124 .br
125
126 .TP
127 .B \-x or \-\-use\-extension <bool>
128 .br
129 Set option to add the file extension to the end of the file
130 .br
131
132 .TP
133 .B \-t or \-\-threads <threads>
134 .br
135 Use amount of <threads> for rendering in background
136 .br
137 [1\-64], 0 for systems processor count.
138 .br
139
140 .IP
141
142 .SS "Animation Playback Options:"
143
144 .TP
145 .B \-a <options> <file(s)>
146 .br
147 Playback <file(s)>, only operates this way when not running in background.
148 .br
149     \-p <sx> <sy> Open with lower left corner at <sx>, <sy>
150 .br
151     \-m Read from disk (Don't buffer)
152 .br
153     \-f <fps> <fps\-base> Specify FPS to start with
154 .br
155     \-j <frame> Set frame step to <frame>
156 .br
157
158 .IP
159
160 .SS "Window Options:"
161
162 .TP
163 .B \-w or \-\-window\-border
164 .br
165 Force opening with borders (default)
166 .br
167
168 .TP
169 .B \-W or \-\-window\-borderless
170 .br
171 Force opening without borders
172 .br
173
174 .TP
175 .B \-p or \-\-window\-geometry <sx> <sy> <w> <h>
176 .br
177 Open with lower left corner at <sx>, <sy> and width and height as <w>, <h>
178 .br
179
180 .TP
181 .B \-con or \-\-start\-console
182 .br
183 Start with the console window open (ignored if \-b is set)
184 .br
185
186 .IP
187
188 .SS "Game Engine Specific Options:"
189
190 .TP
191 .B \-g Game Engine specific options
192 .br
193 \-g fixedtime Run on 50 hertz without dropping frames
194 .br
195 \-g vertexarrays Use Vertex Arrays for rendering (usually faster)
196 .br
197 \-g nomipmap No Texture Mipmapping
198 .br
199 \-g linearmipmap Linear Texture Mipmapping instead of Nearest (default)
200 .br
201
202 .IP
203
204 .SS "Misc Options:"
205
206 .TP
207 .B \-d or \-\-debug
208 .br
209 Turn debugging on
210 .br
211
212 .IP
213 * Prints every operator call and their arguments
214 .br
215 * Disables mouse grab (to interact with a debugger in some cases)
216 .br
217 * Keeps python sys.stdin rather than setting it to None
218 .br
219
220 .TP
221 .B \-\-debug\-fpe
222 .br
223 Enable floating point exceptions
224 .br
225
226 .TP
227 .B \-\-debug\-ffmpeg
228 .br
229 Enable debug messages from FFmpeg library
230 .br
231
232 .TP
233 .B \-\-debug\-libmv
234 .br
235 Enable debug messages from libmv library
236 .br
237
238 .IP
239
240 .TP
241 .B \-\-factory\-startup
242 .br
243 Skip reading the "startup.blend" in the users home directory
244 .br
245
246 .IP
247
248 .TP
249 .B \-\-env\-system\-datafiles
250 .br
251 Set the BLENDER_SYSTEM_DATAFILES environment variable
252 .br
253
254 .TP
255 .B \-\-env\-system\-scripts
256 .br
257 Set the BLENDER_SYSTEM_SCRIPTS environment variable
258 .br
259
260 .TP
261 .B \-\-env\-system\-plugins
262 .br
263 Set the BLENDER_SYSTEM_PLUGINS environment variable
264 .br
265
266 .TP
267 .B \-\-env\-system\-python
268 .br
269 Set the BLENDER_SYSTEM_PYTHON environment variable
270 .br
271
272 .IP
273
274 .TP
275 .B \-nojoystick
276 .br
277 Disable joystick support
278 .br
279
280 .TP
281 .B \-noglsl
282 .br
283 Disable GLSL shading
284 .br
285
286 .TP
287 .B \-noaudio
288 .br
289 Force sound system to None
290 .br
291
292 .TP
293 .B \-setaudio
294 .br
295 Force sound system to a specific device
296 .br
297 NULL SDL OPENAL JACK
298 .br
299
300 .IP
301
302 .TP
303 .B \-h or \-\-help
304 .br
305 Print this help text and exit
306 .br
307
308 .IP
309
310 .TP
311 .B \-y or \-\-enable\-autoexec
312 .br
313 Enable automatic python script execution, (default)
314 .br
315
316 .TP
317 .B \-Y or \-\-disable\-autoexec
318 .br
319 Disable automatic python script execution (pydrivers, pyconstraints, pynodes)
320 .br
321
322 .IP
323
324 .TP
325 .B \-P or \-\-python <filename>
326 .br
327 Run the given Python script (filename or Blender Text)
328 .br
329
330 .TP
331 .B \-\-python\-console
332 .br
333 Run blender with an interactive console
334 .br
335
336 .TP
337 .B \-\-addons
338 .br
339 Comma separated list of addons (no spaces)
340 .br
341
342 .TP
343 .B \-v or \-\-version
344 .br
345 Print Blender version and exit
346 .br
347
348 .TP
349 .B \-\-
350 .br
351 Ends option processing, following arguments passed unchanged. Access via python's sys.argv
352 .br
353
354 .SS "Other Options:"
355
356 .TP
357 .B /?
358 .br
359 Print this help text and exit (windows only)
360 .br
361
362 .TP
363 .B \-\-debug\-python
364 .br
365 Enable debug messages for python
366 .br
367
368 .TP
369 .B \-\-debug\-events
370 .br
371 Enable debug messages for the event system
372 .br
373
374 .TP
375 .B \-\-debug\-wm
376 .br
377 Enable debug messages for the window manager
378 .br
379
380 .TP
381 .B \-\-debug\-all
382 .br
383 Enable all debug messages (excludes libmv)
384 .br
385
386 .TP
387 .B \-R
388 .br
389 Register .blend extension, then exit (Windows only)
390 .br
391
392 .TP
393 .B \-r
394 .br
395 Silently register .blend extension, then exit (Windows only)
396 .br
397
398 .SS "Argument Parsing:"
399
400     arguments must be separated by white space. eg
401         "blender \-ba test.blend"
402     ...will ignore the 'a'
403         "blender \-b test.blend \-f8"
404     ...will ignore 8 because there is no space between the \-f and the frame value
405 .br
406 .SS "Argument Order:"
407
408 Arguments are executed in the order they are given. eg
409         "blender \-\-background test.blend \-\-render\-frame 1 \-\-render\-output /tmp"
410     ...will not render to /tmp because '\-\-render\-frame 1' renders before the output path is set
411         "blender \-\-background \-\-render\-output /tmp test.blend \-\-render\-frame 1"
412     ...will not render to /tmp because loading the blend file overwrites the render output that was set
413         "blender \-\-background test.blend \-\-render\-output /tmp \-\-render\-frame 1" works as expected.
414 .br
415 .br
416 .SH "ENVIRONMENT VARIABLES"
417   \fIBLENDER_USER_CONFIG\fR Directory for user configuration files.
418   \fIBLENDER_USER_SCRIPTS\fR Directory for user scripts.
419   \fIBLENDER_SYSTEM_SCRIPTS\fR Directory for system wide scripts.
420   \fIDirectory\fR for user data files (icons, translations, ..).
421   \fIBLENDER_SYSTEM_DATAFILES\fR Directory for system wide data files.
422   \fIBLENDER_SYSTEM_PYTHON\fR Directory for system python libraries.
423   \fITMP\fR or \fITMPDIR\fR Store temporary files here.
424   \fISDL_AUDIODRIVER\fR LibSDL audio driver \- alsa, esd, dma.
425   \fIPYTHONHOME\fR Path to the python directory, eg. /usr/lib/python.
426 .br
427 .br
428
429 .br
430 .SH SEE ALSO
431 .B yafaray(1)
432
433 .br
434 .SH AUTHORS
435 This manpage was written for a Debian GNU/Linux system by Daniel Mester
436 <mester@uni-bremen.de> and updated by Cyril Brulebois
437 <cyril.brulebois@enst-bretagne.fr> and Dan Eicher <dan@trollwerks.org>.