man page from debian updated for 2.5, better maintain here for other linux distros.
[blender.git] / doc / blender.1
1 .TH "BLENDER" "1" "June 06, 2010" "Blender 2\&.5\&.2"
2 .SH NAME
3 blender \- a 3D modelling and rendering package
4 .SH SYNOPSIS
5 .B blender [args ...] [file] [args ...]
6
7
8 .br
9 .SH DESCRIPTION
10 .PP
11 .B blender
12 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.
13
14 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.
15
16 http://www.blender.org
17 .SH OPTIONS
18 .SS "Render options:"
19
20 .TP
21 .B \-b, \-\-background <file>
22 Load <file> in background (often used for UI-less rendering)
23
24 .TP
25 .B \-a, \-\-render-anim 
26 Render frames from start to end (inclusive)
27
28 .TP
29 .B \-S, \-\-scene <name>
30 Set the active scene <name> for rendering
31
32 .TP
33 .B \-f, \-\-render-frame <frame>
34 Render frame <frame> and save it
35
36 .TP
37 .B \-s, \-\-frame-start <frame>
38 Set start to frame <frame> (use before the \-a argument)
39
40 .TP
41 .B \-e, \-\-frame-end <frame>
42 Set end to frame <frame> (use before the \-a argument)
43
44 .TP
45 .B \-j, \-\-frame-jump <frames>
46 Set number of frames to step forward after each rendered frame
47
48 .TP
49 .B \-o, --render-output <path>
50 Set the render path and file name.
51 .IP
52 Use // at the start of the path to render relative to the blend file.
53 .IP
54 The # characters are replaced by the frame number, and used to define zero padding.
55 .IP
56     ani_##_test.png becomes ani_01_test.png
57     test-######.png becomes test-000001.png
58     When the filename does not contain #, The suffix #### is added to the filename
59 .IP
60 The frame number will be added at the end of the filename.
61     eg: blender -b foobar.blend -o //render_ -F PNG -x 1 -a
62     //render_ becomes //render_####, writing frames as //render_0001.png//
63
64 .HP
65 .B \-E, \-\-engine <engine>
66 Specify the render engine
67 use \fI\-E help\fR to list available engines
68
69 .SS "Format options:"
70
71 .TP
72 .B \-F, \-\-render-format <format>
73 Set the render format, valid options are...
74 .IP
75 TGA IRIS JPEG MOVIE IRIZ RAWTGA
76 AVIRAW AVIJPEG PNG BMP FRAMESERVER
77 .IP
78 (formats that can be compiled into blender, not available on all systems)
79 .IP
80 HDR TIFF EXR MULTILAYER MPEG AVICODEC QUICKTIME CINEON DPX DDS
81
82 .TP
83 .B \-x, \-\-use-extension <bool>
84 Set option to add the file extension to the end of the file
85
86 .TP
87 .B \-t, \-\-threads <threads>
88 Use amount of <threads> for rendering in background
89 [1-BLENDER_MAX_THREADS], 0 for systems processor count.
90
91 .SS "Animation options:"
92
93 .TP
94 .B \-a <options> <file(s)>
95 Playback <file(s)>, only operates this way when not running in background.
96 .IP
97 \-p <sx> <sy> \-\- Open with lower left corner at <sx>, <sy>
98 .br
99 \-m  \-\- Read from disk (Don't buffer)
100 .br
101 \-f <fps> <fps-base> \-\- Specify FPS to start with
102 .br
103 \-j <frame> \-\- Set frame step to <frame>
104
105 .SS "Window options:"
106
107 .TP
108 .B \-w, \-\-window-border
109 Force opening with borders (default)
110
111 .TP
112 .B \-W, \-\-window-borderless
113 Force opening with without borders
114
115 .TP
116 .B \-p, --window-geometry <sx> <sy> <w> <h>
117 Open with lower left corner at <sx>, <sy> and width and height <w>, <h>
118
119 .SS "Game Engine specific options:"
120 .TP
121 .B \-g fixedtime
122 Run on 50 hertz without dropping frames
123 .TP
124 .B \-g vertexarrays
125 Use Vertex Arrays for rendering (usually faster)
126 .TP
127 .B \-g nomipmap
128 No Texture Mipmapping
129 .TP
130 .B \-g linearmipmap
131 Linear Texture Mipmapping instead of Nearest (default)
132 .SS "Misc options:"
133 .TP
134 .B \-d, \-\-debug
135 Turn debugging on
136 .IP
137 Prints every operator call and their arguments
138 .br
139 Disables mouse grab (to interact with a debugger in some cases)
140 .br
141 Keeps python sys.stdin rather then setting it to None
142
143 .TP
144 .B \--debug-fpe 
145 Enable floating point exceptions
146
147 .TP
148 .B \-noaudio
149 Disable audio on systems that support audio
150
151 .TP
152 .B \-nojoystick 
153 Disable joystick support
154
155 .TP
156 .B \-noglsl 
157 Disable GLSL shading
158
159 .TP
160 .B \-y, \-\-enable-autoexec 
161 Enable automatic python script execution (default)
162
163 .TP
164 .B \-Y, \-\-disable-autoexec 
165 Disable automatic python script execution (pydrivers, pyconstraints, pynodes)
166
167 .TP
168 .B \-P <filename>
169 Run the given Python script (filename or Blender Text)
170
171 .TP
172 .B \-\-python-console 
173 Run blender with an interactive console
174
175 .TP
176 .B \-v, \-\-version 
177 Print Blender version and exit
178
179 .TP
180 .B \-\- 
181 Ends option processing, following arguments passed unchanged. Access via python's sys.argv
182
183 .TP
184 .B \-h, \-\-help 
185 Show a summary of options.
186
187 .SH "ENVIRONMENT VARIABLES"
188
189 .PP
190 \fIHOME\fR
191 .RS 4
192 Store files such as .blender/ .B.blend .Bfs .Blog here.
193 .RE
194
195 .PP
196 \fIBLENDERPATH\fR
197 .RS 4
198 System directory to use for data files and scripts.
199 For this build of blender the default BLENDERPATH is...
200 "/usr/share/blender"
201 setting the $BLENDERPATH will override this
202 .RE
203
204 .PP
205 \fITMP\fR or \fITMPDIR\fR
206 .RS 4
207 Store temporary files here.
208 .RE
209
210 .PP
211 \fISDL_AUDIODRIVER\fR
212 .RS 4
213 LibSDL audio driver - alsa, esd, alsa, dma.
214 .RE
215
216 .PP
217 \fIPYTHONHOME\fR
218 .RS 4
219 Path to the python directory, eg. /usr/lib/python.
220 .RE
221
222 .br
223 .SH SEE ALSO
224 .B yafaray(1)
225
226 .br
227 .SH AUTHORS
228 This manpage was written for a Debian GNU/Linux system by Daniel Mester
229 <mester@uni-bremen.de> and updated by Cyril Brulebois
230 <cyril.brulebois@enst-bretagne.fr> and Dan Eicher <dan@trollwerks.org>.
231
232