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: lsatt
  56 P: AFS_READ
  57 D: List attributes.
  58 U: lsatt [-i] [-l] [-r] [pattern]
  59 H: Print the list of all defined attributes which match the given
  60 H: pattern. If no pattern is given, the full list is printed.
  61 H:
  62 H: Options:
  63 H:
  64 H: -i   Sort attributes by id. The default is to sort alphabetically by name.
  65 H:
  66 H: -l   Print a long listing containing both identifier and attribute name. The
  67 H:      default is to print only the name.
  68 H:
  69 H: -r   Reverse sort order.
  70 ---
  71 N: setatt
  72 P: AFS_READ | AFS_WRITE
  73 D: Set attribute(s) for all files matching a pattern.
  74 U: setatt attribute{+|-}... pattern
  75 H: Set ('+') or unset ('-') the given attributes for all audio files matching
  76 H: pattern.  Example:
  77 H:
  78 H:         setatt rock+ punk+ pop- '*foo.mp3'
  79 H:
  80 H: sets the 'rock' and the 'punk' attribute and unsets the 'pop'
  81 H: attribute of all files ending with 'foo.mp3'.
  82 ---
  83 N: addatt
  84 P: AFS_READ | AFS_WRITE
  85 D: Add new attribute(s).
  86 U: addatt attribute1...
  87 H: This adds new attributes to the attribute table. At most 64
  88 H: attributes may be defined.
  89 ---
  90 N: mvatt
  91 P: AFS_READ | AFS_WRITE
  92 D: Rename an attribute.
  93 U: mvatt old new
  94 H: Rename attribute old to new.
  95 ---
  96 N: check
  97 P: AFS_READ
  98 D: Run integrity checks against osl tables.
  99 U: check [-a] [-A] [-m] [-p]
 100 H: Check the audio file table, the attribute table, the mood definitions
 101 H: and all defined playlists. Report any inconsistencies.
 102 H:
 103 H: Options:
 104 H:
 105 H: -a   Run audio file table checks. Checks for entries in the audio file
 106 H:      table which are not present in the file system. Moreover, it checks
 107 H:      whether the lyrics id and all entries in the audio file table are
 108 H:      valid.
 109 H:
 110 H: -A   Check the attribute table against the afs attribute bitmask of
 111 H:      each audio file in the audio file table. Reports audio files
 112 H:      whose attribute bitmask is invalid, i.e., has a bit set which
 113 H:      does not correspond to any attribute of the attribute table.
 114 H:
 115 H: -m   Run syntax checks on all defined moods in the mood table.
 116 H:
 117 H: -p   Check all playlists for lines that correspond to files not contained
 118 H:      in the audio file table.
 119 H:
 120 H: If called without arguments, all checks are run.
 121 ---
 122 N: rmatt
 123 P: AFS_READ | AFS_WRITE
 124 D: Remove attribute(s).
 125 U: rmatt pattern...
 126 H: Remove all attributes matching any given pattern. All information
 127 H: about this attribute in the audio file table is lost.
 128 ---
 129 N: rm
 130 P: AFS_READ | AFS_WRITE
 131 D: Remove entries from the audio file table.
 132 U: rm [-v] [-f] [-p] pattern...
 133 H: Delete all entries in the audio file table that match any given pattern.  Note
 134 H: that this affects the table entries only; the command won't touch your audio
 135 H: files on disk.
 136 H:
 137 H: Options:
 138 H:
 139 H: -v   Verbose mode. Explain what is being done.
 140 H:
 141 H: -f   Force mode. Ignore nonexistent files. Don't complain if nothing
 142 H:      was removed.
 143 H:
 144 H: -p   Pathname match. Match a slash in the path only with a slash
 145 H:      in pattern and not by an asterisk (*) or a question mark
 146 H:      (?) metacharacter, nor by a bracket expression ([]) containing
 147 H:      a slash (see fnmatch(3)).
 148 ---
 149 N: touch
 150 P: AFS_READ | AFS_WRITE
 151 D: Manipulate the afs entry of audio files.
 152 U: touch [-n=numplayed] [-l=lastplayed] [-y=lyrics_id] [-i=image_id] [-a=amp] [-v] [-p] pattern
 153 H: If no option is given, the lastplayed field is set to the current time
 154 H: and the value of the numplayed field is increased by one. Otherwise,
 155 H: only the given options are taken into account.
 156 H:
 157 H: Options:
 158 H:
 159 H: -n   Set the numplayed count, i.e. the number of times this audio
 160 H:      file was selected for streaming so far.
 161 H:
 162 H: -l   Set the lastplayed time, i.e. the last time this audio file was
 163 H:      selected for streaming. The argument must be a number of seconds
 164 H:      since the epoch. Example:
 165 H:
 166 H:              touch -l=$(date +%s) file
 167 H:
 168 H:      sets the lastplayed time of 'file' to the current time.
 169 H:
 170 H: -y   Set the lyrics ID which specifies the lyrics data file associated
 171 H:      with the audio file.
 172 H:
 173 H: -i   Like -y, but sets the image ID.
 174 H:
 175 H: -a   Set the amplification value (0-255). This determines a scaling
 176 H:      factor by which the amplitude should be multiplied in order to
 177 H:      normalize the volume of the audio file.  A value of zero means
 178 H:      no amplification, 64 means the amplitude should be multiplied
 179 H:      by a factor of two, 128 by three and so on.
 180 H:
 181 H:      This value is used by the amp filter.
 182 H:
 183 H: -v   Verbose mode. Explain what is being done.
 184 H:
 185 H: -p   Pathname match. Match a slash in the path only with a slash
 186 H:      in pattern and not by an asterisk (*) or a question mark
 187 H:      (?) metacharacter, nor by a bracket expression ([]) containing
 188 H:      a slash (see fnmatch(3)).
 189 ---
 190 N: cpsi
 191 P: AFS_READ | AFS_WRITE
 192 D: Copy audio file selector info.
 193 U: cpsi [-a] [-y] [-i] [-l] [-n] [-v] source pattern...
 194 H: If no option, or only the -v option is given, all fields of the
 195 H: audio file selector info are copied to all files matching pattern.
 196 H: Otherwise, only the given options are taken into account.
 197 H:
 198 H: Options:
 199 H:
 200 H: -a   Copy attributes.
 201 H:
 202 H: -y   Copy the lyrics id.
 203 H:
 204 H: -i   Copy the image id.
 205 H:
 206 H: -l   Copy the lastplayed time.
 207 H:
 208 H: -n   Copy the numplayed count.
 209 H:
 210 H: -v   Verbose mode.
 211 ---
 212 N: select
 213 P: AFS_READ | AFS_WRITE
 214 D: Activate a mood or a playlist.
 215 U: select specifier/name
 216 H: The specifier is either 'm' or 'p' to indicate whether a playlist or
 217 H: a mood should be activated. Example:
 218 H:
 219 H:      select m/foo
 220 H:
 221 H: loads the mood named 'foo'.
 222 ---
 223 T: add
 224 N: add@member@
 225 O: int com_add@member@(struct command_context *cc);
 226 P: AFS_READ | AFS_WRITE
 227 D: Add stdin as a blob to the @member@ table.
 228 U: add@member@ @member@_name
 229 H: Read from stdin and ask the audio file selector to create a blob in the
 230 H: corresponding osl table. If the named blob already exists, it gets replaced
 231 H: with the new data.
 232 ---
 233 T: cat
 234 N: cat@member@
 235 O: int com_cat@member@(struct command_context *cc);
 236 P: AFS_READ
 237 D: Dump the contents of a blob of type @member@ to stdout.
 238 U: cat@member@ @member@_name
 239 H: Retrieve the named blob and write it to stdout.
 240 ---
 241 T: ls
 242 N: ls@member@
 243 O: int com_ls@member@(struct command_context *cc);
 244 P: AFS_READ
 245 D: List blobs of type @member@ which match a pattern.
 246 U: ls@member@ [-i] [-l] [-r] [pattern]
 247 H: Print the list of all blobs which match the given pattern. If no
 248 H: pattern is given, the full list is printed.
 249 H:
 250 H: Options:
 251 H:
 252 H: -i   Sort by identifier. The default is to sort alphabetically by name.
 253 H:
 254 H: -l   Print identifier and name. The default is to print only the name.
 255 H:
 256 H: -r   Reverse sort order.
 257 ---
 258 T: rm
 259 N: rm@member@
 260 O: int com_rm@member@(struct command_context *cc);
 261 P: AFS_READ | AFS_WRITE
 262 D: Remove blob(s) of type @member@ from the @member@ table.
 263 U: rm@member@ pattern...
 264 H: Remove all blobs whose name matches any of the given patterns.
 265 ---
 266 T: mv
 267 N: mv@member@
 268 O: int com_mv@member@(struct command_context *cc);
 269 P: AFS_READ | AFS_WRITE
 270 D: Rename a blob of type @member@.
 271 U: mv@member@ source_@member@_name dest_@member@_name
 272 H: Rename the blob identified by the source blob name to the destination blob
 273 H: name. The command fails if the source does not exist, or if the destination
 274 H: already exists.