script to create a man page from blenders --help text, replaced the hand edited man...
[blender.git] / doc / blender.1
index 68f00d8eb9b2bf36f0ff33e301c280af2c045bda..43ac5638765912afedb47ae07952acad430e2352 100644 (file)
@@ -1,10 +1,9 @@
-.TH "BLENDER" "1" "June 06, 2010" "Blender 2\&.5\&.2"
+.TH "BLENDER" "1" "June 27, 2010" "Blender Blender 2\&.52 (sub 5) "
+
 .SH NAME
 blender \- a 3D modelling and rendering package
 .SH SYNOPSIS
 .B blender [args ...] [file] [args ...]
-
-
 .br
 .SH DESCRIPTION
 .PP
@@ -15,209 +14,318 @@ Use Blender to create TV commercials, to make technical visualizations, business
 
 http://www.blender.org
 .SH OPTIONS
-.SS "Render options:"
+
+Blender 2.52 (sub 5) Build
+Usage: blender [args ...] [file] [args ...]
+.br
+.SS "Render Options:"
 
 .TP
-.B \-b, \-\-background <file>
-Load <file> in background (often used for UI-less rendering)
+.B \-b or \-\-background <file>
+.br
+Load <file> in background (often used for UI\-less rendering)
+.br
 
 .TP
-.B \-a, \-\-render-anim 
+.B \-a or \-\-render\-anim
+.br
 Render frames from start to end (inclusive)
+.br
 
 .TP
-.B \-S, \-\-scene <name>
+.B \-S or \-\-scene <name>
+.br
 Set the active scene <name> for rendering
+.br
 
 .TP
-.B \-f, \-\-render-frame <frame>
-Render frame <frame> and save it
+.B \-f or \-\-render\-frame <frame>
+.br
+Render frame <frame> and save it.
+.br
++<frame> start frame relative, \-<frame> end frame relative.
+.br
 
 .TP
-.B \-s, \-\-frame-start <frame>
+.B \-s or \-\-frame\-start <frame>
+.br
 Set start to frame <frame> (use before the \-a argument)
+.br
 
 .TP
-.B \-e, \-\-frame-end <frame>
+.B \-e or \-\-frame\-end <frame>
+.br
 Set end to frame <frame> (use before the \-a argument)
+.br
 
 .TP
-.B \-j, \-\-frame-jump <frames>
+.B \-j or \-\-frame\-jump <frames>
+.br
 Set number of frames to step forward after each rendered frame
+.br
 
 .TP
-.B \-o, --render-output <path>
+.B \-o or \-\-render\-output <path>
+.br
 Set the render path and file name.
-.IP
-Use // at the start of the path to render relative to the blend file.
-.IP
+.br
+Use // at the start of the path to
+.br
+    render relative to the blend file.
+.br
 The # characters are replaced by the frame number, and used to define zero padding.
-.IP
+.br
     ani_##_test.png becomes ani_01_test.png
-    test-######.png becomes test-000001.png
+.br
+    test\-######.png becomes test\-000001.png
+.br
     When the filename does not contain #, The suffix #### is added to the filename
-.IP
+.br
 The frame number will be added at the end of the filename.
-    eg: blender -b foobar.blend -o //render_ -F PNG -x 1 -a
+.br
+    eg: blender \-b foobar.blend \-o //render_ \-F PNG \-x 1 \-a
+.br
     //render_ becomes //render_####, writing frames as //render_0001.png//
+.br
 
-.HP
-.B \-E, \-\-engine <engine>
+.TP
+.B \-E or \-\-engine <engine>
+.br
 Specify the render engine
-use \fI\-E help\fR to list available engines
+.br
+use \-E help to list available engines
+.br
+
+.IP
 
-.SS "Format options:"
+.SS "Format Options:"
 
 .TP
