summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index a3adaf4..8ce5e12 100644
--- a/README.md
+++ b/README.md
@@ -110,6 +110,21 @@ ffargs=(
> **Security:** presets are executed as shell code. Only use presets from
> trusted sources.
+A preset may carry an optional one-line description as a shell comment:
+
+```sh
+# description: Encode to AV1 with SVT-AV1 at a balanced quality/speed trade-off
+ffargs=(
+ -c:v:0 libsvtav1
+ -crf 30
+ -preset 6
+ -pix_fmt "$output_pixel_format"
+)
+```
+
+Run `transcode.sh --list-presets` to enumerate all presets in the preset
+directory and display their descriptions.
+
### Configuration file
An optional TOML configuration file can be placed at:
@@ -194,6 +209,7 @@ transcode.sh [OPTION] [--] FILE...
| `-v`, `--verbose` | More detailed output |
| `--color` / `--no-color` | Force or disable colored output |
| `--version` | Print version information |
+| `--list-presets` | List available presets (name + description) and exit |
| `-h`, `-?`, `--help` | Show help and exit |
### Examples