c7a762f08c7f1d7f13f15191e6c007341b9096b5
[blender.git] / doc / manpage / blender.1
1 .TH "BLENDER" "1" "July 19, 2012" "Blender Blender 2\&.63 (sub 14)"
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.63 (sub 14)
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
149 .IP
150
151 .SS "Window Options:"
152
153 .TP
154 .B \-w or \-\-window\-border
155 .br
156 Force opening with borders (default)
157 .br
158
159 .TP
160 .B \-W or \-\-window\-borderless
161 .br
162 Force opening without borders
163 .br
164
165 .TP
166 .B \-p or \-\-window\-geometry <sx> <sy> <w> <h>
167 .br
168 Open with lower left corner at <sx>, <sy> and width and height as <w>, <h>
169 .br
170
171 .TP
172 .B \-con or \-\-start\-console
173 .br
174 Start with the console window open (ignored if \-b is set)
175 .br
176
177 .IP
178
179 .SS "Game Engine Specific Options:"
180
181 .TP
182 .B \-g Game Engine specific options
183 .br
184 \-g fixedtime Run on 50 hertz without dropping frames
185 .br
186 \-g vertexarrays Use Vertex Arrays for rendering (usually faster)
187 .br
188 \-g nomipmap No Texture Mipmapping
189 .br
190 \-g linearmipmap Linear Texture Mipmapping instead of Nearest (default)
191 .br
192
193 .IP
194
195 .SS "Misc Options:"
196
197 .TP
198 .B \-d or \-\-debug
199 .br
200 Turn debugging on
201 .br
202
203 .IP
204 * Prints every operator call and their arguments
205 .br
206 * Disables mouse grab (to interact with a debugger in some cases)
207 .br
208 * Keeps python sys.stdin rather than setting it to None
209 .br
210
211 .TP
212 .B \-\-debug\-fpe
213 .br
214 Enable floating point exceptions
215 .br
216
217 .IP
218
219 .TP
220 .B \-\-factory\-startup
221 .br
222 Skip reading the "startup.blend" in the users home directory
223 .br
224
225 .IP
226
227 .TP
228 .B \-\-env\-system\-datafiles
229 .br
230 Set the BLENDER_SYSTEM_DATAFILES environment variable
231 .br
232
233 .TP
234 .B \-\-env\-system\-scripts
235 .br
236 Set the BLENDER_SYSTEM_SCRIPTS environment variable
237 .br
238
239 .TP
240 .B \-\-env\-system\-python
241 .br
242 Set the BLENDER_SYSTEM_PYTHON environment variable
243 .br
244
245 .IP
246
247 .TP
248 .B \-nojoystick
249 .br
250 Disable joystick support
251 .br
252
253 .TP
254 .B \-noglsl
255 .br
256 Disable GLSL shading
257 .br
258
259 .TP
260 .B \-noaudio
261 .br
262 Force sound system to None
263 .br
264
265 .TP
266 .B \-setaudio
267 .br
268 Force sound system to a specific device
269 .br
270 NULL SDL OPENAL JACK
271 .br
272
273 .IP
274
275 .TP
276 .B \-h or \-\-help
277 .br
278 Print this help text and exit
279 .br
280
281 .IP
282
283 .TP
284 .B \-y or \-\-enable\-autoexec
285 .br
286 Enable automatic python script execution, (default)
287 .br
288
289 .TP
290 .B \-Y or \-\-disable\-autoexec
291 .br
292 Disable automatic python script execution (pydrivers & startup scripts)
293 .br
294
295 .IP
296
297 .TP
298 .B \-P or \-\-python <filename>
299 .br
300 Run the given Python script (filename or Blender Text)
301 .br
302
303 .TP
304 .B \-\-python\-console
305 .br
306 Run blender with an interactive console
307 .br
308
309 .TP
310 .B \-\-addons
311 .br
312 Comma separated list of addons (no spaces)
313 .br
314
315 .TP
316 .B \-v or \-\-version
317 .br
318 Print Blender version and exit
319 .br
320
321 .TP
322 .B \-\-
323 .br
324 Ends option processing, following arguments passed unchanged. Access via python's sys.argv
325 .br
326
327 .SS "Other Options:"
328
329 .TP
330 .B /?
331 .br
332 Print this help text and exit (windows only)
333 .br
334
335 .TP
336 .B \-\-debug\-python
337 .br
338 Enable debug messages for python
339 .br
340
341 .TP
342 .B \-\-debug\-events
343 .br
344 Enable debug messages for the event system
345 .br
346
347 .TP
348 .B \-\-debug\-wm
349 .br
350 Enable debug messages for the window manager
351 .br
352
353 .TP
354 .B \-\-debug\-all
355 .br
356 Enable all debug messages (excludes libmv)
357 .br
358
359 .TP
360 .B \-\-debug\-value <value>
361 .br
362 Set debug value of <value> on startup
363 .br
364
365 .IP
366
367 .TP
368 .B \-\-debug\-jobs
369 .br
370 Enable time profiling for background jobs.
371 .br
372
373 .TP
374 .B \-\-verbose <verbose>
375 .br
376 Set logging verbosity level.
377 .br
378
379 .TP
380 .B \-R
381 .br
382 Register .blend extension, then exit (Windows only)
383 .br
384
385 .TP
386 .B \-r
387 .br
388 Silently register .blend extension, then exit (Windows only)
389 .br
390
391 .SS "Argument Parsing:"
392
393     arguments must be separated by white space. eg
394         "blender \-ba test.blend"
395     ...will ignore the 'a'
396         "blender \-b test.blend \-f8"
397     ...will ignore 8 because there is no space between the \-f and the frame value
398 .br
399 .SS "Argument Order:"
400
401 Arguments are executed in the order they are given. eg
402         "blender \-\-background test.blend \-\-render\-frame 1 \-\-render\-output /tmp"
403     ...will not render to /tmp because '\-\-render\-frame 1' renders before the output path is set
404         "blender \-\-background \-\-render\-output /tmp test.blend \-\-render\-frame 1"
405     ...will not render to /tmp because loading the blend file overwrites the render output that was set
406         "blender \-\-background test.blend \-\-render\-output /tmp \-\-render\-frame 1" works as expected.
407 .br
408 .br
409 .SH "ENVIRONMENT VARIABLES"
410   \fIBLENDER_USER_CONFIG\fR Directory for user configuration files.
411   \fIBLENDER_USER_SCRIPTS\fR Directory for user scripts.
412   \fIBLENDER_SYSTEM_SCRIPTS\fR Directory for system wide scripts.
413   \fIDirectory\fR for user data files (icons, translations, ..).
414   \fIBLENDER_SYSTEM_DATAFILES\fR Directory for system wide data files.
415   \fIBLENDER_SYSTEM_PYTHON\fR Directory for system python libraries.
416   \fITMP\fR or \fITMPDIR\fR Store temporary files here.
417   \fIPYTHONHOME\fR Path to the python directory, eg. /usr/lib/python.
418 .br
419 .br
420
421 .br
422 .SH SEE ALSO
423 .B yafaray(1)
424
425 .br
426 .SH AUTHORS
427 This manpage was written for a Debian GNU/Linux system by Daniel Mester
428 <mester@uni-bremen.de> and updated by Cyril Brulebois
429 <cyril.brulebois@enst-bretagne.fr> and Dan Eicher <dan@trollwerks.org>.