paraslash

Paraslash network audio streaming tools


About
News
Download
Documentation
Development

para_client

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
COPYRIGHT
NAME

para_client - Communicate with para_server through the paraslash control port

SYNOPSIS

para_client [--help] [--detailed-help] [--version] [--loglevel=<severity>] [--config-file=<filename>] [--history-file=<filename>] [--hostname=<host>] [--user=<name>] [--server-port=<portnumber>] [--key-file=<filename>] [--complete] [--] [command [options]]

DESCRIPTION

para_client is the program used to connect to a running instance of para_server. If a command is provided, this command is sent to the server and any output received from the server is echoed to stdout. If no command is given, para_client enters interactive mode.

OPTIONS

Common options
The following options are implemented generically and are available for many of the commands.
-h
, --help

print help and exit

--detailed-help

print help, including all details, and exit

-V, --version

print version and exit

-l, --loglevel=<severity>

control amount of logging

values: debug, info, notice, warning, error, crit, emerg

Log only messages with severity greater or equal than the given value. Possible values:

debug: Produces really noisy output. info: Still noisy, but won’t fill up the disk quickly. notice: Indicates normal, but significant event. warning: Unexpected events that can be handled. error: Unhandled error condition. crit: System might be unreliable. emerg: Last message before exit.

-c, --config-file=<filename>

path to alternative config file

default: ~/.paraslash/client.conf

para_client reads its config file right after parsing the options that were given at the command line. If an option is given both at the command line and in the config file, the value that was specified at the command line takes precedence.

--history-file=<filename>

location of the file for the command history list

If para_client runs in interactive mode, it reads the history file on startup. Upon exit, the in-memory history is appended to the history file.

If this option is not given, the history file is expected at ~/.paraslash/client.history.

Options for para_client
-i
, --hostname=<host>

IP address or name of the host where para_server is running

default: localhost

Both IPv4 and IPv6 addresses are supported.

-u, --user=<name>

the paraslash username to authenticate as

If this is not given, the current username is assumed.

-p, --server-port=<portnumber>

the port on the remote host to connect

default: 2990

If this is not given, the current username is assumed.

-k, --key-file=<filename>

path to private key

If not given, the following files are tried, in order: $HOME/.paraslash/key.$LOGNAME, $HOME/.ssh/id_rsa. It is a fatal error if the key file can not be opened, or is world-readable.

--complete

print possible command line completions

If this flag is given, the environment variables COMP_LINE and COMP_POINT are examined to obtain the current command line and the cursor position respectively. Possible completions are written to stdout and the program exits.

COPYRIGHT

Written by Andre Noll
Copyright (C) 2019 Andre Noll
License: GNU GPL version 2
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
Report bugs to Andre Noll