X-Git-Url: http://git.tuebingen.mpg.de/?a=blobdiff_plain;f=m4%2Flls%2Fserver_cmd.suite.m4;h=02afaabb5252a0580711547ad399cef932cfcadc;hb=HEAD;hp=96ce53020e756c37dd90c6ae1887f9d58623ab72;hpb=e2167286448ce2ed9a01a548e7e9832563035088;p=paraslash.git diff --git a/m4/lls/server_cmd.suite.m4 b/m4/lls/server_cmd.suite.m4 index 96ce5302..02afaabb 100644 --- a/m4/lls/server_cmd.suite.m4 +++ b/m4/lls/server_cmd.suite.m4 @@ -124,18 +124,18 @@ aux_info_prefix = Permissions: summary = enable verbose mode [subcommand ff] - purpose = jump N seconds forward or backward - synopsis = n[-] + purpose = jump forward or backward in the current audio file + synopsis = seconds aux_info = VSS_READ | VSS_WRITE [description] - This sets the 'R' (reposition request) bit of the vss status flags - which enqueues a request to jump n seconds forwards or backwards. + This enqueues a request to reposition the audio stream according to + the argument, which may be a signed or an unsigned integer. Negative + values correspond to backward jumps. - Example: - - para_client ff 30- - - jumps 30 seconds backwards. + If a negative number is given whose absolute value exceeds the current + postition of the stream, a jump to the beginning of the audio file + is performed. If a positive amount of seconds is given which exceeds + the remaining time of the audio file, the next audio file is loaded. [/description] @@ -144,10 +144,11 @@ aux_info_prefix = Permissions: non-opts-name = [command] aux_info = NO_PERMISSION_REQUIRED [description] - Without any arguments, help prints a list of available commands. When - called with a command name as first argument, it prints the description - of this command. + When executed without any arguments, the available server commands + are listed. Otherwise, if the first argument is the name of a server + command, the description of this command is shown. [/description] + m4_include(`long-help.m4') [subcommand hup] purpose = reload config file, log file and user list @@ -168,6 +169,8 @@ aux_info_prefix = Permissions: playlists. Otherwise only the given tables are created. [/description] +m4_include(`com_ll.m4') + [subcommand jmp] purpose = reposition the current stream non-opts-name = n @@ -219,6 +222,16 @@ aux_info_prefix = Permissions: also given), chunk time and chunk offsets. [/help] + [option limit] + short_opt = L + summary = list at most this many files + arg_type = uint32 + arg_info = required_arg + typestr = num + [help] + An argument of zero means "unlimited". This is also the default which + applies if the option is not given. + [/help] [option basename] short_opt = b summary = list and match basenames only @@ -230,9 +243,19 @@ aux_info_prefix = Permissions: [option admissible] short_opt = a summary = list only admissible files + arg_type = string + arg_info = optional_arg + typestr = specifier/name + default_val = . [help] - List only files which are admissible with respect to the current mood - or playlist. + If the optional argument is supplied, it must be of the form "p/foo" + or "m/bar" (which refer to the playlist named "foo" and the mood named + "bar", respectively). The command then restricts its output to the set + of files which are admissible with respect to the thusly identified + mood or playlist. + + If no argument is given, or if the argument is the special value ".", + the current mood or playlist is assumed. [/help] [option reverse] short_opt = r @@ -404,6 +427,9 @@ aux_info_prefix = Permissions: activates the mood named 'foo'. [/description] + [option verbose] + short_opt = v + summary = print information about the loaded mood or playlist [subcommand sender] purpose = control paraslash senders @@ -499,15 +525,6 @@ aux_info_prefix = Permissions: the vss status flags, effectively stopping playback. [/description] -[subcommand tasks] - purpose = list active server tasks (deprecated) - aux_info = NO_PERMISSION_REQUIRED - [description] - This used to print the ID, the status and the name of each task, - mainly for debugging purposes. As of version 0.6.2, the subcommand - prints nothing. It will be removed in 0.7.0. Don't use. - [/description] - [subcommand term] purpose = ask the server to terminate aux_info = VSS_READ | VSS_WRITE