More documentation changes.

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

View File

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

View File

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