.TH "BLENDER" "1" "June 02, 2020" "Blender management: using fallback mode for management
Color management: Error could not find role data role\&.
Blender 2\&.82 (sub 7)"

.SH NAME
blender \- a full-featured 3D application
.SH SYNOPSIS
.B blender [args ...] [file] [args ...]
.br
.SH DESCRIPTION
.PP
.B blender
is a full-featured 3D application. It supports the entirety of the 3D pipeline - modeling, rigging, animation, simulation, rendering, compositing, motion tracking, and video editing.

Use Blender to create 3D images and animations, films and commercials, content for games, architectural and industrial visualizatons, and scientific visualizations.

https://www.blender.org
.SH OPTIONS

Color management: using fallback mode for management
Color management: Error could not find role data role.
Blender 2.82 (sub 7)
Usage: blender [args ...] [file] [args ...]
.br
.SS "Render Options:"

.TP
.B \-b or \-\-background
.br
Run in background (often used for UI\-less rendering).
.br

.TP
.B \-a or \-\-render\-anim
.br
Render frames from start to end (inclusive).
.br

.TP
.B \-S or \-\-scene <name>
.br
Set the active scene <name> for rendering.
.br

.TP
.B \-f or \-\-render\-frame <frame>
.br
Render frame <frame> and save it.
.br

.IP
* +<frame> start frame relative, \-<frame> end frame relative.
.br
* A comma separated list of frames can also be used (no spaces).
.br
* A range of frames can be expressed using '..' separator between the first and last frames (inclusive).
.br

.IP

.TP
.B \-s or \-\-frame\-start <frame>
.br
Set start to frame <frame>, supports +/\- for relative frames too.
.br

.TP
.B \-e or \-\-frame\-end <frame>
.br
Set end to frame <frame>, supports +/\- for relative frames too.
.br

.TP
.B \-j or \-\-frame\-jump <frames>
.br
Set number of frames to step forward after each rendered frame.
.br

.TP
.B \-o or \-\-render\-output <path>
.br
Set the render path and file name.
.br
Use '//' at the start of the path to render relative to the blend\-file.
.br

.IP
The '#' characters are replaced by the frame number, and used to define zero padding.
.br

.IP
* 'animation_##_test.png' becomes 'animation_01_test.png'
.br
* 'test\-######.png' becomes 'test\-000001.png'
.br

.IP
When the filename does not contain '#', The suffix '####' is added to the filename.
.br

.IP
The frame number will be added at the end of the filename, eg:
.br
# blender \-b animation.blend \-o //render_ \-F PNG \-x 1 \-a
.br
'//render_' becomes '//render_####', writing frames as '//render_0001.png'
.br

.TP
.B \-E or \-\-engine <engine>
.br
Specify the render engine.
.br
Use '\-E' help to list available engines.
.br

.TP
.B \-t or \-\-threads <threads>
.br
Use amount of <threads> for rendering and other operations
.br
[1\-1024], 0 for systems processor count.
.br

.IP

.SS "Format Options:"

.TP
.B \-F or \-\-render\-format <format>
.br
Set the render format.
.br
Valid options are:
.br
'TGA' 'RAWTGA' 'JPEG' 'IRIS' 'IRIZ' 'AVIRAW' 'AVIJPEG' 'PNG' 'BMP'
.br

.IP
Formats that can be compiled into Blender, not available on all systems:
.br
'HDR' 'TIFF' 'OPEN_EXR' 'OPEN_EXR_MULTILAYER' 'MPEG' 'CINEON' 'DPX' 'DDS' 'JP2'
.br

.TP
.B \-x or \-\-use\-extension <bool>
.br
Set option to add the file extension to the end of the file.
.br

.IP

.SS "Animation Playback Options:"

.TP
.B \-a <options> <file(s)>
.br
Instead of showing Blender's user interface, this runs Blender as an animation player,
.br
to view movies and image sequences rendered in Blender (ignored if '\-b' is set).
.br

.IP
Playback Arguments:
.br

.IP
\-p <sx> <sy>
.br
  Open with lower left corner at <sx>, <sy>.
.br
\-m
.br
  Read from disk (Do not buffer).
.br
\-f <fps> <fps\-base>
.br
  Specify FPS to start with.
.br
\-j <frame>
.br
  Set frame step to <frame>.
.br
\-s <frame>
.br
  Play from <frame>.
.br
\-e <frame>
.br
  Play until <frame>.
.br

.IP

.SS "Window Options:"

.TP
.B \-w or \-\-window\-border
.br
Force opening with borders.
.br

.TP
.B \-W or \-\-window\-fullscreen
.br
Force opening in fullscreen mode.
.br

.TP
.B \-p or \-\-window\-geometry <sx> <sy> <w> <h>
.br
Open with lower left corner at <sx>, <sy> and width and height as <w>, <h>.
.br

