aboutsummaryrefslogtreecommitdiff
path: root/transcode.sh.1
diff options
context:
space:
mode:
authorDennis Fink2026-05-24 17:09:09 +0200
committerDennis Fink2026-05-24 17:09:09 +0200
commit8804eba7a519bccc6c0ae6b90d666d4e1c09eaf0 (patch)
treeb696ce8851e4297cea664f3fd230d926da94b7ae /transcode.sh.1
parenta049faf194165e74c8d75c85bb4473fedf7e6dbd (diff)
downloadtranscode.sh-8804eba7a519bccc6c0ae6b90d666d4e1c09eaf0.tar.gz
transcode.sh-8804eba7a519bccc6c0ae6b90d666d4e1c09eaf0.zip
docs(cli): regroup option documentation
Reorganize CLI options into matching sections across help output, README, man page, and bash completion. Split input, encoding, skip, processing, size report, display, and general options so related flags are easier to find and the documented order matches the parser more closely. Add --no-config to the README and man page while updating bash completion order to follow the new help structure.
Diffstat (limited to '')
-rw-r--r--transcode.sh.1160
1 files changed, 85 insertions, 75 deletions
diff --git a/transcode.sh.1 b/transcode.sh.1
index 524ba68..caa4c1a 100644
--- a/transcode.sh.1
+++ b/transcode.sh.1
@@ -45,30 +45,7 @@ playable media file before the original is replaced. If the integrity
check fails the temporary file is removed and the encode is treated as a
runtime failure, leaving the original untouched.
.SH OPTIONS
-.TP
-.BR \-c ", " \-\-continue
-Continue processing the next file even if
-.BR ffmpeg (1)
-fails on the current one. Without this flag the script exits immediately
-on the first failure.
-.TP
-.BR \-\-no\-continue
-Do not continue processing next file even if
-.BR ffmpeg (1)
-fails on the current one.
-.TP
-.BR \-\-verify\-output
-After encoding, probe the temporary output file with
-.BR ffprobe (1)
-to confirm it is a valid, playable media file before replacing the
-original. Enabled by default.
-.TP
-.BR \-\-no\-verify\-output
-Skip the post-encode integrity check. The original is replaced as long
-as
-.BR ffmpeg (1)
-exits successfully. Useful for large batch jobs on trusted encoders
-where the additional probe round-trip is undesirable.
+.SS "Input options"
.TP
.BR \-\-config\-file " \fIPATH\fR, " \-\-config\-file= \fIPATH\fR
Load configuration from \fIPATH\fR instead of the default location
@@ -79,23 +56,26 @@ Requires
.BR tomlq (1)
when the file is present.
.TP
+.BR \-\-no\-config
+Do not load any configuration file.
+.TP
.BR \-f " \fIPATH\fR, " \-\-encode-file " \fIPATH\fR, " \-\-encode-file= \fIPATH\fR
Read the list of files to encode from \fIPATH\fR (one file per line)
instead of taking files from the command line.
+.SS "Encoding options"
.TP
-.BR \-n ", " \-\-dry\-run
-Print what would be done without actually invoking
-.BR ffmpeg (1).
-Combine with
-.B \-v
-to see the selected video stream and detected codec, pixel format and frame
-rate information.
+.BR \-p " \fINAME\fR, " \-\-preset " \fINAME\fR, " \-\-preset= \fINAME\fR
+Load the preset named \fINAME\fR from the preset directory. Defaults to
+.BR default .
.TP
-.BR \-\-backup\-dir " \fIDIR\fR, " \-\-backup\-dir= \fIDIR\fR
-Copy originals to \fIDIR\fR before replacing them after successful encoding.
-\fIDIR\fR must already exist; the script exits with a usage error if it does
-not. Backups preserve the source file's absolute path below \fIDIR\fR, and
-existing backup files are not overwritten.
+.BR \-N " \fIVALUE\fR, " \-\-nice " \fIVALUE\fR, " \-\-nice= \fIVALUE\fR
+Run
+.BR ffmpeg (1)
+under
+.BR nice (1)
+with the given niceness value. Defaults to
+.BR 19
+(lowest priority).
.TP
.BR \-\-hwaccel " [\fIMETHOD\fR], " \-\-hwaccel= \fIMETHOD\fR
Pass
@@ -138,31 +118,7 @@ or
.BR v:1 .
This option does not change ffmpeg stream mapping; presets remain responsible
for selecting which stream to encode.
-.TP
-.BR \-N " \fIVALUE\fR, " \-\-nice " \fIVALUE\fR, " \-\-nice= \fIVALUE\fR
-Run
-.BR ffmpeg (1)
-under
-.BR nice (1)
-with the given niceness value. Defaults to
-.BR 19
-(lowest priority).
-.TP
-.BR \-s ", " \-\-size\-report
-Print per-file size feedback after successful encodes and size-based skips,
-then write a TSV status log for encoded, skipped and failed files. For runs
-with more than one input file, print a final summary with encoded, skipped
-and failed counts, total bytes saved and the overall saved percentage.
-.TP
-.BR \-\-no\-size\-report
-Disable size reporting from the configuration file.
-.TP
-.BR \-\-size\-report\-file " \fIPATH\fR, " \-\-size\-report\-file= \fIPATH\fR
-Path to the TSV status log written by
-.BR \-\-size\-report .
-Defaults to
-.B transcode_size_report
-in the current working directory.
+.SS "Skip options"
.TP
.BR \-S " \fILIST\fR, " \-\-skip\-codec " \fILIST\fR, " \-\-skip\-codec= \fILIST\fR
Comma-, space- or colon-separated list of video codec names to skip.
@@ -182,6 +138,21 @@ and use only codecs provided through
.BR \-S / \-\-skip\-codec
for this run. The position of this flag on the command line does not matter;
it changes how the final skip list is resolved after all options are parsed.
+.SS "Processing options"
+.TP
+.BR \-n ", " \-\-dry\-run
+Print what would be done without actually invoking
+.BR ffmpeg (1).
+Combine with
+.B \-v
+to see the selected video stream and detected codec, pixel format and frame
+rate information.
+.TP
+.BR \-\-backup\-dir " \fIDIR\fR, " \-\-backup\-dir= \fIDIR\fR
+Copy originals to \fIDIR\fR before replacing them after successful encoding.
+\fIDIR\fR must already exist; the script exits with a usage error if it does
+not. Backups preserve the source file's absolute path below \fIDIR\fR, and
+existing backup files are not overwritten.
.TP
.BR \-l ", " \-\-only\-if\-smaller
After encoding, replace the original only when the new file is strictly
@@ -191,9 +162,47 @@ and the original is kept unchanged.
.BR \-\-no\-only\-if\-smaller
After encoding, replace the original also if the new file is bigger.
.TP
-.BR \-p " \fINAME\fR, " \-\-preset " \fINAME\fR, " \-\-preset= \fINAME\fR
-Load the preset named \fINAME\fR from the preset directory. Defaults to
-.BR default .
+.BR \-\-verify\-output
+After encoding, probe the temporary output file with
+.BR ffprobe (1)
+to confirm it is a valid, playable media file before replacing the
+original. Enabled by default.
+.TP
+.BR \-\-no\-verify\-output
+Skip the post-encode integrity check. The original is replaced as long
+as
+.BR ffmpeg (1)
+exits successfully. Useful for large batch jobs on trusted encoders
+where the additional probe round-trip is undesirable.
+.TP
+.BR \-c ", " \-\-continue
+Continue processing the next file even if
+.BR ffmpeg (1)
+fails on the current one. Without this flag the script exits immediately
+on the first failure.
+.TP
+.BR \-\-no\-continue
+Do not continue processing next file even if
+.BR ffmpeg (1)
+fails on the current one.
+.SS "Size report options"
+.TP
+.BR \-s ", " \-\-size\-report
+Print per-file size feedback after successful encodes and size-based skips,
+then write a TSV status log for encoded, skipped and failed files. For runs
+with more than one input file, print a final summary with encoded, skipped
+and failed counts, total bytes saved and the overall saved percentage.
+.TP
+.BR \-\-no\-size\-report
+Disable size reporting from the configuration file.
+.TP
+.BR \-\-size\-report\-file " \fIPATH\fR, " \-\-size\-report\-file= \fIPATH\fR
+Path to the TSV status log written by
+.BR \-\-size\-report .
+Defaults to
+.B transcode_size_report
+in the current working directory.
+.SS "Display options"
.TP
.BR \-\-ffmpeg\-loglevel " \fILEVEL\fR, " \-\-ffmpeg\-loglevel= \fILEVEL\fR
Pass
@@ -203,9 +212,6 @@ to
Defaults to
.BR fatal .
.TP
-.BR \-h ", " \-\-help ", " \-?
-Print a short help message and exit.
-.TP
.BR \-q ", " \-\-quiet
Suppress all normal output. Takes precedence over
.BR \-v / \-\-verbose .
@@ -214,6 +220,18 @@ Suppress all normal output. Takes precedence over
Emit additional informational messages, including the selected video stream and
detected codec, pixel format and frame rate.
.TP
+.B \-\-color
+Force colored output even when stdout is not a terminal or
+.B NO_COLOR
+is set.
+.TP
+.B \-\-no\-color
+Disable colored output unconditionally.
+.SS "General options"
+.TP
+.BR \-h ", " \-\-help ", " \-?
+Print a short help message and exit.
+.TP
.B \-\-version
Print version, author and license information and exit.
.TP
@@ -226,14 +244,6 @@ If the preset directory does not exist or contains no
.B .sh
files, a notice is printed instead.
.TP
-.B \-\-color
-Force colored output even when stdout is not a terminal or
-.B NO_COLOR
-is set.
-.TP
-.B \-\-no\-color
-Disable colored output unconditionally.
-.TP
.B \-\-
End of options. All subsequent arguments are treated as file names even
if they begin with