jamie/wavinfo
1
0
Fork 0
mirror of https://github.com/iluvcapra/wavinfo.git synced 2025-12-31 08:50:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

More documentation changes.

Browse Source
This commit is contained in:
Jamie Hardt
2024-11-25 10:16:26 -08:00
parent d560e5a9f0
commit 206962b218
2 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
data/share/man/man1/wavinfo.1
View File

@@ -3,6 +3,7 @@
wavinfo \- probe wave files for metadata wavinfo \- probe wave files for metadata
.SH SYNOPSIS .SH SYNOPSIS
.SY wavinfo .SY wavinfo
.I "[\-i]"
.I "[\-\-adm]" .I "[\-\-adm]"
.I "[\-\-ixml]" .I "[\-\-ixml]"
.I FILE ... .I FILE ...
@@ -24,6 +25,10 @@ Output any iXML metdata in
.BR FILE . .BR FILE .
.IP "\-h, \-\-help" .IP "\-h, \-\-help"
Print brief help. Print brief help.
.IP "\-i"
Enter
.I "interactive mode"
and browse metadata in FILE with an interactive command prompt.
.SH DETAILED DESCRIPTION .SH DETAILED DESCRIPTION
.B wavinfo .B wavinfo
collects metadata according to different collects metadata according to different

9
docs/source/command_line.rst
View File

@@ -9,12 +9,14 @@ from the command line and output metadata to stdout.
$ wavinfo [[-i] | [--ixml | --adm]] INFILE + $ wavinfo [[-i] | [--ixml | --adm]] INFILE +
Options Options
------- -------
By default, `wavinfo` will output a JSON dictionary for each file argument. By default, `wavinfo` will output a JSON dictionary for each file argument.
``-i``
`wavinfo` will run in `interactive mode`_.
Two option flags will change the behavior of the command in non-interactive Two option flags will change the behavior of the command in non-interactive
mode: mode:
@@ -28,9 +30,8 @@ mode:
payload of each input wave file, or will emit an error message to stderr if payload of each input wave file, or will emit an error message to stderr if
ADM XML metadata is not present. ADM XML metadata is not present.
These options are mutually-exclusive, with `\-\-adm` taking precedence. These options are mutually-exclusive, with `\-\-adm` taking precedence. The
``--ixml`` and ``--adm`` flags futher take precedence over ``-i``.
If ``-i`` is given, `wavinfo` will run in `interactive mode`_.
Interactive Mode Interactive Mode