Provide "purpose" texts.

[paraslash.git] / m4 / gengetopt / play.m4

diff --git a/m4/gengetopt/play.m4 b/m4/gengetopt/play.m4
index 57f954c4c0ee094f3f8323d2d25956672f91a0f3..ea41f562fe504e00d0be096b83f174d4dc41129d 100644 (file)
--- a/m4/gengetopt/play.m4
+++ b/m4/gengetopt/play.m4
@@ -1,4 +1,14 @@
 args "--unamed-opts=audio_file --no-handle-version --conf-parser --no-handle-help"
+
+purpose "Command line audio player."
+
+description "para_play operates either in command mode or in insert
+mode. In insert mode it presents a prompt and allows to enter commands
+like stop, play, pause etc. In command mode the current audio file
+is shown and the program reads single key strokes from stdin. Keys
+may be mapped to commands. Whenever a mapped key is pressed, the
+associated command is executed."
+
 include(header.m4)
 define(CURRENT_PROGRAM,para_play)
 define(DEFAULT_CONFIG_FILE,~/.paraslash/play.conf)