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: rm
  63 P: AFS_READ | AFS_WRITE
  64 D: Remove entries from the audio file table.
  65 U: rm [-v] [-f] [-p] pattern...
  66 H: Delete all entries in the audio file table that match any given pattern.  Note
  67 H: that this affects the table entries only; the command won't touch your audio
  68 H: files on disk.
  69 H:
  70 H: Options:
  71 H:
  72 H: -v   Verbose mode. Explain what is being done.
  73 H:
  74 H: -f   Force mode. Ignore nonexistent files. Don't complain if nothing
  75 H:      was removed.
  76 H:
  77 H: -p   Pathname match. Match a slash in the path only with a slash
  78 H:      in pattern and not by an asterisk (*) or a question mark
  79 H:      (?) metacharacter, nor by a bracket expression ([]) containing
  80 H:      a slash (see fnmatch(3)).
  81 ---
  82 N: touch
  83 P: AFS_READ | AFS_WRITE
  84 D: Manipulate the afs entry of audio files.
  85 U: touch [-n=numplayed] [-l=lastplayed] [-y=lyrics_id] [-i=image_id] [-a=amp] [-v] [-p] pattern
  86 H: If no option is given, the lastplayed field is set to the current time
  87 H: and the value of the numplayed field is increased by one. Otherwise,
  88 H: only the given options are taken into account.
  89 H:
  90 H: Options:
  91 H:
  92 H: -n   Set the numplayed count, i.e. the number of times this audio
  93 H:      file was selected for streaming so far.
  94 H:
  95 H: -l   Set the lastplayed time, i.e. the last time this audio file was
  96 H:      selected for streaming. The argument must be a number of seconds
  97 H:      since the epoch. Example:
  98 H:
  99 H:              touch -l=$(date +%s) file
 100 H:
 101 H:      sets the lastplayed time of 'file' to the current time.
 102 H:
 103 H: -y   Set the lyrics ID which specifies the lyrics data file associated
 104 H:      with the audio file.
 105 H:
 106 H: -i   Like -y, but sets the image ID.
 107 H:
 108 H: -a   Set the amplification value (0-255). This determines a scaling
 109 H:      factor by which the amplitude should be multiplied in order to
 110 H:      normalize the volume of the audio file.  A value of zero means
 111 H:      no amplification, 64 means the amplitude should be multiplied
 112 H:      by a factor of two, 128 by three and so on.
 113 H:
 114 H:      This value is used by the amp filter.
 115 H:
 116 H: -v   Verbose mode. Explain what is being done.
 117 H:
 118 H: -p   Pathname match. Match a slash in the path only with a slash
 119 H:      in pattern and not by an asterisk (*) or a question mark
 120 H:      (?) metacharacter, nor by a bracket expression ([]) containing
 121 H:      a slash (see fnmatch(3)).
 122 ---
 123 N: select
 124 P: AFS_READ | AFS_WRITE
 125 D: Activate a mood or a playlist.
 126 U: select specifier/name
 127 H: The specifier is either 'm' or 'p' to indicate whether a playlist or
 128 H: a mood should be activated. Example:
 129 H:
 130 H:      select m/foo
 131 H:
 132 H: loads the mood named 'foo'.
 133 ---
 134 T: add
 135 N: add@member@
 136 O: int com_add@member@(struct command_context *cc);
 137 P: AFS_READ | AFS_WRITE
 138 D: Add stdin as a blob to the @member@ table.
 139 U: add@member@ @member@_name
 140 H: Read from stdin and ask the audio file selector to create a blob in the
 141 H: corresponding osl table. If the named blob already exists, it gets replaced
 142 H: with the new data.
 143 ---
 144 T: cat
 145 N: cat@member@
 146 O: int com_cat@member@(struct command_context *cc);
 147 P: AFS_READ
 148 D: Dump the contents of a blob of type @member@ to stdout.
 149 U: cat@member@ @member@_name
 150 H: Retrieve the named blob and write it to stdout.
 151 ---
 152 T: ls
 153 N: ls@member@
 154 O: int com_ls@member@(struct command_context *cc);
 155 P: AFS_READ
 156 D: List blobs of type @member@ which match a pattern.
 157 U: ls@member@ [-i] [-l] [-r] [pattern]
 158 H: Print the list of all blobs which match the given pattern. If no
 159 H: pattern is given, the full list is printed.
 160 H:
 161 H: Options:
 162 H:
 163 H: -i   Sort by identifier. The default is to sort alphabetically by name.
 164 H:
 165 H: -l   Print identifier and name. The default is to print only the name.
 166 H:
 167 H: -r   Reverse sort order.
 168 ---
 169 T: rm
 170 N: rm@member@
 171 O: int com_rm@member@(struct command_context *cc);
 172 P: AFS_READ | AFS_WRITE
 173 D: Remove blob(s) of type @member@ from the @member@ table.
 174 U: rm@member@ pattern...
 175 H: Remove all blobs whose name matches any of the given patterns.
 176 ---
 177 T: mv
 178 N: mv@member@
 179 O: int com_mv@member@(struct command_context *cc);
 180 P: AFS_READ | AFS_WRITE
 181 D: Rename a blob of type @member@.
 182 U: mv@member@ source_@member@_name dest_@member@_name
 183 H: Rename the blob identified by the source blob name to the destination blob
 184 H: name. The command fails if the source does not exist, or if the destination
 185 H: already exists.