diff options
author | Erik de Castro Lopo <erikd@mega-nerd.com> | 2014-11-03 19:39:24 -0800 |
---|---|---|
committer | Erik de Castro Lopo <erikd@mega-nerd.com> | 2014-11-03 19:39:30 -0800 |
commit | 576d9edf8f3920a8cc918e143d03ebba834ec808 (patch) | |
tree | 4864ed276b8c00def313ea20eb6ee1d163d3a665 | |
parent | 011dfc1090ccff5ce2e11b89f21c84b44e04d1be (diff) |
Manpage updates/improvementss.
* Explicitly name options instead of just [options].
* Replace needless verbiage by standard macros.
* Order options alphabetically.
* Add a few cross-references.
* Minor punctuation nits.
Patch-from: Jan Stary <hans@stare.cz>
-rw-r--r-- | man/sndfile-cmp.1 | 8 | ||||
-rw-r--r-- | man/sndfile-concat.1 | 9 | ||||
-rw-r--r-- | man/sndfile-convert.1 | 22 | ||||
-rw-r--r-- | man/sndfile-info.1 | 17 | ||||
-rw-r--r-- | man/sndfile-interleave.1 | 12 | ||||
-rw-r--r-- | man/sndfile-metadata-get.1 | 12 | ||||
-rw-r--r-- | man/sndfile-play.1 | 5 | ||||
-rw-r--r-- | man/sndfile-salvage.1 | 9 |
8 files changed, 38 insertions, 56 deletions
diff --git a/man/sndfile-cmp.1 b/man/sndfile-cmp.1 index a78c9a5..d346e2c 100644 --- a/man/sndfile-cmp.1 +++ b/man/sndfile-cmp.1 @@ -1,4 +1,4 @@ -.Dd "June 19, 2014" +.Dd November 2, 2014 .Dt SNDFILE-CMP 1 .Os .Sh NAME @@ -16,11 +16,11 @@ audio data lengths and actual audio data must match. Other differences such as string metadata like song title, artist etc and their presence or absence are ignored. .Sh EXIT STATUS -.Bl -tag -width 0 -compact +.Bl -tag -width 1n -compact .It 0 -The audio data is the same +The audio data is the same. .It 1 -The audio data differs +The audio data differs. .El .Sh SEE ALSO .Lk http://www.mega-nerd.com/libsndfile diff --git a/man/sndfile-concat.1 b/man/sndfile-concat.1 index 0253bb5..2110401 100644 --- a/man/sndfile-concat.1 +++ b/man/sndfile-concat.1 @@ -1,4 +1,4 @@ -.Dd "June 20, 2014" +.Dd November 2, 2014 .Dt SNDFILE-CONCAT 1 .Os .Sh NAME @@ -21,12 +21,7 @@ The only restriction is that the files must have the same number of channels. The output file is overwritten if it already exists. .Sh EXIT STATUS -.Bl -tag -width 0 -compact -.It 0 -The output file was successfully generated. -.It 1 -An error occured. -.El +.Ex -std .Sh SEE ALSO .Lk http://www.mega-nerd.com/libsndfile/ .Sh AUTHORS diff --git a/man/sndfile-convert.1 b/man/sndfile-convert.1 index ed8f53b..d34edcd 100644 --- a/man/sndfile-convert.1 +++ b/man/sndfile-convert.1 @@ -1,4 +1,4 @@ -.Dd "June 30, 2014" +.Dd November 2, 2014 .Dt SNDFILE-CONVERT 1 .Os .Sh NAME @@ -6,7 +6,9 @@ .Nd convert sound files from one format to another .Sh SYNOPSIS .Nm sndfile-convert -.Op Ar options +.Op Fl override-sample-rate Ns = Ns Ar rate +.Op Fl endian Ns = Ns Cm little | big | cpu +.Op Fl normalize .Op Ar encoding .Ar input .Ar output @@ -91,10 +93,11 @@ RF64 (RIFF 64) .Ss Options The following options are recoginzed: .Pp -.Bl -tag -compact -width "override-sample-rate=XXXX" -.It Fl override-sample-rate Ns = Ns Ar X -Make the input use sample rate -.Ar X . +.Bl -tag -compact -width "override-sample-rate=XXXXX" +.It Fl override-sample-rate Ns = Ns Ar rate +Make the input use sample rate of +.Ar rate +Hz. .It Fl endian Ns = Ns Cm little Make the output file use little endian data. .It Fl endian Ns = Ns Cm big @@ -150,12 +153,7 @@ This will not always work as most container formats (e.g. WAV, AIFF etc) only support a small subset of encodings (e.g. 16 bit PCM, a-law, Vorbis etc). .Sh EXIT STATUS -.Bl -tag -width 0 -compact -.It 0 -The conversion was successful. -.It 1 -An error occured. -.El +.Ex -std .Sh SEE ALSO .Lk http://www.mega-nerd.com/libsndfile/ .Sh AUTHORS diff --git a/man/sndfile-info.1 b/man/sndfile-info.1 index bc78b40..68c6a1e 100644 --- a/man/sndfile-info.1 +++ b/man/sndfile-info.1 @@ -1,4 +1,4 @@ -.Dd "June 19, 2014" +.Dd November 2, 2014 .Dt SNDFILE-INFO 1 .Os .Sh NAME @@ -6,7 +6,10 @@ .Nd display information about sound files .Sh SYNOPSIS .Nm sndfile-info -.Op Ar options +.Op Fl -broadcast +.Op Fl -cart +.Op Fl -channel-map +.Op Fl -instrument .Ar .Sh DESCRIPTION .Nm @@ -15,15 +18,15 @@ such as format, number of channels, samplerate, and length. The following options are recognized: .Pp .Bl -tag -compact -width channelmapXXXX -.It Fl -instrument -Display instrument info: -a base note, gain, velocity, key, and loop points. .It Fl -broadcast Display broadcast (BWF) info. -.It Fl -channel-map -Display channel map. .It Fl -cart Display the cart chunk of a WAV (or related) file. +.It Fl -channel-map +Display channel map. +.It Fl -instrument +Display instrument info: +a base note, gain, velocity, key, and loop points. .El .Sh SEE ALSO .Lk http://www.mega-nerd.com/libsndfile/ diff --git a/man/sndfile-interleave.1 b/man/sndfile-interleave.1 index 338dfc9..04498c6 100644 --- a/man/sndfile-interleave.1 +++ b/man/sndfile-interleave.1 @@ -1,8 +1,9 @@ -.Dd "June 19, 2014" +.Dd November 2, 2014 .Dt SNDFILE-INTERLEAVE 1 .Os .Sh NAME -.Nm sndfile-interleave +.Nm sndfile-interleave , +.Nm sndfile-deinterleave .Nd convert mono files into a multi-channel file and vice versa .Sh SYNOPSIS .Nm sndfile-interleave @@ -38,12 +39,7 @@ Apart from the number of channels, the audio format of the resulting mono files is the same as that of the original file. .Sh EXIT STATUS -.Bl -tag -width 0 -compact -.It 0 -The conversion was successfull. -.It 1 -An error occurred. -.El +.Ex -std .Sh EXAMPLES Merge a mono OGG file and a mono FLAC file into a stereo WAV file: .Bd -literal -offset indent diff --git a/man/sndfile-metadata-get.1 b/man/sndfile-metadata-get.1 index 53fa1b8..90aac3a 100644 --- a/man/sndfile-metadata-get.1 +++ b/man/sndfile-metadata-get.1 @@ -1,8 +1,9 @@ -.Dd "June 19, 2014" +.Dd November 2, 2014 .Dt SNDFILE-METADATA-GET 1 .Os .Sh NAME -.Nm sndfile-metadata-get +.Nm sndfile-metadata-get , +.Nm sndfile-metadata-set .Nd get or set metadata in a sound file .Sh SYNOPSIS .Nm sndfile-metadata-get @@ -107,12 +108,7 @@ Set the BEXT date to current. Set the string date to current. .El .Sh EXIT STATUS -.Bl -tag -width 0 -compact -.It 0 -The metadata was written or retrieved successfully. -.It 1 -An error occurred. -.El +.Ex -std .Sh SEE ALSO .Lk http://www.mega-nerd.com/libsndfile/ .Lk http://tech.ebu.ch/docs/tech/tech3285.pdf diff --git a/man/sndfile-play.1 b/man/sndfile-play.1 index a5e5dee..6f69042 100644 --- a/man/sndfile-play.1 +++ b/man/sndfile-play.1 @@ -1,4 +1,4 @@ -.Dd "June 19, 2014" +.Dd November 2, 2014 .Dt SNDFILE-PLAY 1 .Os .Sh NAME @@ -6,8 +6,7 @@ .Nd play a sound file .Sh SYNOPSIS .Nm sndfile-play -.Ar file1 -.Op Ar file2 ... +.Ar .Sh DESCRIPTION .Nm plays one or more sound files on various operating systems using standard audio diff --git a/man/sndfile-salvage.1 b/man/sndfile-salvage.1 index e7f6c11..87e0408 100644 --- a/man/sndfile-salvage.1 +++ b/man/sndfile-salvage.1 @@ -1,4 +1,4 @@ -.Dd "June 19, 2014" +.Dd November 2, 2014 .Dt SNDFILE-SALVAGE 1 .Os .Sh NAME @@ -17,12 +17,7 @@ that are more the 4G in size. rewrites the WAV file into a W64 file with the same audio content. This file is overwritten if it already exists. .Sh EXIT STATUS -.Bl -tag -width 0 -compact -.It 0 -The conversion was succesfull. -.It 1 -An error occured. -.El +.Ex -std .Sh SEE ALSO .Lk http://www.mega-nerd.com/libsndfile/ .\".Lk http://en.wikipedia.org/wiki/RF64 |