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]
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
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
also given), chunk time and chunk offsets.
[/help]
- [option full-path]
- short_opt = F
- summary = list full paths, match full paths against patterns
+ [option limit]
+ short_opt = L
+ summary = list at most this many files
+ arg_type = uint32
+ arg_info = required_arg
+ typestr = num
[help]
- This option is the default, so it does nothing. Deprecated as of
- v0.6.0, scheduled for removal in v0.6.1.
+ 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
[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
--listing-mode, this argument may either be a single character or a
word, according to the following list.
- path (p). Sort alphabetically by path or basename (see -p). This is
- the default if --sort is not given.
+ path (p). Sort alphabetically by path or basename, depending on
+ whether -b is given. This is the default if --sort is not given.
score (s). Iterate over the entries of the score table, rather than
the audio file table. This sort order implies --admissible, since
audio-format (a)
+ hash (h)
+
If --sort is not given, path sort is implied.
[/help]
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
- synopsis = [sender cmd [arguments]]
+ synopsis = [sender subcmd [arguments]]
aux_info = VSS_READ | VSS_WRITE
[description]
- Send a command to a specific sender. The following commands are
- available, but not all senders support every command.
+ This command executes a subcommand for the given sender, which is
+ one of "http", "dccp" or "udp". Various subcommands exist to print
+ information about the sender, to activate and deactivate the sender,
+ and to change the access permissions and targets. The following
+ subcommands are available:
+
+ help, status, on, off, allow, deny, add, delete.
- help, on, off, add, delete, allow, deny, status.
+ All senders support the first four commands. The "allow" and "deny"
+ commands are supported by the http and the dccp senders while "add"
+ and "delete" are only supported by the udp sender. If no sender is
+ given, the list of available senders is shown.
- The help command prints the help text of the given sender. If no
- command is given the list of available senders is shown.
+ Examples:
- Example:
+ Get help for the udp sender (contains further examples):
- para_client sender http help
+ sender udp help
+
+ Show the access control list and the number of connected clients of
+ the http sender:
+
+ sender http status
+
+ Senders may be activated and deactivated independently of each
+ other. The following command switches off the dccp sender:
+
+ sender dccp off
+
+ Add an UDP unicast for a client to the target list of the UDP sender:
+
+ sender udp add client.foo.org
+
+ Start UDP multicast, using the default multicast address:
+
+ sender udp add 224.0.1.38
[/description]
the vss status flags, effectively stopping playback.
[/description]
-[subcommand tasks]
- purpose = list active server tasks
- aux_info = NO_PERMISSION_REQUIRED
- [description]
- For each task, print ID, status and name. This is mostly useful
- for debugging.
- [/description]
-
[subcommand term]
purpose = ask the server to terminate
aux_info = VSS_READ | VSS_WRITE
projects / paraslash.git / blobdiff