m4/lls/afh.suite.m4

   1 m4_define(PROGRAM, para_afh)
   2 [suite afh]
   3 version-string = GIT_VERSION()
   4 [supercommand para_afh]
   5         purpose = print or modify meta information about audio file(s)
   6         [description]
   7                 By default para_afh prints information about the given audio files,
   8                 such as format, duration, bitrate, etc., and the content of the most
   9                 common meta tags (artist, title, album, year, comment). In modify
  10                 mode it changes the meta tags to the values given at the command line.
  11         [/description]
  12         non-opts-name = file...
  13         m4_include(common-option-section.m4)
  14         m4_include(help.m4)
  15         m4_include(detailed-help.m4)
  16         m4_include(version.m4)
  17         m4_include(loglevel.m4)
  18         [option modify-section]
  19                 summary = Printing meta information
  20                 flag ignored
  21         [option chunk-table]
  22                 short_opt = c
  23                 summary = print also the chunk table
  24                 [help]
  25                         The chunk table of an audio file is an array of offsets where each
  26                         offset corresponds to chunk of encoded data. The exact meaning of
  27                         chunk depends on the audio format.
  28
  29                         Programs which are unaware of the particular audio format can read the
  30                         chunk table to obtain the timing information needed to stream the file.
  31                 [/help]
  32         [option parser-friendly]
  33                 short_opt = p
  34                 summary = do not use human-readable output format
  35                 [help]
  36                         This option only affects the format of the chunk table, so it has no
  37                         effect if --chunk-table is not given.
  38
  39                         The human-readable output (the default) consists of one output line
  40                         per chunk and the output contains also the chunk number, the duration
  41                         and the size of each chunk. The parser-friendly output prints only
  42                         the offsets, in one line.
  43                 [/help]
  44         [option modify-section]
  45                 summary = Modifying meta tags
  46                 flag ignored
  47         [option modify]
  48                 short_opt = m
  49                 summary = modify (rather than print) tags
  50                 [help]
  51                         If this option is given, para_afh creates a temporary copy of the given
  52                         file(s), with meta tags changed according to the options below. On
  53                         errors, the temporary file is removed, leaving the original file
  54                         unchanged. On success, if --backup is given, the original file is
  55                         moved away. Finally the temporary file is renamed to the name of the
  56                         original file.
  57                 [/help]
  58         [option backup]
  59                 short_opt = b
  60                 summary = create backup of the original file
  61                 [help]
  62                         The backup suffix is '~'. That is, a single tilde character is appended
  63                         to the given file name.
  64                 [/help]
  65         [option preserve]
  66                 summary = preserve modification time
  67                 [help]
  68                         If this option is given, the mtime of the modified file is set to
  69                         the value prior to the modification.
  70                 [/help]
  71         [option year]
  72                 short_opt = y
  73                 summary = set the year tag
  74                 arg_info = required_arg
  75                 arg_type = string
  76                 typestr = string
  77         [option title]
  78                 short_opt = t
  79                 summary = set the title tag
  80                 arg_info = required_arg
  81                 arg_type = string
  82                 typestr = string
  83         [option artist]
  84                 short_opt = a
  85                 summary = set the artist tag
  86                 arg_info = required_arg
  87                 arg_type = string
  88                 typestr = string
  89         [option album]
  90                 short_opt = A
  91                 summary = set the album tag
  92                 arg_info = required_arg
  93                 arg_type = string
  94                 typestr = string
  95         [option comment]
  96                 short_opt = C
  97                 summary = set the comment tag
  98                 arg_info = required_arg
  99                 arg_type = string
 100                 typestr = string