Skip to content

Commit

Permalink
Fixed documentation of colour options
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisn committed May 18, 2022
1 parent df95124 commit 201eb35
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,25 +352,25 @@ are either `audacity`, which generates a blue waveform on a grey background,
similar to Audacity, or `audition`, which generates a green waveform on a
dark background, similar to Adobe Audition.

#### `--border-color`, `-c <rrggbb[aa]>`
#### `--border-color <rrggbb[aa]>`

When creating a waveform image, specifies the border color. If not given,
the default color used is controlled by the `--colors` option.

The color value should include two hexadecimal digits for each of red, green,
and blue (00 to FF), and optional alpha transparency (00 to FF).

#### `--background-color`, `-c <rrggbb[aa]>`
#### `--background-color <rrggbb[aa]>`

When creating a waveform image, specifies the background color. If not given,
the default color used is controlled by the `--colors` option.

#### `--waveform-color`, `-c <rrggbb[aa]>`
#### `--waveform-color <rrggbb[aa]>`

When creating a waveform image, specifies the waveform color. If not given,
the default color used is controlled by the `--colors` option.

#### `--axis-label-color`, `-c <rrggbb[aa]>`
#### `--axis-label-color <rrggbb[aa]>`

When creating a waveform image, specifies the axis labels color. If not given,
the default color used is controlled by the `--colors` option.
Expand Down
10 changes: 5 additions & 5 deletions doc/audiowaveform.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH audiowaveform 1 "2 May 2022"
.TH audiowaveform 1 "18 May 2022"

.SH NAME

Expand Down Expand Up @@ -139,25 +139,25 @@ similar to Audacity, or \fBaudition\fR, which generates a green waveform on a
dark background, similar to Adobe Audition.

.TP
.B --border-color\fR, \fB-c\fR <rrggbb[aa]>
.B --border-color <rrggbb[aa]>
When creating a waveform image, specifies the border color. If not given,
the default color used is controlled by the \fB--colors\fR option.

The color value should include two hexadecimal digits for each of red, green,
and blue (00 to FF), and optional alpha transparency (00 to FF).

.TP
.B --background-color\fR, \fB-c\fR <rrggbb[aa]>
.B --background-color <rrggbb[aa]>
When creating a waveform image, specifies the background color. If not given,
the default color used is controlled by the \fB--colors\fR option.

.TP
.B --waveform-color\fR, \fB-c\fR <rrggbb[aa]>
.B --waveform-color <rrggbb[aa]>
When creating a waveform image, specifies the waveform color. If not given,
the default color used is controlled by the \fB--colors\fR option.

.TP
.B --axis-label-color\fR, \fB-c\fR <rrggbb[aa]>
.B --axis-label-color <rrggbb[aa]>
When creating a waveform image, specifies the axis labels color. If not given,
the default color used is controlled by the \fB--colors\fR option.

Expand Down

0 comments on commit 201eb35

Please sign in to comment.