Remove the project files in favor of CMake, so we won't be maintaining now two ways...
[blender.git] / doc / blender.1
1 .TH "BLENDER" "1" "July 15, 2010" "Blender Blender 2\&.52 (sub 5) "
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.52 (sub 5) Build
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\-BLENDER_MAX_THREADS], 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 with 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 .IP
172
173 .SS "Game Engine Specific Options:"
174
175 .TP
176 .B \-g Game Engine specific options
177 .br
178 \-g fixedtime Run on 50 hertz without dropping frames
179 .br
180 \-g vertexarrays Use Vertex Arrays for rendering (usually faster)
181 .br
182 \-g nomipmap No Texture Mipmapping
183 .br
184 \-g linearmipmap Linear Texture Mipmapping instead of Nearest (default)
185 .br
186
187 .IP
188
189 .SS "Misc Options:"
190
191 .TP
192 .B \-d or \-\-debug
193 .br
194 Turn debugging on
195 .br
196
197 .IP
198 * Prints every operator call and their arguments
199 .br
200 * Disables mouse grab (to interact with a debugger in some cases)
201 .br
202 * Keeps python sys.stdin rather then setting it to None
203 .br
204
205 .TP
206 .B \-\-debug\-fpe
207 .br
208 Enable floating point exceptions
209 .br
210
211 .IP
212
213 .TP
214 .B \-nojoystick
215 .br
216 Disable joystick support
217 .br
218
219 .TP
220 .B \-noglsl
221 .br
222 Disable GLSL shading
223 .br
224
225 .TP
226 .B \-noaudio
227 .br
228 Force sound system to None
229 .br
230
231 .TP
232 .B \-setaudio
233 .br
234 Force sound system to a specific device
235 .br
236 NULL SDL OPENAL JACK
237 .br
238
239 .IP
240
241 .TP
242 .B \-h or \-\-help
243 .br
244 Print this help text and exit
245 .br
246
247 .IP
248
249 .TP
250 .B \-y or \-\-enable\-autoexec
251 .br
252 Enable automatic python script execution (default)
253 .br
254
255 .TP
256 .B \-Y or \-\-disable\-autoexec
257 .br
258 Disable automatic python script execution (pydrivers, pyconstraints, pynodes)
259 .br
260
261 .IP
262
263 .TP
264 .B \-P or \-\-python <filename>
265 .br
266 Run the given Python script (filename or Blender Text)
267 .br
268
269 .TP
270 .B \-\-python\-console
271 .br
272 Run blender with an interactive console
273 .br
274
275 .TP
276 .B \-v or \-\-version
277 .br
278 Print Blender version and exit
279 .br
280
281 .TP
282 .B \-\-
283 .br
284 Ends option processing, following arguments passed unchanged. Access via python's sys.argv
285 .br
286
287 .SS "Other Options:"
288
289 .TP
290 .B /?
291 .br
292 Print this help text and exit (windows only)
293 .br
294
295 .TP
296 .B \-R
297 .br
298 Register .blend extension (windows only)
299 .br
300
301 .SS "Argument Parsing:"
302
303     arguments must be separated by white space. eg
304         "blender \-ba test.blend"
305     ...will ignore the 'a'
306         "blender \-b test.blend \-f8"
307     ...will ignore 8 because there is no space between the \-f and the frame value
308 .br
309 .SS "Argument Order:"
310
311 Arguments are executed in the order they are given. eg
312         "blender \-\-background test.blend \-\-render\-frame 1 \-\-render\-output /tmp"
313     ...will not render to /tmp because '\-\-render\-frame 1' renders before the output path is set
314         "blender \-\-background \-\-render\-output /tmp test.blend \-\-render\-frame 1"
315     ...will not render to /tmp because loading the blend file overwrites the render output that was set
316         "blender \-\-background test.blend \-\-render\-output /tmp \-\-render\-frame 1" works as expected.
317 .br
318 .br
319 .SH "ENVIRONMENT VARIABLES"
320   \fIBLENDER_USER_CONFIG\fR Directory for user configuration files.
321   \fIBLENDER_SYSTEM_CONFIG\fR Directory for system wide configuration files.
322   \fIBLENDER_USER_SCRIPTS\fR Directory for user scripts.
323   \fIBLENDER_SYSTEM_SCRIPTS\fR Directory for system wide scripts.
324   \fIBLENDER_USER_DATAFILES\fR Directory for user data files (icons, translations, ..).
325   \fIBLENDER_SYSTEM_DATAFILES\fR Directory for system wide data files.
326   \fIBLENDER_SYSTEM_PYTHON\fR Directory for system python libraries.
327   \fITMP\fR or \fITMPDIR\fR Store temporary files here.
328   \fIPYTHONHOME\fR Path to the python directory, eg. /usr/lib/python.
329 .br
330 .br
331
332 .br
333 .SH SEE ALSO
334 .B yafaray(1)
335
336 .br
337 .SH AUTHORS
338 This manpage was written for a Debian GNU/Linux system by Daniel Mester
339 <mester@uni-bremen.de> and updated by Cyril Brulebois
340 <cyril.brulebois@enst-bretagne.fr> and Dan Eicher <dan@trollwerks.org>.