-.B \-F, \-\-render-format <format>
-Set the render format, valid options are...
-.IP
-TGA IRIS JPEG MOVIE IRIZ RAWTGA
-AVIRAW AVIJPEG PNG BMP FRAMESERVER
-.IP
+.B \-F or \-\-render\-format <format>
+.br
+Set the render format, Valid options are...
+.br
+    TGA IRIS JPEG MOVIE IRIZ RAWTGA
+.br
+    AVIRAW AVIJPEG PNG BMP FRAMESERVER
+.br
 (formats that can be compiled into blender, not available on all systems)
-.IP
-HDR TIFF EXR MULTILAYER MPEG AVICODEC QUICKTIME CINEON DPX DDS
+.br
+    HDR TIFF EXR MULTILAYER MPEG AVICODEC QUICKTIME CINEON DPX DDS
+.br
 
 .TP
-.B \-x, \-\-use-extension <bool>
+.B \-x or \-\-use\-extension <bool>
+.br
 Set option to add the file extension to the end of the file
+.br
 
 .TP
-.B \-t, \-\-threads <threads>
+.B \-t or \-\-threads <threads>
+.br
 Use amount of <threads> for rendering in background
-[1-BLENDER_MAX_THREADS], 0 for systems processor count.
+.br
+[1\-BLENDER_MAX_THREADS], 0 for systems processor count.
+.br
+
+.IP
 
-.SS "Animation options:"
+.SS "Animation Playback Options:"
 
 .TP
 .B \-a <options> <file(s)>
+.br
 Playback <file(s)>, only operates this way when not running in background.
-.IP
-\-p <sx> <sy> \-\- Open with lower left corner at <sx>, <sy>
 .br
