m4/lls/write_cmd.suite.m4

   1 [suite write_cmd]
   2 caption = writers
   3 [subcommand alsa]
   4         purpose = native ALSA output plugin
   5         [option device]
   6                 short_opt = d
   7                 summary = set PCM device
   8                 typestr = device
   9                 arg_info = required_arg
  10                 arg_type = string
  11                 default_val = default
  12                 [help]
  13                         Check for the presence of a /proc/asound/ directory to see if ALSA
  14                         is present in your kernel. The file /proc/asound/devices contains
  15                         all devices ALSA knows about.
  16                 [/help]
  17         [option buffer-time]
  18                 short_opt = B
  19                 summary = duration of the ALSA buffer
  20                 typestr = milliseconds
  21                 arg_info = required_arg
  22                 arg_type = uint32
  23                 default_val = 170
  24                 [help]
  25                         This is only a hint as ALSA might pick a slightly different time,
  26                         depending on the sound hardware. The chosen value is shown in debug
  27                         output as BUFFER_TIME.
  28
  29                         If synchronization between multiple clients is desired, the same
  30                         buffer time should be configured for all clients.
  31                 [/help]
  32 [subcommand ao]
  33         purpose = output plugin for libao
  34         [option driver]
  35                 short_opt = d
  36                 summary = select a output driver by name
  37                 typestr = name
  38                 arg_info = required_arg
  39                 arg_type = string
  40                 [help]
  41                         If this is not given, the driver with the highest priority (see below)
  42                         will be used.
  43                 [/help]
  44         [option ao-option]
  45                 short_opt = o
  46                 summary = pass a key-value pair to the libao driver
  47                 typestr = key:value
  48                 arg_info = required_arg
  49                 arg_type = string
  50                 flag multiple
  51                 [help]
  52                         For each time this option is given, the supplied key-value pair is
  53                         appended to the list of options for the driver. Invalid keys are
  54                         silently ignored.
  55                 [/help]
  56 [subcommand oss]
  57         purpose = output plugin for the Open Sound System
  58         [option device]
  59                 short_opt = d
  60                 summary = set PCM device
  61                 typestr = path
  62                 arg_info = required_arg
  63                 arg_type = string
  64                 default_val = /dev/dsp
  65 [subcommand osx]
  66         purpose = output plugin for Mac OS coreaudio
  67         [option numbuffers]
  68                 short_opt = n
  69                 summary = number of audio buffers to allocate
  70                 typestr = num
  71                 arg_info = required_arg
  72                 arg_type = uint32
  73                 default_val = 20
  74                 [help]
  75                         Increase if you get buffer underruns.
  76                 [/help]
  77 [subcommand file]
  78         purpose = output plugin that writes to a local file
  79         [option filename]
  80                 short_opt = f
  81                 summary = specify output file name
  82                 typestr = path
  83                 arg_info = required_arg
  84                 arg_type = string
  85                 [help]
  86                         Defaults to a random filename in ~/.paraslash.
  87                 [/help]