0.4 release, updated man page, CHANGES and README #22

CHANGES.md

@@ -1,5 +1,9 @@
 # hear version history
 
+## v0.4 - 21/04/2023
+
+* Now supports -p flag to enable adding punctuation to speech recognition results (macOS 13+ only)
+
 ## v0.3 - 25/03/2023
 
 * Now supports -x flag to specify "exit word", i.e. a word that causes the program to quit when heard

README.md

@@ -29,7 +29,7 @@ See the [man page](https://sveinbjorn.org/files/manpages/hear.1.html) for furthe
 [available](https://github.com/sveinbjornt/hear) under a [BSD license](#bsd-license). 
 **If you find this program useful, please [make a donation](https://sveinbjorn.org/donations).**
 
-* **[⇩ Download hear 0.3](https://sveinbjorn.org/files/software/hear.zip)** 
+* **[⇩ Download hear 0.4](https://sveinbjorn.org/files/software/hear.zip)** 
 (Intel/ARM 64-bit, macOS 10.15 or later, ~50 KB)
 
 ## Installation

hear.1

@@ -6,22 +6,22 @@
 .Nd macOS speech recognition via the command line
 .Sh SYNOPSIS
 .Nm
-.Op Fl hvdms
+.Op Fl hvdmps
 .Op Fl i Ar audio_file
 .Op Fl l Ar language
 .Op Fl x Ar exit_word
 .Sh DESCRIPTION
 .Nm
 is a command line interface for the built-in speech recognition
 capabilities in macOS. It supports transcription of both audio files
-and microphone input. If no input is provided, the default behaviour
+and microphone input. If no input file is provided, the default behaviour
 is to transcribe from the default audio input device, typically the
 microphone.
 .Pp
 The following flags are supported:
 .Bl -tag -width -indent
 .It Fl s -supported
-Print list of supported languages (locales) for speech recognition.
+Print list of supported languages (locales) for speech recognition and exit.
 .It Fl l -language Ar lang
 Specify speech recognition language (locale). Default is 'en-US'.
 .It Fl i -input Ar audio_file
@@ -38,7 +38,7 @@ Enable single-line output mode (only applies when the input is default audio
 input device, e.g. microphone).
 .It Fl p -punctuation
 Add punctuation to speech recognition results.
-.It Fl x -exit
+.It Fl x -exit Ar exit_word
 Set exit word. This causes hear to exit when a speech recognition result ends
 with the word in question.
 .It Fl h -help

hear.1.html

@@ -6,14 +6,15 @@
 
 <b>SYNOPSIS</b>
 
-     <b>hear</b> [<b>-hvdms</b>] [<b>-i</b> <u>audio</u><b>_<u></b>file</u>] [<b>-l</b> <u>language</u>] [<b>-x</b> <u>exit</u><b>_<u></b>word</u>]
+     <b>hear</b> [<b>-hvdmps</b>] [<b>-i</b> <u>audio</u><b>_<u></b>file</u>] [<b>-l</b> <u>language</u>] [<b>-x</b> <u>exit</u><b>_<u></b>word</u>]
 
 <b>DESCRIPTION</b>
 
      <b>hear</b> is a command line interface for the built-in speech recognition
      capabilities in macOS. It supports transcription of both audio files and
-     microphone input. If no input is provided, the default behaviour is to
-     transcribe from the default audio input device, typically the microphone.
+     microphone input. If no input file is provided, the default behaviour is
+     to transcribe from the default audio input device, typically the
+     microphone.
 
      The following flags are supported:
 
@@ -44,7 +45,7 @@
      <b>-p</b> <b>--punctuation</b>
               Add punctuation to speech recognition results.
 
-     <b>-x</b> <b>--exit</b>
+     <b>-x</b> <b>--exit</b> <u>exit</u><b>_<u></b>word</u>
               Set exit word. This causes hear to exit when a speech
               recognition result ends with the word in question.