-\-m  \-\- Read from disk (Don't buffer)
+    \-p <sx> <sy> Open with lower left corner at <sx>, <sy>
+.br
+    \-m Read from disk (Don't buffer)
 .br
-\-f <fps> <fps-base> \-\- Specify FPS to start with
+    \-f <fps> <fps\-base> Specify FPS to start with
 .br
-\-j <frame> \-\- Set frame step to <frame>
+    \-j <frame> Set frame step to <frame>
+.br
+
+.IP
 
-.SS "Window options:"
+.SS "Window Options:"
 
 .TP
-.B \-w, \-\-window-border
+.B \-w or \-\-window\-border
+.br
 Force opening with borders (default)
+.br
 
 .TP
-.B \-W, \-\-window-borderless
+.B \-W or \-\-window\-borderless
+.br
 Force opening with without borders
+.br
 
 .TP
-.B \-p, --window-geometry <sx> <sy> <w> <h>
-Open with lower left corner at <sx>, <sy> and width and height <w>, <h>
+.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
+
+.IP
+
+.SS "Game Engine Specific Options:"
 
-.SS "Game Engine specific options:"
-.TP
-.B \-g fixedtime
-Run on 50 hertz without dropping frames
-.TP
-.B \-g vertexarrays
-Use Vertex Arrays for rendering (usually faster)
-.TP
-.B \-g nomipmap
-No Texture Mipmapping
 .TP
-.B \-g linearmipmap
-Linear Texture Mipmapping instead of Nearest (default)
-.SS "Misc options:"
+.B \-g Game Engine specific options
+.br
+\-g fixedtime Run on 50 hertz without dropping frames
+.br
+\-g vertexarrays Use Vertex Arrays for rendering (usually faster)
+.br
+\-g nomipmap No Texture Mipmapping
+.br
+\-g linearmipmap Linear Texture Mipmapping instead of Nearest (default)
+.br
+
+.IP
+
+.SS "Misc Options:"
+
 .TP
-.B \-d, \-\-debug
+.B \-d or \-\-debug
+.br
 Turn debugging on
+.br
+
 .IP
-Prints every operator call and their arguments
+* Prints every operator call and their arguments
+.br
+* Disables mouse grab (to interact with a debugger in some cases)
 .br
-Disables mouse grab (to interact with a debugger in some cases)
+* Keeps python sys.stdin rather then setting it to None
 .br
-Keeps python sys.stdin rather then setting it to None
 
 .TP
-.B \--debug-fpe 
+.B \-\-debug\-fpe
+.br
 Enable floating point exceptions
+.br
 
-.TP
-.B \-noaudio
-Disable audio on systems that support audio
+.IP
 
 .TP
-.B \-nojoystick 
+.B \-nojoystick
+.br
 Disable joystick support
+.br
 
 .TP
-.B \-noglsl 
+.B \-noglsl
+.br
 Disable GLSL shading
+.br
+
+.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
+
+.IP
 
 .TP
-.B \-y, \-\-enable-autoexec 
+.B \-y or \-\-enable\-autoexec
+.br
 Enable automatic python script execution (default)
+.br
 
 .TP
-.B \-Y, \-\-disable-autoexec 
+.B \-Y or \-\-disable\-autoexec
+.br
 Disable automatic python script execution (pydrivers, pyconstraints, pynodes)
+.br
+
+.IP
 
 .TP
-.B \-P <filename>
+.B \-P or \-\-python <filename>
+.br
 Run the given Python script (filename or Blender Text)
+.br
 
 .TP
-.B \-\-python-console 
+.B \-\-python\-console
+.br
 Run blender with an interactive console
+.br
 
 .TP
-.B \-v, \-\-version 
+.B \-v or \-\-version
+.br
 Print Blender version and exit
+.br
 
 .TP
-.B \-\- 
+.B \-\-
+.br
 Ends option processing, following arguments passed unchanged. Access via python's sys.argv
+.br
 
-.TP
-.B \-h, \-\-help 
-Show a summary of options.
-
-.SH "ENVIRONMENT VARIABLES"
-
-.PP
-\fIHOME\fR
-.RS 4
-Store files such as .blender/ .B.blend .Bfs .Blog here.
-.RE
+.SS "Other Options:"
 
-.PP
-\fIBLENDERPATH\fR
-.RS 4
-System directory to use for data files and scripts.
-For this build of blender the default BLENDERPATH is...
-"/usr/share/blender"
-setting the $BLENDERPATH will override this
-.RE
+.TP
+.B /?
+.br
+Print this help text and exit (windows only)
+.br
 
-.PP
-\fITMP\fR or \fITMPDIR\fR
-.RS 4
-Store temporary files here.
-.RE
+.TP
+.B \-R
+.br
+Register .blend extension (windows only)
+.br
 
-.PP
-\fISDL_AUDIODRIVER\fR
-.RS 4
-LibSDL audio driver - alsa, esd, alsa, dma.
-.RE
+.SS "Argument Parsing:"
 
-.PP
-\fIPYTHONHOME\fR
-.RS 4
-Path to the python directory, eg. /usr/lib/python.
-.RE
+    arguments must be separated by white space. eg
+        "blender \-ba test.blend"
+    ...will ignore the 'a'
+        "blender \-b test.blend \-f8"
+    ...will ignore 8 because there is no space between the \-f and the frame value
+.br
+.SS "Argument Order:"
+
+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
+.br
+.SH "ENVIRONMENT VARIABLES"
+  \fIHOME\fR Store files such as .blender/ .B.blend .Bfs .Blog here.
+  \fIBLENDERPATH\fR System directory to use for data files and scripts.
+                For this build of blender the default \fIBLENDERPATH\fR is...
+                "/usr/local/share/blender/2.5"
+                setting the \fIBLENDERPATH\fR will override this
+  \fITMP\fR or \fITMPDIR\fR Store temporary files here.
+  \fIPYTHONHOME\fR Path to the python directory, eg. /usr/lib/python.
+.br
+.br
 
 .br
 .SH SEE ALSO
@@ -228,5 +336,3 @@ Path to the python directory, eg. /usr/lib/python.
 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>.
-
-