From 41611d30f4b860b26159019ca9af3cc8efb06010 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Sat, 6 Oct 2007 12:46:19 +0200 Subject: [PATCH] afs.cmd: Beautify help texts. --- afs.cmd | 80 +++++++++++++++++++++++++++++++-------------------------- 1 file changed, 44 insertions(+), 36 deletions(-) diff --git a/afs.cmd b/afs.cmd index 14ee5891..2b031be2 100644 --- a/afs.cmd +++ b/afs.cmd @@ -10,19 +10,21 @@ 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] path1 ... -H: Each given path may be either the full path to an audio file, or the full path -H: of a directory. In case of a directory, all audio files in that directory -H: are added recursively. +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. H: H: Options: H: -H: -a Add all files. The default is to add only files ending in a known suffix -H: for a supported audio format. +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 a file already exists in the database, skip this file. -H: This operation is really cheap. Use it when adding large directories if only a -H: few files where added. +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: 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. @@ -45,10 +47,14 @@ 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) -H: -lv: verbose listing mode -H: -lm: mbox listing mode +H: +H: -ls: short listing mode +H: +H: -ll: long listing mode (equivalent to -l) +H: +H: -lv: verbose listing mode +H: +H: -lm: mbox listing mode H: H: -p List full path of audio file. If not specified, only the basename H: of each file is printed. @@ -86,9 +92,9 @@ N: lsatt P: AFS_READ D: List attributes U: lsatt [-i] [-l] [-r] [pattern] -H: -H: Print the list of all defined attributes which match the given pattern. If no -H: pattern is given, the full list is printed. +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: H: Options: H: @@ -115,8 +121,8 @@ N: addatt P: AFS_READ | AFS_WRITE D: Add new attribute(s). U: addatt attribute1... -H: This adds new attributes to the attribute table. At most 64 attributes -H: may be defined. +H: This adds new attributes to the attribute table. At most 64 +H: attributes may be defined. --- N: check P: AFS_READ @@ -169,8 +175,9 @@ N: touch P: AFS_READ | AFS_WRITE D: Manipulate the afs data for all audio files matching a pattern. U: touch [-n numplayed] [-l lastplayed] [-y lyrics_id] [-i image_id] [-v] [-p] pattern -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: 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: H: Options: H: @@ -200,9 +207,10 @@ 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 the audio file -H: selector info are copied to all files matching pattern. Otherwise, only the -H: given options are taken into account. +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: H: Options: H: @@ -224,15 +232,12 @@ O: int com_add@member@(int fd, int argc, char * const * const argv); P: AFS_READ | AFS_WRITE D: Read data from stdin and add it as a blob to an osl table. U: add@member@ @member@_name -H: Each command of this family reads arbitrary binary data from stdin and sends -H: that data to the audio file selector process. The afs process then creates a -H: new blob for the data in the corresponding osl table. Example: -H: -H: addimg foo.jpg < bar.jpg +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: adds the contents of the file 'bar.jpg' as a blob named 'foo.jpg' to the image -H: table. The names of the blobs of a table must be unique, i.e. it is an error -H: if an entry named 'foo.jpg' already exists. +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. --- T: cat N: cat@member@ @@ -240,8 +245,9 @@ O: int com_cat@member@(int fd, int argc, char * const * const argv); P: AFS_READ D: Dump the contents of a blob to stdout. U: cat@member@ @member@_name -H: These commands may be used to retrieve the blob identified by the given name from -H: the corresponding osl table to which they were previously added. +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. --- T: ls N: ls@member@ @@ -249,8 +255,9 @@ O: int com_ls@member@(int fd, int argc, char * const * const argv); P: AFS_READ D: List blobs of an osl table matching a pattern. U: ls@member@ [-i] [-l] [-r] [pattern] -H: Print a list of the names of all blobs in the corresponding osl table which -H: match the given pattern. If no pattern is given, the full list is printed. +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: H: Options: H: @@ -267,7 +274,8 @@ O: int com_rm@member@(int fd, int argc, char * const * const argv); P: AFS_READ | AFS_WRITE D: Remove blob(s) from an osl table. U: rm@member@ pattern... -H: Remove all blobs from the corresponding table which match any given pattern. +H: Remove all blobs from the corresponding table which match +H: any given pattern. --- T: mv N: mv@member@ -- 2.39.5