Skip to content

Commit 7379036

Browse files
committed
docs: added output of ffzap --help to readme
1 parent 50282eb commit 7379036

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,63 @@ visit [ffmpeg's documentation](https://ffmpeg.org/ffmpeg.html).
5050
- (just for installing / building) a working installation of
5151
the [Rust programming language](https://www.rust-lang.org/tools/install)
5252

53+
### Available options
54+
55+
<details>
56+
<summary>Click here to expand section</summary>
57+
58+
```bash
59+
$ ffzap --help
60+
⚡ A multithreaded CLI for digital media processing using ffmpeg. If ffmpeg can do it, ffzap can do it - as many files in parallel as your system can handle.
61+
62+
Usage: ffzap [OPTIONS] --ffmpeg-options <FFMPEG_OPTIONS> --output <OUTPUT>
63+
64+
Options:
65+
-t, --thread-count <THREAD_COUNT>
66+
The amount of threads you want to utilize. most systems can handle 2. Go higher if you have a powerful computer. Default is 2. Can't be lower than 1
67+
68+
[default: 2]
69+
70+
-f, --ffmpeg-options <FFMPEG_OPTIONS>
71+
Options you want to pass to ffmpeg. For the output file name, use --output
72+
73+
-i, --input-directory <INPUT_DIRECTORY>...
74+
The files you want to process
75+
76+
--input-file <INPUT_FILE>
77+
Path to a file containing paths to process. One path per line
78+
79+
--overwrite
80+
If ffmpeg should overwrite files if they already exist. Default is false
81+
82+
--verbose
83+
If verbose logs should be shown while ffzap is running
84+
85+
--delete
86+
Delete the source file after it was successfully processed. If the process fails, the file is kept
87+
88+
-o, --output <OUTPUT>
89+
Specify the output file pattern. Use placeholders to customize file paths:
90+
91+
{{dir}} - Entire specified file path, e.g. ./path/to/file.txt -> ?./path/to/
92+
93+
{{name}} - Original file's name (without extension)
94+
95+
{{ext}} - Original file's extension
96+
97+
Example: /destination/{{dir}}/{{name}}_transcoded.{{ext}}
98+
99+
Outputs the file in /destination, mirroring the original structure and keeping both the file extension and name, while adding _transcoded to the name.
100+
101+
-h, --help
102+
Print help (see a summary with '-h')
103+
104+
-V, --version
105+
Print version
106+
```
107+
108+
</details>
109+
53110
### License
54111
55112
You are free to:

0 commit comments

Comments
 (0)