summaryrefslogtreecommitdiff
path: root/sound-cutter.8.in
diff options
context:
space:
mode:
Diffstat (limited to 'sound-cutter.8.in')
-rw-r--r--sound-cutter.8.in63
1 files changed, 63 insertions, 0 deletions
diff --git a/sound-cutter.8.in b/sound-cutter.8.in
new file mode 100644
index 0000000..c5b9697
--- /dev/null
+++ b/sound-cutter.8.in
@@ -0,0 +1,63 @@
+.TH sound-cutter 8 "" "sound-cutter #VERSION#" ""
+.SH NAME
+sound-cutter \- Wrapper for sox for mastering stereo music (a.k.a. CDs) from multi channel records
+.SH SYNOPSIS
+\fBsound-cutter [options]\fP
+.SH DESCRIPTION
+\fBsound-cutter\fP mixes, processes and cuts multi channel recordings via \fBsox\fP.
+.SH OPTIONS
+.TP
+.B "\-1, \-\-no\-gain"
+Do not normalize audio (it's faster).
+.TP
+.B "\-f, \-\-force"
+Overwrite output file(s).
+.TP
+.B "\-n, \-\-dummy"
+Only print what would be done.
+.TP
+.B "\-s, \-\-sampleRate"
+Explicitly set output sample rate.
+.TP
+.B "\-i, \-\-input"
+Specify input file, one at a time (can be given multiple times).
+.TP
+.B "\-o, \-\-output"
+Specify output file.
+May be given only once.
+.TP
+.B "\-p, \-\-points"
+Specify points file (see below for syntax).
+May be given only once.
+.TP
+.B "\-a, \-\-ausfuehrlich"
+Give verbose explanations (rudimentary).
+.TP
+.B "\-h, \-\-help"
+Print help and exit.
+.SH POINTS_FILE
+Structure of file containing instructions for mixing, processing and cutting:
+.TP
+.B "# with trailing space"
+starts comment (until end of line)
+.TP
+.B "# without trailing space"
+divides left and right part of line
+.TP
+.B "first line"
+left part denotes global start and stop of recording,
+right part denotes final remix command
+.TP
+.B "other lines with non-empty left part"
+denote border between tracks. Left part is time for cut, right part may be \fBoverlap $someTime\fP to denote fade betweeen tracks and/or \fBnoNewFile\fP to denote that no new
+track should start here (thus it's only a border between \fBsub\fPtracks) or may be left empty.
+.TP
+.B "other lines with empty left part"
+denote modifications of current (sub)track.
+Additional to all sox effects, \fBtrimsplice $position $discard $excess $leeway\fP is also valid.
+This combines splice and trim in a sensible manner.
+These type of lines must not occure successively.
+.SH AUTHOR
+.nf
+Erich Eckner <opensource at eckner dot net>
+.fi