.TP
.B \-M or \-\-window\-maximized
.br
Force opening maximized.
.br

.TP
.B \-con or \-\-start\-console
.br
Start with the console window open (ignored if '\-b' is set), (Windows only).
.br

.TP
.B \-\-no\-native\-pixels
.br
Do not use native pixel size, for high resolution displays (MacBook 'Retina').
.br

.TP
.B \-\-no\-window\-focus
.br
Open behind other windows and without taking focus.
.br

.IP

.SS "Python Options:"

.TP
.B \-y or \-\-enable\-autoexec
.br
Enable automatic Python script execution.
.br

.TP
.B \-Y or \-\-disable\-autoexec
.br
Disable automatic Python script execution (pydrivers & startup scripts), (compiled as non\-standard default).
.br

.IP

.TP
.B \-P or \-\-python <filename>
.br
Run the given Python script file.
.br

.TP
.B \-\-python\-text <name>
.br
Run the given Python script text block.
.br

.TP
.B \-\-python\-expr <expression>
.br
Run the given expression as a Python script.
.br

.TP
.B \-\-python\-console
.br
Run Blender with an interactive console.
.br

.TP
.B \-\-python\-exit\-code <code>
.br
Set the exit\-code in [0..255] to exit if a Python exception is raised
.br
(only for scripts executed from the command line), zero disables.
.br

.TP
.B \-\-python\-use\-system\-env
.br
Allow Python to use system environment variables such as 'PYTHONPATH'.
.br

.TP
.B \-\-addons <addon(s)>
.br
Comma separated list of add\-ons (no spaces).
.br

.IP

.SS "Logging Options:"

.TP
.B \-\-log <match>
.br
Enable logging categories, taking a single comma separated argument.
.br
Multiple categories can be matched using a '.*' suffix,
.br
so '\-\-log "wm.*"' logs every kind of window\-manager message.
.br
Use "^" prefix to ignore, so '\-\-log "*,^wm.operator.*"' logs all except for 'wm.operators.*'
.br
Use "*" to log everything.
.br

.TP
.B \-\-log\-level <level>
.br
Set the logging verbosity level (higher for more details) defaults to 1,
.br
use \-1 to log all levels.
.br

.TP
.B \-\-log\-show\-basename
.br
Only show file name in output (not the leading path).
.br

.TP
.B \-\-log\-show\-backtrace
.br
Show a back trace for each log message (debug builds only).
.br

.TP
.B \-\-log\-show\-timestamp
.br
Show a timestamp for each log message in seconds since start.
.br

.TP
.B \-\-log\-file <filename>
.br
Set a file to output the log to.
.br

.IP

.SS "Debug Options:"

.TP
.B \-d or \-\-debug
.br
Turn debugging on.
.br

.IP
* Enables memory error detection
.br
* Disables mouse grab (to interact with a debugger in some cases)
.br
* Keeps Python's 'sys.stdin' rather than setting it to None
.br

.TP
.B \-\-debug\-value <value>
.br
Set debug value of <value> on startup.
.br

.IP

.TP
.B \-\-debug\-events
.br
Enable debug messages for the event system.
.br

.TP
.B \-\-debug\-ffmpeg
.br
Enable debug messages from FFmpeg library.
.br

.TP
.B \-\-debug\-handlers
.br
Enable debug messages for event handling.
.br

.TP
.B \-\-debug\-libmv
.br
Enable debug messages from libmv library.
.br

.TP
.B \-\-debug\-cycles
.br
Enable debug messages from Cycles.
.br

.TP
.B \-\-debug\-memory
.br
Enable fully guarded memory allocation and debugging.
.br

.TP
.B \-\-debug\-jobs
.br
Enable time profiling for background jobs.
.br

.TP
.B \-\-debug\-python
.br
Enable debug messages for Python.
.br

.TP
.B \-\-debug\-depsgraph
.br
Enable all debug messages from dependency graph.
.br

.TP
.B \-\-debug\-depsgraph\-eval
.br
Enable debug messages from dependency graph related on evaluation.
.br

.TP
.B \-\-debug\-depsgraph\-build
.br
Enable debug messages from dependency graph related on graph construction.
.br

.TP
.B \-\-debug\-depsgraph\-tag
.br
Enable debug messages from dependency graph related on tagging.
.br

.TP
.B \-\-debug\-depsgraph\-no\-threads
.br
Switch dependency graph to a single threaded evaluation.
.br

.TP
.B \-\-debug\-depsgraph\-time
.br
Enable debug messages from dependency graph related on timing.
.br

.TP
.B \-\-debug\-depsgraph\-pretty
.br
Enable colors for dependency graph debug messages.
.br

.TP
.B \-\-debug\-gpu
.br
Enable gpu debug context and information for OpenGL 4.3+.
.br

.TP
.B \-\-debug\-gpumem
.br
Enable GPU memory stats in status bar.
.br

