X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=afs.cmd;h=584ba809235c825cb9e1a3afdadd0644eea4d2c5;hp=82b6dc485cd00683b58a4ec79bd1e69c5602690f;hb=7c007561e7031f5e33b91a8baf51bb952693a2d0;hpb=d46a0767b58654f15f16406cf99296287bd0d534 diff --git a/afs.cmd b/afs.cmd index 82b6dc48..584ba809 100644 --- a/afs.cmd +++ b/afs.cmd @@ -5,12 +5,11 @@ TM: mood lyr img pl --- N: add P: AFS_READ | AFS_WRITE -D: Add new audio files to the database. -U: add [-l] [-f] [-v] path... -H: Each given path may be either the full path to an audio -H: file, or the full path of a directory. In case of a -H: directory, all audio files in that directory are added -H: recursively. Only absolute paths are accepted. +D: Add or update audio files. +U: add [-a] [-l] [-f] [-v] path... +H: Each path must be absolute and refer to either an audio file, or a +H: directory. In case of a directory, all audio files in that directory +H: are added recursively. Only absolute paths are accepted. H: H: Options: H: @@ -18,11 +17,11 @@ H: -a Add all files. The default is to add only files ending in a H: known suffix for a supported audio format. H: H: -l Add files lazily. If the path already exists in the -H: database, skip this file. This operation is really cheap. -H: Use it when adding large directories if only a few files -H: where added. +H: database, skip this file. This operation is really cheap. Useful +H: to update large directories after some files have been added or +H: deleted. H: -H:-f Force adding/updating. Recompute the audio format handler data +H: -f Force adding/updating. Recompute the audio format handler data H: even if a file with the same path and the same hash value exists. H: H: -v Verbose mode. Print what is being done. @@ -37,26 +36,22 @@ H: only the tables given by table_name... are created. N: ls P: AFS_READ D: List audio files. -U: ls [-l[s|l|v|m]] [-p] [-a] [-r] [-d] [-s{p|s|l|n|f|c|i|y|b|d|a}] [pattern...] +U: ls [-l=mode] [-p] [-a] [-r] [-d] [-s=order] [pattern...] H: Print a list of all audio files matching pattern. H: H: Options: H: -H: -l Change listing mode. Defaults to short listing if not given. +H: -l=mode Change listing mode. Defaults to short listing if not given. H: -H: -ls: short listing mode +H: Available modes: +H: s: short listing mode +H: l: long listing mode (equivalent to -l) +H: v: verbose listing mode +H: p: parser-friendly mode +H: m: mbox listing mode +H: c: chunk-table listing mode H: -H: -ll: long listing mode (equivalent to -l) -H: -H: -lv: verbose listing mode -H: -H: -lp: parser-friendly mode -H: -H: -lm: mbox listing mode -H: -H: -lc: chunk-table listing mode -H: -H: -p List full path of audio file. If not specified, only the basename +H: -p List full paths. If this option is not specified, only the basename H: of each file is printed. H: H: -a List only files that are admissible with respect to the current mood or @@ -66,37 +61,27 @@ H: -r Reverse sort order. H: H: -d Print dates as seconds after the epoch. H: -H: -s Change sort order. Defaults to alphabetical path sort if not given. -H: -H: -sp: sort by path. -H: -H: -sl: sort by last played time. -H: -H: -ss: sort by score (implies -a). -H: -H: -sn: sort by num played count. -H: -H: -sf: sort by frequency. -H: -H: -sc: sort by number of channels. -H: -H: -si: sort by image id. -H: -H: -sy: sort by lyrics id. -H: -H: -sb: sort by bit rate. -H: -H: -sd: sort by duration. -H: -H: -sa: sort by audio format. +H: -s=order Change sort order. Defaults to alphabetical path sort if not given. +H: +H: Possible values for order: +H: p: by path +H: l: by last played time +H: s: by score (implies -a) +H: n: by num played count +H: f: by frequency +H: c: by number of channels +H: i: by image id +H: y: by lyrics id +H: b: by bit rate +H: d: by duration +H: a: by audio format --- N: lsatt P: AFS_READ D: List attributes. U: lsatt [-i] [-l] [-r] [pattern] -H: Print the list of all defined attributes which match the -H: given pattern. If no pattern is given, the full list is -H: printed. +H: Print the list of all defined attributes which match the given +H: pattern. If no pattern is given, the full list is printed. H: H: Options: H: @@ -114,9 +99,9 @@ U: setatt attribute{+|-}... pattern H: Set ('+') or unset ('-') the given attributes for all audio files matching H: pattern. Example: H: -H: setatt rock+ punk+ classic- '*foo.mp3' +H: setatt rock+ punk+ pop- '*foo.mp3' H: -H: sets the 'rock' and the 'punk' attribute but unsets the 'classic' +H: sets the 'rock' and the 'punk' attribute and unsets the 'pop' H: attribute of all files ending with 'foo.mp3'. --- N: addatt @@ -135,9 +120,9 @@ H: Rename attribute old to new. N: check P: AFS_READ D: Run integrity checks against osl tables. -U: check [-a] [-m] [-p] -H: Check the audio file table, the mood definitions and all -H: defined playlists and report any inconsistencies found. +U: check [-a] [-A] [-m] [-p] +H: Check the audio file table, the attribute table, the mood definitions +H: and all defined playlists. Report any inconsistencies. H: H: Options: H: @@ -146,12 +131,17 @@ H: table which are not present in the file system. Moreover, it checks H: whether the lyrics id and all entries in the audio file table are H: valid. H: +H: -A Check the attribute table against the afs attribute bitmask of +H: each audio file in the audio file table. Reports audio files +H: whose attribute bitmask is invalid, i.e., has a bit set which +H: does not correspond to any attribute of the attribute table. +H: H: -m Run syntax checks on all defined moods in the mood table. H: H: -p Check all playlists for lines that correspond to files not contained H: in the audio file table. H: -H: If called without arguments, all three checks are run. +H: If called without arguments, all checks are run. --- N: rmatt P: AFS_READ | AFS_WRITE @@ -164,9 +154,10 @@ N: rm P: AFS_READ | AFS_WRITE D: Remove entries from the audio file table. U: rm [-v] [-f] [-p] pattern... -H: Delete all entries in the audio file table that match any given pattern. -H: Note that affects the table entries only; paraslash won't touch your -H: audio files in any way. +H: Delete all entries in the audio file table that match any given pattern. Note +H: that this affects the table entries only; the command won't touch your audio +H: files on disk. +H: H: Options: H: H: -v Verbose mode. Explain what is being done. @@ -181,28 +172,29 @@ H: a slash (see fnmatch(3)). --- N: touch P: AFS_READ | AFS_WRITE -D: Manipulate the afs data for all audio files matching a pattern. +D: Manipulate the afs entry of audio files. U: touch [-n=numplayed] [-l=lastplayed] [-y=lyrics_id] [-i=image_id] [-a=amp] [-v] [-p] pattern -H: If no option is given, lastplayed is set to the current time -H: and numplayed is increased by one. Otherwise, only the given -H: options are taken into account. +H: If no option is given, the lastplayed field is set to the current time +H: and the value of the numplayed field is increased by one. Otherwise, +H: only the given options are taken into account. H: H: Options: H: -H: -n Set numplayed count. The number of times afs has selected this -H: audio file for streaming. +H: -n Set the numplayed count, i.e. the number of times this audio +H: file was selected for streaming so far. H: -H: -l Set lastplayed time. The last time this audio file was selected. -H: Must be given as the number of seconds since the epoch. Example: +H: -l Set the lastplayed time, i.e. the last time this audio file was +H: selected for streaming. The argument must be a number of seconds +H: since the epoch. Example: H: H: touch -l=$(date +%s) file H: H: sets the lastplayed time of 'file' to the current time. H: -H: -y Set the lyrics id. Specify the lyrics data file associated with -H: this audio file. +H: -y Set the lyrics ID which specifies the lyrics data file associated +H: with the audio file. H: -H: -i Set the image id. Same as -y, but sets the image. +H: -i Like -y, but sets the image ID. H: H: -a Set the amplification value (0-255). This determines a scaling H: factor by which the amplitude should be multiplied in order to @@ -223,10 +215,9 @@ N: cpsi P: AFS_READ | AFS_WRITE D: Copy audio file selector info. U: cpsi [-a] [-y] [-i] [-l] [-n] [-v] source pattern... -H: If no option, or only the -v option is given, all fields of -H: the audio file selector info are copied to all files -H: matching pattern. Otherwise, only the given options are -H: taken into account. +H: If no option, or only the -v option is given, all fields of the +H: audio file selector info are copied to all files matching pattern. +H: Otherwise, only the given options are taken into account. H: H: Options: H: @@ -257,14 +248,11 @@ T: add N: add@member@ O: int com_add@member@(struct command_context *cc); P: AFS_READ | AFS_WRITE -D: Read data from stdin and add it as a blob to the @member@ table. +D: Add stdin as a blob to the @member@ table. U: add@member@ @member@_name -H: Read arbitrary binary data from stdin and send that data to -H: the audio file selector process which creates a new blob for -H: the data in the corresponding osl table. -H: -H: The names of the blobs of a table are unique. If an entry with the -H: given name already exists, its contents are replaced by the new data. +H: Read from stdin and ask the audio file selector to create a blob in the +H: corresponding osl table. If the named blob already exists, it gets replaced +H: with the new data. --- T: cat N: cat@member@ @@ -272,27 +260,22 @@ O: int com_cat@member@(struct command_context *cc); P: AFS_READ D: Dump the contents of a blob of type @member@ to stdout. U: cat@member@ @member@_name -H: This command may be used to retrieve the blob identified by -H: the given name from the corresponding osl table to which -H: they were previously added. +H: Retrieve the named blob and write it to stdout. --- T: ls N: ls@member@ O: int com_ls@member@(struct command_context *cc); P: AFS_READ -D: List blobs of type @member@ matching a pattern. +D: List blobs of type @member@ which match a pattern. U: ls@member@ [-i] [-l] [-r] [pattern] -H: Print a list of the names of all blobs in the corresponding -H: osl table which match the given pattern. If no pattern is -H: given, the full list is printed. +H: Print the list of all blobs which match the given pattern. If no +H: pattern is given, the full list is printed. H: H: Options: H: -H: -i Sort attributes by id. The default is to sort -H: alphabetically by name. +H: -i Sort by identifier. The default is to sort alphabetically by name. H: -H: -l Print a long listing containing both identifier and -H: attribute name. The default is to print only the name. +H: -l Print identifier and name. The default is to print only the name. H: H: -r Reverse sort order. --- @@ -302,13 +285,14 @@ O: int com_rm@member@(struct command_context *cc); P: AFS_READ | AFS_WRITE D: Remove blob(s) of type @member@ from the @member@ table. U: rm@member@ pattern... -H: Remove all blobs from the corresponding table which match -H: any given pattern. +H: Remove all blobs whose name matches any of the given patterns. --- T: mv N: mv@member@ O: int com_mv@member@(struct command_context *cc); P: AFS_READ | AFS_WRITE D: Rename a blob of type @member@. -U: mv@member@ old_@member@_name new_@member@_name -H: Rename the blob identified by the first name as the second name. +U: mv@member@ source_@member@_name dest_@member@_name +H: Rename the blob identified by the source blob name to the destination blob +H: name. The command fails if the source does not exist, or if the destination +H: already exists.