1BLENDER(1) General Commands Manual BLENDER(1)
2
6 blender - a full-featured 3D application
7
9 blender [args ...] [file] [args ...]
10
12 blender is a full-featured 3D application. It supports the entirety of
13 the 3D pipeline - modeling, rigging, animation, simulation, rendering,
14 compositing, motion tracking, and video editing.
15 Use Blender to create 3D images and animations, films and commercials,
17 content for games, architectural and industrial visualizatons, and sci‐
18 entific visualizations.
19 https://www.blender.org
21
23 Color management: using fallback mode for management Color management:
24 Error could not find role data role. Blender 2.93.0 Usage: blender
25 [args ...] [file] [args ...]
26 Render Options:
28 -b or --background
29 Run in background (often used for UI-less rendering).
30 -a or --render-anim
33 Render frames from start to end (inclusive).
34 -S or --scene <name>
37 Set the active scene <name> for rendering.
38 -f or --render-frame <frame>
41 Render frame <frame> and save it.
42 * +<frame> start frame relative, -<frame> end frame relative.
45 * A comma separated list of frames can also be used (no spaces).
46 * A range of frames can be expressed using '..' separator be‐
47 tween the first and last frames (inclusive).
48 -s or --frame-start <frame>
51 Set start to frame <frame>, supports +/- for relative frames
52 too.
53 -e or --frame-end <frame>
56 Set end to frame <frame>, supports +/- for relative frames too.
57 -j or --frame-jump <frames>
60 Set number of frames to step forward after each rendered frame.
61 -o or --render-output <path>
64 Set the render path and file name.
65 Use '//' at the start of the path to render relative to the
66 blend-file.
67 The '#' characters are replaced by the frame number, and used to
70 define zero padding.
71 * 'animation_##_test.png' becomes 'animation_01_test.png'
74 * 'test-######.png' becomes 'test-000001.png'
75 When the filename does not contain '#', The suffix '####' is
78 added to the filename.
79 The frame number will be added at the end of the filename, eg:
82 # blender -b animation.blend -o //render_ -F PNG -x 1 -a
83 -E or --engine <engine>
86 Specify the render engine.
87 Use '-E help' to list available engines.
88 -t or --threads <threads>
91 Use amount of <threads> for rendering and other operations
92 [1-1024], 0 for systems processor count.
93 Format Options:
96 -F or --render-format <format>
97 Set the render format.
98 Valid options are:
99 Formats that can be compiled into Blender, not available on all
102 systems:
103 -x or --use-extension <bool>
106 Set option to add the file extension to the end of the file.
107 Animation Playback Options:
110 -a <options> <file(s)>
111 Instead of showing Blender's user interface, this runs Blender
112 as an animation player,
113 to view movies and image sequences rendered in Blender (ignored
114 if '-b' is set).
115 Playback Arguments:
118 -p <sx> <sy>
121 Open with lower left corner at <sx>, <sy>.
122 -m
123 Read from disk (Do not buffer).
124 -f <fps> <fps-base>
125 Specify FPS to start with.
126 -j <frame>
127 Set frame step to <frame>.
128 -s <frame>
129 Play from <frame>.
130 -e <frame>
131 Play until <frame>.
132 -c <cache_memory>
133 Amount of memory in megabytes to allow for caching images dur‐
134 ing playback.
135 Zero disables (clamping to a fixed number of frames instead).
136 Window Options:
139 -w or --window-border
140 Force opening with borders.
141 -W or --window-fullscreen
144 Force opening in fullscreen mode.
145 -p or --window-geometry <sx> <sy> <w> <h>
148 Open with lower left corner at <sx>, <sy> and width and height
149 as <w>, <h>.
150 -M or --window-maximized
153 Force opening maximized.
154 -con or --start-console
157 Start with the console window open (ignored if '-b' is set),
158 (Windows only).
159 --no-native-pixels
162 Do not use native pixel size, for high resolution displays (Mac‐
163 Book 'Retina').
164 --no-window-focus
167 Open behind other windows and without taking focus.
168 Python Options:
171 -y or --enable-autoexec
172 Enable automatic Python script execution.
173 -Y or --disable-autoexec
176 Disable automatic Python script execution (pydrivers & startup
177 scripts), (compiled as non-standard default).
178 -P or --python <filename>
181 Run the given Python script file.
182 --python-text <name>
185 Run the given Python script text block.
186 --python-expr <expression>
189 Run the given expression as a Python script.
190 --python-console
193 Run Blender with an interactive console.
194 --python-exit-code <code>
197 Set the exit-code in [0..255] to exit if a Python exception is
198 raised
199 (only for scripts executed from the command line), zero dis‐
200 ables.
201 --python-use-system-env
204 Allow Python to use system environment variables such as
205 'PYTHONPATH' and the user site-packages directory.
206 --addons <addon(s)>
209 Comma separated list of add-ons (no spaces).
210 Logging Options:
213 --log <match>
214 Enable logging categories, taking a single comma separated argu‐
215 ment.
216 Multiple categories can be matched using a '.*' suffix,
217 so '--log "wm.*"' logs every kind of window-manager message.
218 Sub-string can be matched using a '*' prefix and suffix,
219 so '--log "*undo*"' logs every kind of undo-related message.
220 Use "^" prefix to ignore, so '--log "*,^wm.operator.*"' logs all
221 except for 'wm.operators.*'
222 Use "*" to log everything.
223 --log-level <level>
226 Set the logging verbosity level (higher for more details) de‐
227 faults to 1,
228 use -1 to log all levels.
229 --log-show-basename
232 Only show file name in output (not the leading path).
233 --log-show-backtrace
236 Show a back trace for each log message (debug builds only).
237 --log-show-timestamp
240 Show a timestamp for each log message in seconds since start.
241 --log-file <filename>
244 Set a file to output the log to.
245 Debug Options:
248 -d or --debug
249 Turn debugging on.
250 * Enables memory error detection
253 * Disables mouse grab (to interact with a debugger in some
254 cases)
255 * Keeps Python's 'sys.stdin' rather than setting it to None
256 --debug-value <value>
259 Set debug value of <value> on startup.
260 --debug-events
263 Enable debug messages for the event system.
264 --debug-handlers
267 Enable debug messages for event handling.
268 --debug-libmv
271 Enable debug messages from libmv library.
272 --debug-cycles
275 Enable debug messages from Cycles.
276 --debug-memory
279 Enable fully guarded memory allocation and debugging.
280 --debug-jobs
283 Enable time profiling for background jobs.
284 --debug-python
287 Enable debug messages for Python.
288 --debug-depsgraph
291 Enable all debug messages from dependency graph.
292 --debug-depsgraph-eval
295 Enable debug messages from dependency graph related on evalua‐
296 tion.
297 --debug-depsgraph-build
300 Enable debug messages from dependency graph related on graph
301 construction.
302 --debug-depsgraph-tag
305 Enable debug messages from dependency graph related on tagging.
306 --debug-depsgraph-no-threads
309 Switch dependency graph to a single threaded evaluation.
310 --debug-depsgraph-time
313 Enable debug messages from dependency graph related on timing.
314 --debug-depsgraph-pretty
317 Enable colors for dependency graph debug messages.
318 --debug-depsgraph-uuid
321 Enable debug messages from dependency graph related on graph
322 construction.
323 --debug-ghost
326 Enable debug messages for event handling.
327 --debug-gpu
330 Enable GPU debug context and information for OpenGL 4.3+.
331 --debug-gpu-force-workarounds
334 Enable workarounds for typical GPU issues and disable all GPU
335 extensions.
336 --debug-wm
339 Enable debug messages for the window manager, shows all opera‐
340 tors in search, shows keymap errors.
341 --debug-xr
344 Enable debug messages for virtual reality contexts.
345 Enables the OpenXR API validation layer, (OpenXR) debug messages
346 and general information prints.
347 --debug-xr-time
350 Enable debug messages for virtual reality frame rendering times.
351 --debug-all
354 Enable all debug messages.
355 --debug-io
358 Enable debug messages for I/O (Collada, ...).
359 --debug-fpe
362 Enable floating-point exceptions.
363 --debug-exit-on-error
366 Immediately exit when internal errors are detected.
367 --disable-crash-handler
370 Disable the crash handler.
371 --disable-abort-handler
374 Disable the abort handler.
375 --verbose <verbose>
378 Set the logging verbosity level for debug messages that support
379 it.
380 Misc Options:
383 --open-last
384 Open the most recently opened blend file, instead of the default
385 startup file.
386 --app-template <template>
389 Set the application template (matching the directory name), use
390 'default' for none.
391 --factory-startup
394 Skip reading the BLENDER_STARTUP_FILE in the users home direc‐
395 tory.
396 --enable-event-simulate
399 Enable event simulation testing feature 'bpy.types.Win‐
400 dow.event_simulate'.
401 --env-system-datafiles
404 Set the BLENDER_SYSTEM_DATAFILES environment variable.
405 --env-system-scripts
408 Set the BLENDER_SYSTEM_SCRIPTS environment variable.
409 --env-system-python
412 Set the BLENDER_SYSTEM_PYTHON environment variable.
413 -noaudio
416 Force sound system to None.
417 -setaudio
420 Force sound system to a specific device.
421 -h or --help
424 Print this help text and exit.
425 /?
428 Print this help text and exit (Windows only).
429 -R
432 Register blend-file extension, then exit (Windows only).
433 -r
436 Silently register blend-file extension, then exit (Windows
437 only).
438 -v or --version
441 Print Blender version and exit.
442 --
445 End option processing, following arguments passed unchanged. Ac‐
446 cess via Python's 'sys.argv'.
447 Other Options:
450 --debug-freestyle
451 Enable debug messages for Freestyle.
452 Argument Parsing:
455 Arguments must be separated by white space, eg:
456 # blender -ba test.blend
457 ...will exit since '-ba' is an unknown argument.
458 Argument Order:
460 Arguments are executed in the order they are given. eg:
461 # blender --background test.blend --render-frame 1 --render-output
462 '/tmp'
463 ...will not render to '/tmp' because '--render-frame 1' renders be‐
464 fore the output path is set.
465 # blender --background --render-output /tmp test.blend --render-frame
466 1
467 ...will not render to '/tmp' because loading the blend-file over‐
468 writes the render output that was set.
469 # blender --background test.blend --render-output /tmp --render-frame
470 1
471 ...works as expected.
472
474 $BLENDER_USER_CONFIG Directory for user configuration files.
475 $BLENDER_USER_SCRIPTS Directory for user scripts.
476 $BLENDER_SYSTEM_SCRIPTS Directory for system wide scripts.
477 $BLENDER_USER_DATAFILES Directory for user data files (icons,
478 translations, ..).
479 $BLENDER_SYSTEM_DATAFILES Directory for system wide data files.
480 $BLENDER_SYSTEM_PYTHON Directory for system Python libraries.
481 $TMP or $TMPDIR Store temporary files here.
482
485 luxrender(1)
486
489 This manpage was written for a Debian GNU/Linux system by Daniel Mester
490 <mester@uni-bremen.de> and updated by Cyril Brulebois <cyril.brule‐
491 bois@enst-bretagne.fr> and Dan Eicher <dan@trollwerks.org>.
492Blender 2.93.0 June 02, 2021 BLENDER(1)