.TP
.B \-\-debug\-gpu\-shaders
.br
Enable GPU memory stats in status bar.
.br

.TP
.B \-\-debug\-gpu\-force\-workarounds
.br
Enable GPU memory stats in status bar.
.br

.TP
.B \-\-debug\-wm
.br
Enable debug messages for the window manager, shows all operators in search, shows keymap errors.
.br

.TP
.B \-\-debug\-all
.br
Enable all debug messages.
.br

.TP
.B \-\-debug\-io
.br
Enable debug messages for I/O (collada, ...).
.br

.IP

.TP
.B \-\-debug\-fpe
.br
Enable floating point exceptions.
.br

.TP
.B \-\-disable\-crash\-handler
.br
Disable the crash handler.
.br

.TP
.B \-\-disable\-abort\-handler
.br
Disable the abort handler.
.br

.IP

.SS "Misc Options:"

.TP
.B \-\-app\-template <template>
.br
Set the application template (matching the directory name), use 'default' for none.
.br

.TP
.B \-\-factory\-startup
.br
Skip reading the BLENDER_STARTUP_FILE in the users home directory.
.br

.TP
.B \-\-enable\-event\-simulate
.br
Enable event simulation testing feature 'bpy.types.Window.event_simulate'.
.br

.IP

.TP
.B \-\-env\-system\-datafiles
.br
Set the BLENDER_SYSTEM_DATAFILES environment variable.
.br

.TP
.B \-\-env\-system\-scripts
.br
Set the BLENDER_SYSTEM_SCRIPTS environment variable.
.br

.TP
.B \-\-env\-system\-python
.br
Set the BLENDER_SYSTEM_PYTHON environment variable.
.br

.IP

.TP
.B \-noaudio
.br
Force sound system to None.
.br

.TP
.B \-setaudio
.br
Force sound system to a specific device.
.br
'NULL' 'SDL' 'OPENAL' 'JACK'.
.br

.IP

.TP
.B \-h or \-\-help
.br
Print this help text and exit.
.br

.TP
.B \-R
.br
Register blend\-file extension, then exit (Windows only).
.br

.TP
.B \-r
.br
Silently register blend\-file extension, then exit (Windows only).
.br

.TP
.B \-v or \-\-version
.br
Print Blender version and exit.
.br

.TP
.B \-\-
.br
End option processing, following arguments passed unchanged. Access via Python's 'sys.argv'.
.br

.IP

.SS "Other Options:"

.TP
.B /?
.br
Print this help text and exit (windows only).
.br

.TP
.B \-\-debug\-freestyle
.br
Enable debug messages for Freestyle.
.br

.TP
.B \-\-debug\-ghost
.br
Enable debug messages for event handling.
.br

.TP
.B \-\-verbose <verbose>
.br
Set logging verbosity level for debug messages which supports it.
.br

.TP
.B \-\-disable\-library\-override
.br
Enable Library Override features in the UI.
.br

.IP

.SS "Argument Parsing:"

.SS "	Arguments must be separated by white space, eg:"

  # blender \-ba test.blend
  ...will exit since '\-ba' is an unknown argument.
.SS "Argument Order:"

.SS "	Arguments are executed in the order they are given. eg:"

  # blender \-\-background test.blend \-\-render\-frame 1 \-\-render\-output '/tmp'
  ...will not render to '/tmp' because '\-\-render\-frame 1' renders before the output path is set.
  # blender \-\-background \-\-render\-output /tmp test.blend \-\-render\-frame 1
  ...will not render to '/tmp' because loading the blend\-file overwrites the render output that was set.
  # blender \-\-background test.blend \-\-render\-output /tmp \-\-render\-frame 1
  ...works as expected.
.br
.SH "ENVIRONMENT VARIABLES"
  $BLENDER_USER_CONFIG      Directory for user configuration files.
  $BLENDER_USER_SCRIPTS     Directory for user scripts.
  $BLENDER_SYSTEM_SCRIPTS   Directory for system wide scripts.
  $BLENDER_USER_DATAFILES   Directory for user data files (icons, translations, ..).
  $BLENDER_SYSTEM_DATAFILES Directory for system wide data files.
  $BLENDER_SYSTEM_PYTHON    Directory for system Python libraries.
  $TMP or $TMPDIR           Store temporary files here.
  $SDL_AUDIODRIVER          LibSDL audio driver \- alsa, esd, dma.
  $PYTHONHOME               Path to the Python directory, eg. /usr/lib/python.
.br
.br

.br
.SH SEE ALSO
.B luxrender(1)

.br
.SH AUTHORS
This manpage was written for a Debian GNU/Linux system by Daniel Mester
<mester@uni-bremen.de> and updated by Cyril Brulebois
<cyril.brulebois@enst-bretagne.fr> and Dan Eicher <dan@trollwerks.org>.