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