From: Andre Noll <maan@systemlinux.org>
Date: Mon, 24 Sep 2007 19:26:17 +0000 (+0200)
Subject: afs.cmd: Add documentation of the remaining commands.
X-Git-Tag: v0.3.0~360
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=ad9ff4973f843b8f1eaf3d6cd132450be683e4a3;p=paraslash.git

afs.cmd: Add documentation of the remaining commands.

And improve the formating of command options.
---

diff --git a/afs.cmd b/afs.cmd
index 87ec1a07..fca60466 100644
--- a/afs.cmd
+++ b/afs.cmd
@@ -36,10 +36,11 @@ H: only the tables given by table_name... are created.
 N: afs_ls
 P: AFS_READ
 D: List audio files.
-U: ls [-l[s|l|v|m]] -p -a -r -s{p|s|l|n|f|c|i|y|b|d|a} [pattern ...]
+U: ls [-l[s|l|v|m]] -p -a -r -s{p|s|l|n|f|c|i|y|b|d|a} [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: 	-ls: short listing mode
 H: 	-ll: long listing mode (equivalent to -l)
@@ -55,17 +56,28 @@ H:
 H: -r	Reverse sort order.
 H:
 H: -s	Change sort order. Defaults to alphabetical path sort if not given.
-H: 	-sp:  sort by path.
-H: 	-sl:  sort by last played time.
-H: 	-ss:  sort by score (implies -a).
-H: 	-sn:  sort by number of times the file was played.
-H: 	-sf:  sort by frequency.
-H: 	-sc:  sort by number of channels.
-H: 	-si:  sort by image id.
-H: 	-sy:  sort by lyrics id.
-H: 	-sb:  sort by bitrate.
-H: 	-sd:  sort by duration.
-H: 	-sa:  sort by audio format.
+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 bitrate.
+H:
+H: 		-sd:  sort by duration.
+H:
+H: 		-sa:  sort by audio format.
 ---
 N: lsatt
 P: AFS_READ
@@ -75,6 +87,7 @@ H:
 H: Print the list of all defined attributes.
 H:
 H: Options:
+H:
 H: -a	Sort attributes alphabetically by name. The default is to sort by
 H: 	identifier.
 H:
@@ -84,8 +97,7 @@ H: 	default is to print only the name.
 N: setatt
 P: AFS_READ | AFS_WRITE
 D: Set attribute(s) for all files matching a pattern.
-U: setatt attribute1{+|-} [attribute2{+|-}...] pattern
-
+U: setatt attribute{+|-}... pattern
 H: Set ('+') or unset ('-') the given attributes for all audio files matching
 H: pattern.  Example:
 H:
@@ -103,30 +115,49 @@ H: may be defined.
 ---
 N: check
 P: AFS_READ
-D: Run integrity checks for the osl tables.
+D: Run integrity checks against osl tables.
 U: check [-a] [-m] [-p]
-H: FIXME
+H: This command checks the audio file table, the mood definitions and all
+H: defined playlists and reports any inconsistencies found.
+H:
+H: Options:
+H:
+H: -a 	Run audio file table checks. Checks for entries in the audio file
+H: 	table which are not present in the filesystem. Moreover, it checks
+H: 	whether the lyrics id and all entries in the audio file table are
+H: 	valid.
+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.
 ---
 N: rmatt
 P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
+D: Remove attribute(s).
+U: rmatt pattern...
+H: Remove all attributes matching any given pattern. All information
+H: about this attribute in the audio file table is lost.
 ---
 N: afs_rm
 P: AFS_READ | AFS_WRITE
-D: FIXME
-U: FIXME
-H: FIXME
+D: Remove entries from the audio file table.
+U: rm 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.
 ---
 N: touch
 P: AFS_READ | AFS_WRITE
 D: Manupulate the afs data for all audio files matching a pattern.
 U: touch [-n numplayed] [-l lastplayed] [-y lyrics_id] [-i image_id] pattern
-If neither of the optional options is given, lastplayed is set to the current
-time and numplayed is increased by one. Otherwise, only the given options are
-taken into account.
-Options:
+H: If no option is given, lastplayed is set to the current time and numplayed is
+H: increased by one. Otherwise, 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:
@@ -135,7 +166,7 @@ H: 	Must be given as the number of sectonds since the epoch. Example:
 H:
 H: 		touch -l $(date +%s) file
 H:
-H: 	sets the lastplayed time of 'file' to the current time
+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.