aboutsummaryrefslogtreecommitdiff
path: root/transcode.sh.1
diff options
context:
space:
mode:
authorDennis Fink2026-05-14 09:56:14 +0200
committerDennis Fink2026-05-14 09:56:14 +0200
commitdc3d2cb05800d866972b7ba32022428e8474beaa (patch)
treeee82bb4327456004b934293b996ad186c98e5c17 /transcode.sh.1
parent1674b2212e3606c3e74f454f066d5253c53b274d (diff)
downloadtranscode.sh-dc3d2cb05800d866972b7ba32022428e8474beaa.tar.gz
transcode.sh-dc3d2cb05800d866972b7ba32022428e8474beaa.zip
feat(size-report): replace savings log with status reports
Rename the old savings log feature to size report across the CLI, configuration, documentation, man page, and bash completion. The new `--size-report` option keeps the existing `-s` shorthand, while `--saving`, `--saving-file`, and the `[saving]` config section are replaced by `--size-report`, `--size-report-file`, and `[size_report]`. Extend reporting beyond successful encodes. The TSV log now gains a leading `status` column and records encoded files, codec skips, only-if-larger skips, and failed inputs. Size-report output also prints per-file feedback for encoded and skipped-larger files, including human-readable original/new sizes, bytes saved, and saved percentage. Track batch-level report counters and print an end-of-run summary for multi-file runs with encoded/skipped/failed counts, total bytes saved, and the overall weighted saving percentage across successful encodes. Document the new TSV schema in the README and man page, update examples and config snippets, and adjust bash completion for the renamed options. BREAKING CHANGE: `--saving` is now `--size-report`. `--saving-file` is now `--size-report-file`. `[saving]` in config.toml is now `[size_report]`. The TSV log gains a leading `status` column and may contain skipped and failed rows in addition to successful encodes.
Diffstat (limited to 'transcode.sh.1')
-rw-r--r--transcode.sh.150
1 files changed, 36 insertions, 14 deletions
diff --git a/transcode.sh.1 b/transcode.sh.1
index 17d9e29..c95f74e 100644
--- a/transcode.sh.1
+++ b/transcode.sh.1
@@ -126,16 +126,20 @@ with the given niceness value. Defaults to
.BR 19
(lowest priority).
.TP
-.BR \-s ", " \-\-saving
-After each successful encode, append a line to the savings log file
-recording the filename, original size in bytes, new size in bytes and the
-percentage saved.
+.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 \-\-saving\-file " \fIPATH\fR, " \-\-saving\-file= \fIPATH\fR
-Path to the savings log file written by
-.BR \-\-saving .
+.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_savings
+.B transcode_size_report
in the current working directory.
.TP
.BR \-S " \fILIST\fR, " \-\-skip\-codec " \fILIST\fR, " \-\-skip\-codec= \fILIST\fR
@@ -222,6 +226,25 @@ which prints every command as it is executed.
.B XDG_CONFIG_HOME
Base directory for user configuration. Defaults to
.BR $HOME/.config .
+.SH SIZE REPORT TSV
+When
+.BR \-\-size\-report
+is enabled, the TSV log uses this schema:
+.PP
+.RS
+.nf
+status filename original_bytes new_bytes saved_pct
+.fi
+.RE
+.PP
+The status column is one of
+.BR encoded ,
+.BR skipped_codec ,
+.BR skipped_larger
+or
+.BR failed .
+Failed rows may leave output-size fields empty when no encoded output exists.
+.PP
.SH FILES
.TP
.IR "${XDG_CONFIG_HOME:-$HOME/.config}/transcode.sh/presets/<name>.sh"
@@ -350,14 +373,13 @@ Defaults to
Array of strings. Merged with any codecs from
.BR \-S .
.TP
-.B [saving] enabled
+.B [size_report] enabled
Boolean. Equivalent to
-.BR \-s .
+.BR \-s / \-\-no\-size\-report .
.TP
-.B [saving] file
+.B [size_report] file
String. Equivalent to
-.BR \-\-saving\-file .
-.TP
+.BR \-\-size\-report\-file .
.B [output] verbose
Boolean. Equivalent to
.BR \-v .
@@ -409,7 +431,7 @@ transcode.sh video.mp4
.fi
.RE
.PP
-Transcode a batch of files listed in a file and log size savings:
+Transcode a batch of files listed in a file and print/write a size report:
.PP
.RS
.nf