@@ -17,7 +17,7 @@ Usually, manim is ran from the command line by executing
1717
1818:code: `SceneName ` inside the
1919file <file.py> and render it. One can also specify the render quality by using
20- the flags :code: `-l `, :code: `-m `, :code: `-e `, or :code: `-k `, for low, medium,
20+ the flags :code: `-ql `, :code: `-qm `, :code: `-qh `, or :code: `-qk `, for low, medium,
2121high, and 4k quality, respectively.
2222
2323.. code-block :: bash
@@ -46,89 +46,78 @@ The output looks as follows.
4646.. testoutput ::
4747 :options: -ELLIPSIS, +NORMALIZE_WHITESPACE
4848
49- usage: manim [-h] [-o OUTPUT_FILE] [-p] [-f] [--sound] [--leave_progress_bars]
50- [-a] [-w] [-s] [-g] [-i] [--disable_caching] [--flush_cache]
51- [--log_to_file] [-c BACKGROUND_COLOR]
52- [--background_opacity BACKGROUND_OPACITY] [--media_dir MEDIA_DIR]
53- [--log_dir LOG_DIR] [--tex_template TEX_TEMPLATE] [--dry_run]
54- [-t] [-l] [-m] [-e] [-k] [-r RESOLUTION]
55- [-n FROM_ANIMATION_NUMBER] [--config_file CONFIG_FILE]
56- [--custom_folders] [-v {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
57- [--progress_bar True/False]
58- {cfg} ... file [scene_names [scene_names ...]]
59-
60- Animation engine for explanatory math videos
61-
62- positional arguments:
63- {cfg}
64- file path to file holding the python code for the scene
65- scene_names Name of the Scene class you want to see
66-
67- optional arguments:
68- -h, --help show this help message and exit
69- -o OUTPUT_FILE, --output_file OUTPUT_FILE
70- Specify the name of the output file, if it should be
71- different from the scene class name
72- -p, --preview Automatically open the saved file once its done
73- -f, --show_in_file_browser
74- Show the output file in the File Browser
75- --sound Play a success/failure sound
76- --leave_progress_bars
77- Leave progress bars displayed in terminal
78- -a, --write_all Write all the scenes from a file
79- -w, --write_to_movie Render the scene as a movie file (this is on by
80- default)
81- -s, --save_last_frame
82- Save the last frame only (no movie file is generated)
83- -g, --save_pngs Save each frame as a png
84- -i, --save_as_gif Save the video as gif
85- --disable_caching Disable caching (will generate partial-movie-files
86- anyway)
87- --flush_cache Remove all cached partial-movie-files
88- --log_to_file Log terminal output to file
89- -c BACKGROUND_COLOR, --background_color BACKGROUND_COLOR
90- Specify background color
91- --background_opacity BACKGROUND_OPACITY
92- Specify background opacity
93- --media_dir MEDIA_DIR
94- Directory to store media (including video files)
95- --log_dir LOG_DIR Directory to store log files
96- --tex_template TEX_TEMPLATE
97- Specify a custom TeX template file
98- --dry_run Do a dry run (render scenes but generate no output
99- files)
100- -t, --transparent Render a scene with an alpha channel
101- -l, --low_quality Render at low quality
102- -m, --medium_quality Render at medium quality
103- -e, --high_quality Render at high quality
104- -k, --fourk_quality Render at 4K quality
105- -r RESOLUTION, --resolution RESOLUTION
106- Resolution, passed as "height,width". Overrides the
107- -l, -m, -e, and -k flags, if present
108- -n FROM_ANIMATION_NUMBER, --from_animation_number FROM_ANIMATION_NUMBER
109- Start rendering at the specified animation index,
110- instead of the first animation. If you pass in two
111- comma separated values, e.g. '3,6', it will end the
112- rendering at the second value
113- --config_file CONFIG_FILE
114- Specify the configuration file
115- --custom_folders Use the folders defined in the [custom_folders]
116- section of the config file to define the output folder
117- structure
118- -v {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --verbosity {DEBUG,INFO,WARNING,ERROR,CRITICAL}
119- Verbosity level. Also changes the ffmpeg log level
120- unless the latter is specified in the config
121- --progress_bar True/False
122- Display the progress bar
123-
124- Made with <3 by the manim community devs
49+ usage: manim [-h] [-o OUTPUT_FILE] [-p] [-f] [--leave_progress_bars] [-a] [-w] [-s] [-g] [-i] [--disable_caching] [--flush_cache] [--log_to_file] [-c BACKGROUND_COLOR]
50+ [--background_opacity BACKGROUND_OPACITY] [--media_dir MEDIA_DIR] [--log_dir LOG_DIR] [--tex_template TEX_TEMPLATE] [--dry_run] [-t] [-q {k,h,m,l}] [--low_quality] [--medium_quality]
51+ [--high_quality] [--fourk_quality] [-r RESOLUTION] [-n FROM_ANIMATION_NUMBER] [--use_js_renderer] [--js_renderer_path JS_RENDERER_PATH] [--config_file CONFIG_FILE] [--custom_folders]
52+ [-v {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--progress_bar True/False]
53+ {cfg} ... file [scene_names [scene_names ...]]
54+
55+ Animation engine for explanatory math videos
56+
57+ positional arguments:
58+ {cfg}
59+ file path to file holding the python code for the scene
60+ scene_names Name of the Scene class you want to see
61+
62+ optional arguments:
63+ -h, --help show this help message and exit
64+ -o OUTPUT_FILE, --output_file OUTPUT_FILE
65+ Specify the name of the output file, if it should be different from the scene class name
66+ -p, --preview Automatically open the saved file once its done
67+ -f, --show_in_file_browser
68+ Show the output file in the File Browser
69+ --leave_progress_bars
70+ Leave progress bars displayed in terminal
71+ -a, --write_all Write all the scenes from a file
72+ -w, --write_to_movie Render the scene as a movie file (this is on by default)
73+ -s, --save_last_frame
74+ Save the last frame only (no movie file is generated)
75+ -g, --save_pngs Save each frame as a png
76+ -i, --save_as_gif Save the video as gif
77+ --disable_caching Disable caching (will generate partial-movie-files anyway)
78+ --flush_cache Remove all cached partial-movie-files
79+ --log_to_file Log terminal output to file
80+ -c BACKGROUND_COLOR, --background_color BACKGROUND_COLOR
81+ Specify background color
82+ --background_opacity BACKGROUND_OPACITY
83+ Specify background opacity
84+ --media_dir MEDIA_DIR
85+ Directory to store media (including video files)
86+ --log_dir LOG_DIR Directory to store log files
87+ --tex_template TEX_TEMPLATE
88+ Specify a custom TeX template file
89+ --dry_run Do a dry run (render scenes but generate no output files)
90+ -t, --transparent Render a scene with an alpha channel
91+ -q {k,h,m,l}, --quality {k,h,m,l}
92+ Render at specific quality, short form of the --*_quality flags
93+ --low_quality Render at low quality
94+ --medium_quality Render at medium quality
95+ --high_quality Render at high quality
96+ --fourk_quality Render at 4K quality
97+ -r RESOLUTION, --resolution RESOLUTION
98+ Resolution, passed as "height,width". Overrides any quality flags, if present
99+ -n FROM_ANIMATION_NUMBER, --from_animation_number FROM_ANIMATION_NUMBER
100+ Start rendering at the specified animation index, instead of the first animation. If you pass in two comma separated values, e.g. '3,6', it will end the rendering at the second
101+ value
102+ --use_js_renderer Render animations using the javascript frontend
103+ --js_renderer_path JS_RENDERER_PATH
104+ Path to the javascript frontend
105+ --config_file CONFIG_FILE
106+ Specify the configuration file
107+ --custom_folders Use the folders defined in the [custom_folders] section of the config file to define the output folder structure
108+ -v {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --verbosity {DEBUG,INFO,WARNING,ERROR,CRITICAL}
109+ Verbosity level. Also changes the ffmpeg log level unless the latter is specified in the config
110+ --progress_bar True/False
111+ Display the progress bar
112+
113+ Made with <3 by the manim community devs
125114
126115For example, to render a scene in high quality, but only output the last frame
127116of the scene instead of the whole video, you can execute
128117
129118.. code-block :: bash
130119
131- $ manim < file.py> SceneName -es
120+ $ manim < file.py> SceneName -sqh
132121
133122:code: `-o `
134123flag), renders only the first ten animations (:code: `-n ` flag) with a white
0 commit comments