m4/lls/audiod_cmd.suite.m4

   1 [suite audiod_cmd]
   2 caption = list of audiod commands
   3 [subcommand cycle]
   4         purpose = switch to next operating mode
   5         [description]
   6                 Cycle through the three operation modes (on, standby, off).
   7         [/description]
   8
   9 [subcommand help]
  10         purpose = list available commands or print command-specific help
  11         non-opts-name = [subcommand]
  12         [description]
  13                 When executed without any arguments, the available audiod commands
  14                 are listed. Otherwise, if the first argument is the name of an audiod
  15                 command, the description of this command is shown.
  16         [/description]
  17         m4_include(`long-help.m4')
  18
  19 [subcommand grab]
  20         purpose = grab the audio stream
  21         [description]
  22                 grab ('splice') the audio stream at any position in the buffer tree
  23                 and send that data back to the client.
  24         [/description]
  25         [option mode]
  26                 short_opt = m
  27                 summary = change grab mode
  28                 arg_info = required_arg
  29                 arg_type = string
  30                 typestr = mode
  31                 default_val = s
  32                 [help]
  33                         The various grab modes only differ in what happens if an attempt to
  34                         write the grabbed audio data would block. Sloppy mode ("s") ignores
  35                         the write, pedantic mode ("p") aborts and aggressive mode ("a")
  36                         tries to write anyway.
  37                 [/help]
  38         [option parent]
  39                 short_opt = p
  40                 summary = Grab output of the given node of the buffer tree
  41                 arg_info = required_arg
  42                 arg_type = string
  43                 typestr = node
  44         [option name]
  45                 short_opt = n
  46                 summary = Name of the new buffer tree node. Defaults to 'grab'
  47                 arg_info = optional_arg
  48                 arg_type = string
  49                 typestr = string
  50         [option one-shot]
  51                 short_opt = o
  52                 summary = One-shot mode: Stop grabbing if audio file changes
  53
  54 [subcommand off]
  55         purpose = deactivate para_audiod
  56         [description]
  57                 Close connection to para_server and stop all decoders.
  58         [/description]
  59
  60 [subcommand on]
  61         purpose = activate para_audiod
  62         [description]
  63                 Establish connection to para_server, retrieve para_server's current
  64                 status. If playing, start corresponding decoder. Otherwise stop
  65                 all decoders.
  66         [/description]
  67
  68 [subcommand sb]
  69         purpose = enter standby mode
  70         [description]
  71                 Stop all decoders but leave connection to para_server open.
  72         [/description]
  73
  74 [subcommand stat]
  75         purpose = print status information
  76         non-opts-name = [item...]
  77         [description]
  78                 Dump given status items (all if none given) to stdout.
  79         [/description]
  80         [option parser-friendly]
  81                 short_opt = p
  82                 summary = use parser-friendly output format
  83
  84 [subcommand version]
  85         purpose = print the version of para_audiod
  86         [option verbose]
  87                 short_opt = v
  88                 summary = print detailed (multi-line) version text
  89
  90 [subcommand tasks]
  91         purpose = list current tasks
  92         [description]
  93                 Print the list of task ids together with the status of each task.
  94         [/description]
  95
  96 [subcommand term]
  97         purpose = terminate para_audiod
  98         [description]
  99                 Stop all decoders, shut down connection to para_server and exit.
 100         [/description]