afh_recv: Improve documentation of --begin-chunk.

[paraslash.git] / afs.cmd

diff --git a/afs.cmd b/afs.cmd
index bf6482b9719ef2ade361f7a09eb0e19ca604c7a0..584ba809235c825cb9e1a3afdadd0644eea4d2c5 100644 (file)
--- a/afs.cmd
+++ b/afs.cmd
@@ -36,19 +36,20 @@ 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:    -ll: long listing mode (equivalent to -l)
-H:    -lv: verbose listing mode
-H:    -lp: parser-friendly mode
-H:    -lm: mbox listing mode
-H:    -lc: chunk-table 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: -p  List full paths. If this option is not specified, only the basename
 H:     of each file is printed.
@@ -60,19 +61,20 @@ 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: by path
-H:    -sl: by last played time
-H:    -ss: by score (implies -a)
-H:    -sn: by num played count
-H:    -sf: by frequency
-H:    -sc: by number of channels
-H:    -si: by image id
-H:    -sy: by lyrics id
-H:    -sb: by bit rate
-H:    -sd: by duration
-H:    -sa: 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
@@ -118,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:
@@ -129,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