doc/manpage/blender.1

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