From 206962b2183605e6407de98c33d951a288541b38 Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Mon, 25 Nov 2024 10:16:26 -0800 Subject: [PATCH] More documentation changes. --- data/share/man/man1/wavinfo.1 | 5 +++++ docs/source/command_line.rst | 9 +++++---- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/data/share/man/man1/wavinfo.1 b/data/share/man/man1/wavinfo.1 index 58fd7d6..9719979 100644 --- a/data/share/man/man1/wavinfo.1 +++ b/data/share/man/man1/wavinfo.1 @@ -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 diff --git a/docs/source/command_line.rst b/docs/source/command_line.rst index 0d5d298..78a1a27 100644 --- a/docs/source/command_line.rst +++ b/docs/source/command_line.rst @@ -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