afs.cmd

   1 BN: afs
   2 SF: afs.c aft.c attribute.c
   3 SN: list of afs commands
   4 TM: mood lyr img pl
   5 ---
   6 N: ls
   7 P: AFS_READ
   8 D: List audio files.
   9 U: ls [-l=mode] [-p] [-a] [-r] [-d] [-s=order] [pattern...]
  10 H: Print a list of all audio files matching pattern.
  11 H:
  12 H: Options:
  13 H:
  14 H: -l=mode      Change listing mode. Defaults to short listing if not given.
  15 H:
  16 H:    Available modes:
  17 H:    s: short listing mode
  18 H:    l: long listing mode (equivalent to -l)
  19 H:    v: verbose listing mode
  20 H:    p: parser-friendly mode
  21 H:    m: mbox listing mode
  22 H:    c: chunk-table listing mode
  23 H:
  24 H: -F   List full paths. If this option is not specified, only the basename
  25 H:      of each file is printed.
  26 H: -p   Synonym for -F. Deprecated.
  27 H:
  28 H: -b   Print only the basename of each matching file. This is the default, so
  29 H:      the option is currently a no-op. It is recommended to specify this option,
  30 H:      though, as the default might change in a future release.
  31 H:
  32 H: -a   List only files that are admissible with respect to the current mood or
  33 H:      playlist.
  34 H:
  35 H: -r   Reverse sort order.
  36 H:
  37 H: -d   Print dates as seconds after the epoch.
  38 H:
  39 H: -s=order
  40 H:      Change sort order. Defaults to alphabetical path sort if not given.
  41 H:
  42 H:   Possible values for order:
  43 H:   p: by path
  44 H:   l: by last played time
  45 H:   s: by score (implies -a)
  46 H:   n: by num played count
  47 H:   f: by frequency
  48 H:   c: by number of channels
  49 H:   i: by image id
  50 H:   y: by lyrics id
  51 H:   b: by bit rate
  52 H:   d: by duration
  53 H:   a: by audio format
  54 ---
  55 N: addatt
  56 P: AFS_READ | AFS_WRITE
  57 D: Add new attribute(s).
  58 U: addatt attribute1...
  59 H: This adds new attributes to the attribute table. At most 64
  60 H: attributes may be defined.
  61 ---
  62 N: check
  63 P: AFS_READ
  64 D: Run integrity checks against osl tables.
  65 U: check [-a] [-A] [-m] [-p]
  66 H: Check the audio file table, the attribute table, the mood definitions
  67 H: and all defined playlists. Report any inconsistencies.
  68 H:
  69 H: Options:
  70 H:
  71 H: -a   Run audio file table checks. Checks for entries in the audio file
  72 H:      table which are not present in the file system. Moreover, it checks
  73 H:      whether the lyrics id and all entries in the audio file table are
  74 H:      valid.
  75 H:
  76 H: -A   Check the attribute table against the afs attribute bitmask of
  77 H:      each audio file in the audio file table. Reports audio files
  78 H:      whose attribute bitmask is invalid, i.e., has a bit set which
  79 H:      does not correspond to any attribute of the attribute table.
  80 H:
  81 H: -m   Run syntax checks on all defined moods in the mood table.
  82 H:
  83 H: -p   Check all playlists for lines that correspond to files not contained
  84 H:      in the audio file table.
  85 H:
  86 H: If called without arguments, all checks are run.
  87 ---
  88 N: rmatt
  89 P: AFS_READ | AFS_WRITE
  90 D: Remove attribute(s).
  91 U: rmatt pattern...
  92 H: Remove all attributes matching any given pattern. All information
  93 H: about this attribute in the audio file table is lost.
  94 ---
  95 N: rm
  96 P: AFS_READ | AFS_WRITE
  97 D: Remove entries from the audio file table.
  98 U: rm [-v] [-f] [-p] pattern...
  99 H: Delete all entries in the audio file table that match any given pattern.  Note
 100 H: that this affects the table entries only; the command won't touch your audio
 101 H: files on disk.
 102 H:
 103 H: Options:
 104 H:
 105 H: -v   Verbose mode. Explain what is being done.
 106 H:
 107 H: -f   Force mode. Ignore nonexistent files. Don't complain if nothing
 108 H:      was removed.
 109 H:
 110 H: -p   Pathname match. Match a slash in the path only with a slash
 111 H:      in pattern and not by an asterisk (*) or a question mark
 112 H:      (?) metacharacter, nor by a bracket expression ([]) containing
 113 H:      a slash (see fnmatch(3)).
 114 ---
 115 N: touch
 116 P: AFS_READ | AFS_WRITE
 117 D: Manipulate the afs entry of audio files.
 118 U: touch [-n=numplayed] [-l=lastplayed] [-y=lyrics_id] [-i=image_id] [-a=amp] [-v] [-p] pattern
 119 H: If no option is given, the lastplayed field is set to the current time
 120 H: and the value of the numplayed field is increased by one. Otherwise,
 121 H: only the given options are taken into account.
 122 H:
 123 H: Options:
 124 H:
 125 H: -n   Set the numplayed count, i.e. the number of times this audio
 126 H:      file was selected for streaming so far.
 127 H:
 128 H: -l   Set the lastplayed time, i.e. the last time this audio file was
 129 H:      selected for streaming. The argument must be a number of seconds
 130 H:      since the epoch. Example:
 131 H:
 132 H:              touch -l=$(date +%s) file
 133 H:
 134 H:      sets the lastplayed time of 'file' to the current time.
 135 H:
 136 H: -y   Set the lyrics ID which specifies the lyrics data file associated
 137 H:      with the audio file.
 138 H:
 139 H: -i   Like -y, but sets the image ID.
 140 H:
 141 H: -a   Set the amplification value (0-255). This determines a scaling
 142 H:      factor by which the amplitude should be multiplied in order to
 143 H:      normalize the volume of the audio file.  A value of zero means
 144 H:      no amplification, 64 means the amplitude should be multiplied
 145 H:      by a factor of two, 128 by three and so on.
 146 H:
 147 H:      This value is used by the amp filter.
 148 H:
 149 H: -v   Verbose mode. Explain what is being done.
 150 H:
 151 H: -p   Pathname match. Match a slash in the path only with a slash
 152 H:      in pattern and not by an asterisk (*) or a question mark
 153 H:      (?) metacharacter, nor by a bracket expression ([]) containing
 154 H:      a slash (see fnmatch(3)).
 155 ---
 156 N: cpsi
 157 P: AFS_READ | AFS_WRITE
 158 D: Copy audio file selector info.
 159 U: cpsi [-a] [-y] [-i] [-l] [-n] [-v] source pattern...
 160 H: If no option, or only the -v option is given, all fields of the
 161 H: audio file selector info are copied to all files matching pattern.
 162 H: Otherwise, only the given options are taken into account.
 163 H:
 164 H: Options:
 165 H:
 166 H: -a   Copy attributes.
 167 H:
 168 H: -y   Copy the lyrics id.
 169 H:
 170 H: -i   Copy the image id.
 171 H:
 172 H: -l   Copy the lastplayed time.
 173 H:
 174 H: -n   Copy the numplayed count.
 175 H:
 176 H: -v   Verbose mode.
 177 ---
 178 N: select
 179 P: AFS_READ | AFS_WRITE
 180 D: Activate a mood or a playlist.
 181 U: select specifier/name
 182 H: The specifier is either 'm' or 'p' to indicate whether a playlist or
 183 H: a mood should be activated. Example:
 184 H:
 185 H:      select m/foo
 186 H:
 187 H: loads the mood named 'foo'.
 188 ---
 189 T: add
 190 N: add@member@
 191 O: int com_add@member@(struct command_context *cc);
 192 P: AFS_READ | AFS_WRITE
 193 D: Add stdin as a blob to the @member@ table.
 194 U: add@member@ @member@_name
 195 H: Read from stdin and ask the audio file selector to create a blob in the
 196 H: corresponding osl table. If the named blob already exists, it gets replaced
 197 H: with the new data.
 198 ---
 199 T: cat
 200 N: cat@member@
 201 O: int com_cat@member@(struct command_context *cc);
 202 P: AFS_READ
 203 D: Dump the contents of a blob of type @member@ to stdout.
 204 U: cat@member@ @member@_name
 205 H: Retrieve the named blob and write it to stdout.
 206 ---
 207 T: ls
 208 N: ls@member@
 209 O: int com_ls@member@(struct command_context *cc);
 210 P: AFS_READ
 211 D: List blobs of type @member@ which match a pattern.
 212 U: ls@member@ [-i] [-l] [-r] [pattern]
 213 H: Print the list of all blobs which match the given pattern. If no
 214 H: pattern is given, the full list is printed.
 215 H:
 216 H: Options:
 217 H:
 218 H: -i   Sort by identifier. The default is to sort alphabetically by name.
 219 H:
 220 H: -l   Print identifier and name. The default is to print only the name.
 221 H:
 222 H: -r   Reverse sort order.
 223 ---
 224 T: rm
 225 N: rm@member@
 226 O: int com_rm@member@(struct command_context *cc);
 227 P: AFS_READ | AFS_WRITE
 228 D: Remove blob(s) of type @member@ from the @member@ table.
 229 U: rm@member@ pattern...
 230 H: Remove all blobs whose name matches any of the given patterns.
 231 ---
 232 T: mv
 233 N: mv@member@
 234 O: int com_mv@member@(struct command_context *cc);
 235 P: AFS_READ | AFS_WRITE
 236 D: Rename a blob of type @member@.
 237 U: mv@member@ source_@member@_name dest_@member@_name
 238 H: Rename the blob identified by the source blob name to the destination blob
 239 H: name. The command fails if the source does not exist, or if the destination
 240 H: already exists.