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
n <= 100.
[/description]
+[subcommand ls]
+ purpose = list audio files which match a pattern
+ non-opts-name = [pattern...]
+ aux_info = AFS_READ
+ [description]
+ If no pattern is given, all files are listed. Otherwise, the command
+ lists all files of the audio file table whose path matches at least
+ one of the given patterns.
+ [/description]
+ [option listing-mode]
+ short_opt = l
+ summary = use alternative output format
+ arg_type = string
+ arg_info = optional_arg
+ typestr = mode
+ default_val = long
+ [help]
+ The optional mode argument is either a single character or a word
+ according to the following list.
+
+ short (s). List only the path or basename (last component of the path),
+ depending on whether -p is also given. This listing mode acts as if
+ --listing-mode had not been given.
+
+ long (l). Show detailed information. This is the default if no argument
+ to --listing-mode is supplied.
+
+ verbose (v). Multi-line output, one row per data field stored in the
+ audio file table.
+
+ parser-friendly (p). Like verbose listing mode, but use numerical
+ values for the names of the output fields and prefix each line with
+ a length field.
+
+ mbox (m). Generate output suitable to be viewed with a mail
+ program. One "mail" per matching audio file.
+
+ chunk-table (c). Print path (or basename, depending on whether -p is
+ also given), chunk time and chunk offsets.
+
+ [/help]
+ [option basename]
+ short_opt = b
+ summary = list and match basenames only
+ [help]
+ Print only the basename of each matching file and match only the
+ basenames of the paths stored in the audio file table against the
+ given patterns. The default is to print and match the full path.
+ [/help]
+ [option admissible]
+ short_opt = a
+ summary = list only admissible files
+ [help]
+ List only files which are admissible with respect to the current mood
+ or playlist.
+ [/help]
+ [option reverse]
+ short_opt = r
+ summary = reverse sort order
+ [option unix-date]
+ short_opt = d
+ summary = print dates as seconds after the epoch
+ [option sort]
+ short_opt = s
+ summary = change sort order
+ arg_type = string
+ arg_info = required_arg
+ typestr = order
+ default_val = path
+ [help]
+ The sort order must be given as an required argument. Like for
+ --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, 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
+ the score table contains only admissible files.
+
+ lastplayed (l)
+
+ numplayed (n)
+
+ frequency (f)
+
+ channels (c)
+
+ image-id (i)
+
+ lyrics-id (y)
+
+ bitrate (b)
+
+ duration (d)
+
+ audio-format (a)
+
+ hash (h)
+
+ If --sort is not given, path sort is implied.
+ [/help]
+
[subcommand lsatt]
purpose = list attributes
aux_info = AFS_READ
[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, on, off, add, delete, allow, deny, status.
+ help, status, on, off, allow, deny, add, delete.
- The help command prints the help text of the given sender. If no
- command is given the list of available senders is shown.
+ 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.
- Example:
+ Examples:
+
+ Get help for the udp sender (contains further examples):
+
+ 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:
- para_client sender http help
+ sender udp add 224.0.1.38
[/description]
[/description]
[subcommand tasks]
- purpose = list active server tasks
+ purpose = list active server tasks (deprecated)
aux_info = NO_PERMISSION_REQUIRED
[description]
- For each task, print ID, status and name. This is mostly useful
- for debugging.
+ 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]
projects / paraslash.git / blobdiff