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 visualizations, and
18 scientific 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 3.1.2 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 (no spaces) of add-ons to enable in addi‐
210 tion to any default add-ons.
211 Logging Options:
214 --log <match>
215 Enable logging categories, taking a single comma separated argu‐
216 ment.
217 Multiple categories can be matched using a '.*' suffix,
218 so '--log "wm.*"' logs every kind of window-manager message.
219 Sub-string can be matched using a '*' prefix and suffix,
220 so '--log "*undo*"' logs every kind of undo-related message.
221 Use "^" prefix to ignore, so '--log "*,^wm.operator.*"' logs all
222 except for 'wm.operators.*'
223 Use "*" to log everything.
224 --log-level <level>
227 Set the logging verbosity level (higher for more details) de‐
228 faults to 1,
229 use -1 to log all levels.
230 --log-show-basename
233 Only show file name in output (not the leading path).
234 --log-show-backtrace
237 Show a back trace for each log message (debug builds only).
238 --log-show-timestamp
241 Show a timestamp for each log message in seconds since start.
242 --log-file <filename>
245 Set a file to output the log to.
246 Debug Options:
249 -d or --debug
250 Turn debugging on.
251 * Enables memory error detection
254 * Disables mouse grab (to interact with a debugger in some
255 cases)
256 * Keeps Python's 'sys.stdin' rather than setting it to None
257 --debug-value <value>
260 Set debug value of <value> on startup.
261 --debug-events
264 Enable debug messages for the event system.
265 --debug-handlers
268 Enable debug messages for event handling.
269 --debug-libmv
272 Enable debug messages from libmv library.
273 --debug-cycles
276 Enable debug messages from Cycles.
277 --debug-memory
280 Enable fully guarded memory allocation and debugging.
281 --debug-jobs
284 Enable time profiling for background jobs.
285 --debug-python
288 Enable debug messages for Python.
289 --debug-depsgraph
292 Enable all debug messages from dependency graph.
293 --debug-depsgraph-eval
296 Enable debug messages from dependency graph related on evalua‐
297 tion.
298 --debug-depsgraph-build
301 Enable debug messages from dependency graph related on graph
302 construction.
303 --debug-depsgraph-tag
306 Enable debug messages from dependency graph related on tagging.
307 --debug-depsgraph-no-threads
310 Switch dependency graph to a single threaded evaluation.
311 --debug-depsgraph-time
314 Enable debug messages from dependency graph related on timing.
315 --debug-depsgraph-pretty
318 Enable colors for dependency graph debug messages.
319 --debug-depsgraph-uuid
322 Verify validness of session-wide identifiers assigned to ID dat‐
323 ablocks.
324 --debug-ghost
327 Enable debug messages for event handling.
328 --debug-gpu
331 Enable GPU debug context and information for OpenGL 4.3+.
332 --debug-gpu-force-workarounds
335 Enable workarounds for typical GPU issues and disable all GPU
336 extensions.
337 --debug-wm
340 Enable debug messages for the window manager, shows all opera‐
341 tors in search, shows keymap errors.
342 --debug-xr
345 Enable debug messages for virtual reality contexts.
346 Enables the OpenXR API validation layer, (OpenXR) debug messages
347 and general information prints.
348 --debug-xr-time
351 Enable debug messages for virtual reality frame rendering times.
352 --debug-all
355 Enable all debug messages.
356 --debug-io
359 Enable debug messages for I/O (Collada, ...).
360 --debug-fpe
363 Enable floating-point exceptions.
364 --debug-exit-on-error
367 Immediately exit when internal errors are detected.
368 --disable-crash-handler
371 Disable the crash handler.
372 --disable-abort-handler
375 Disable the abort handler.
376 --verbose <verbose>
379 Set the logging verbosity level for debug messages that support
380 it.
381 Misc Options:
384 --open-last
385 Open the most recently opened blend file, instead of the default
386 startup file.
387 --app-template <template>
390 Set the application template (matching the directory name), use
391 'default' for none.
392 --factory-startup
395 Skip reading the BLENDER_STARTUP_FILE in the users home direc‐
396 tory.
397 --enable-event-simulate
400 Enable event simulation testing feature 'bpy.types.Win‐
401 dow.event_simulate'.
402 --env-system-datafiles
405 Set the BLENDER_SYSTEM_DATAFILES environment variable.
406 --env-system-scripts
409 Set the BLENDER_SYSTEM_SCRIPTS environment variable.
410 --env-system-python
413 Set the BLENDER_SYSTEM_PYTHON environment variable.
414 -noaudio
417 Force sound system to None.
418 -setaudio
421 Force sound system to a specific device.
422 -h or --help
425 Print this help text and exit.
426 /?
429 Print this help text and exit (Windows only).
430 -R
433 Register blend-file extension, then exit (Windows only).
434 -r
437 Silently register blend-file extension, then exit (Windows
438 only).
439 -v or --version
442 Print Blender version and exit.
443 --
446 End option processing, following arguments passed unchanged. Ac‐
447 cess via Python's 'sys.argv'.
448 Other Options:
451 --debug-freestyle
452 Enable debug messages for Freestyle.
453 Argument Parsing:
456 Arguments must be separated by white space, eg:
457 # blender -ba test.blend
458 ...will exit since '-ba' is an unknown argument.
459 Argument Order:
461 Arguments are executed in the order they are given. eg:
462 # blender --background test.blend --render-frame 1 --render-output
463 '/tmp'
464 ...will not render to '/tmp' because '--render-frame 1' renders be‐
465 fore the output path is set.
466 # blender --background --render-output /tmp test.blend --render-frame
467 1
468 ...will not render to '/tmp' because loading the blend-file over‐
469 writes the render output that was set.
470 # blender --background test.blend --render-output /tmp --render-frame
471 1
472 ...works as expected.
473
475 $BLENDER_USER_CONFIG Directory for user configuration files.
476 $BLENDER_USER_SCRIPTS Directory for user scripts.
477 $BLENDER_SYSTEM_SCRIPTS Directory for system wide scripts.
478 $BLENDER_USER_DATAFILES Directory for user data files (icons,
479 translations, ..).
480 $BLENDER_SYSTEM_DATAFILES Directory for system wide data files.
481 $BLENDER_SYSTEM_PYTHON Directory for system Python libraries.
482 $OCIO Path to override the OpenColorIO config
483 file.
484 $TMP or $TMPDIR Store temporary files here.
485
488 luxrender(1)
489
492 This manpage was written for a Debian GNU/Linux system by Daniel Mester
493 <mester@uni-bremen.de> and updated by Cyril Brulebois <cyril.brule‐
494 bois@enst-bretagne.fr> and Dan Eicher <dan@trollwerks.org>.
495Blender 3.1.2 April 10, 2022 BLENDER(1)