Skip to content

Commit

Permalink
Update man-page for v0.5
Browse files Browse the repository at this point in the history
  • Loading branch information
x42 committed Mar 16, 2021
1 parent f890b2b commit fb3da92
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ mandir = $(PREFIX)/share/man/man1
PKG_CONFIG ?= pkg-config
CXXFLAGS ?= -Wall -O3 -ffast-math

VERSION?=$(shell (git describe --tags HEAD 2>/dev/null || echo "v0.4") | sed 's/^v//')
VERSION?=$(shell (git describe --tags HEAD 2>/dev/null || echo "v0.5") | sed 's/^v//')

###############################################################################

Expand Down
9 changes: 8 additions & 1 deletion sound-gambit.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.1.
.TH SOUND-GAMBIT "1" "March 2021" "sound-gambit version 0.4" "User Commands"
.TH SOUND-GAMBIT "1" "March 2021" "sound-gambit version 0.5" "User Commands"
.SH NAME
sound-gambit \- Audio File Peak Limiter
.SH SYNOPSIS
Expand All @@ -9,6 +9,9 @@ sound-gambit \- Audio File Peak Limiter
sound\-gambit \- an Audio File Digital Peak Limiter.
.SH OPTIONS
.TP
\fB\-a\fR, \fB\-\-auto\-gain\fR
specify gain relative to peak
.TP
\fB\-i\fR, \fB\-\-input\-gain\fR <db>
input gain in dB (default 0)
.TP
Expand Down Expand Up @@ -42,6 +45,10 @@ Reading via standard\-I/O is supported, use '\-' as file\-name.
Prior to processing, additional input\-gain can be applied. The allowed
range is \fB\-10\fR to +30 dB.
.PP
When auto\-gain is enabled, input\-gain is relative to the given threshold,
and specifies the amount of effective gain\-reduction to be applied.
If input\-gain is zero, the file is only normalized to the given threshold.
.PP
The threshold range is \fB\-10\fR to 0 dBFS, and the limiter will not allow a
single sample above this level.
.PP
Expand Down

0 comments on commit fb3da92

Please sign in to comment.