Difference between revisions of "Command Line"

From KiSS DP 558 STAGE2 WiKi
Jump to: navigation, search
(→‎-h, --help)
(→‎-s, --send)
 
(21 intermediate revisions by the same user not shown)
Line 76: Line 76:
 
=== -v, --verbose ===
 
=== -v, --verbose ===
  
−
kissdx -v
+
    kissdx -v
−
kissdx --verbose
+
    kissdx --verbose
  
 
When this switch is used, output messages to standard output will include a timestamp and process number, and many informational messages will be displayed, primarily to aid in debugging.
 
When this switch is used, output messages to standard output will include a timestamp and process number, and many informational messages will be displayed, primarily to aid in debugging.
Line 89: Line 89:
 
=== -s, --send ===
 
=== -s, --send ===
  
−
kissdx -s command
+
    kissdx -s command
−
kissdx --send command
+
    kissdx --send command
  
−
    command  
+
*'' command''
 +
Administration command to be sent.
  
−
    Administration command to be sent.
+
This switch is used to send an administration command to a running kissdx. Refer to the [[Administration Commands]] section for descriptions of the individual administration commands and how this feature can be used.
−
 
 
−
This switch is used to send an administration command to a running kissdx. Refer to the Administration Commands section for descriptions of the individual administration commands and how this feature can be used.
 
  
 
Combine with -m and / or -p switches to send the command to a specific server / port.
 
Combine with -m and / or -p switches to send the command to a specific server / port.
Line 104: Line 103:
 
=== -m, --mediacenter ===
 
=== -m, --mediacenter ===
  
−
kissdx -s command -m host
+
    kissdx -s command -m host
−
kissdx --send command --mediacenter host
+
    kissdx --send command --mediacenter host
−
 
 
−
    command
 
−
 
 
−
    Administration command to be sent.
 
  
−
    host
+
* ''command''
 +
Administration command to be sent.
  
−
    IP address or name of the computer to which the command is to be sent.  
+
* ''host''
 +
IP address or name of the computer to which the command is to be sent.  
  
−
This switch can be used in conjunction with the -s / --send switch to specify the server to which the administration command is to be sent. The host can be specified as an IP address or a host name on the network.
+
This switch can be used in conjunction with [[Command Line#the-s / --send switch|the-s / --send switch]] to specify the server to which the administration command is to be sent. The host can be specified as an IP address or a host name on the network.
  
−
The default host is localhost (i.e. the local computer) and will be used when this switch is not present.
+
The default host is '''localhost''' (i.e. the local computer) and will be used when this switch is not present.
  
 
This switch should not be specified when starting the kissdx server.
 
This switch should not be specified when starting the kissdx server.
Line 123: Line 120:
 
=== -p, --port ===
 
=== -p, --port ===
  
−
kissdx -s command -m host -p port
+
    kissdx -s command -m host -p port
−
kissdx --send command --mediacenter host --port port
+
    kissdx --send command --mediacenter host --port port
  
−
    command  
+
* ''command''
 +
Administration command to be sent.
  
−
    Administration command to be sent.  
+
* ''host''
 +
IP address or name of the computer to which the command is to be sent.  
  
−
    host  
+
* ''port''
 +
TCP/IP port on host to which the command is to be sent.
  
−
    IP address or name of the computer to which the command is to be sent.  
+
This switch can be used in conjunction with [[Command Line#the -s / --send|the -s / --send switch]] to specify the TCP/IP port to which the administration command is to be sent.
  
−
    port  
+
This switch can also be used when starting the kissdx server, to specify which TCP/IP port kissdx should be listening on for incoming administration commands.
  
−
    TCP/IP port on host to which the command is to be sent.  
+
The default ''port'' is '''8003''' and will be used when this switch is not present.
  
−
This switch can be used in conjunction with the -s / --send switch to specify the TCP/IP port to which the administration command is to be sent.
 
−
 
−
This switch can also be used when starting the kissdx server, to specify which TCP/IP port kissdx should be listening on for incoming administration commands.
 
  
−
The default port is 8003 and will be used when this switch is not present.
 
 
Retrieved from "http://www.famille-kahn.com/kissdxmanual/Kissdx_user_manual:_Command_Line"
 
Retrieved from "http://www.famille-kahn.com/kissdxmanual/Kissdx_user_manual:_Command_Line"

Latest revision as of 12:32, 3 March 2012

The kissdx Command Line - for kissdx v0.14.0

When issuing the command to launch kissdx, several switches (parameters, arguments) may be entered on the kissdx command line to control the behaviour of the kissdx instance being launched.

Modes of operation

kissdx has two mutually exclusive modes of operation:

Streaming server 

 This is the normal mode of a running kissdx. In this mode kissdx will
  * accept and process requests for audio, video and picture files from KiSS players
  * accept and process administration commands from admin clients
  * run continuously

Admin client 

 In this mode, a short-lived kissdx instance will
 * send an administration command to a kissdx instance that is already running in Streaming server mode
 * receive and process the reply from the Streaming server (optional, depends on command)
 * terminate immediately

We refer to the two modes as Server and Client for short in the overview below.

Overview of command line switches

Switch Switch (long form) Mode Header text
-c file --config=file Server Specify the configuration file to be used by kissdx.
-d --daemon Server Display summary information on how to invoke kissdx.
-h --help N/A Example
-v --verbose Either Output extended messages to aid in debugging.
-s command --send command Client Send command to a kissdx server running on the local host or on a remote host.
-m address --mediacenter address Client Communicate with the kissdx server running on host address.
-p port --port port Either Communicate with the kissdx server listening on port port (Client mode). Listen on port port (Server mode).

Details on command line switches

-c, --config

   kissdx -c file
   kissdx --config file
  • file

Absolute or relative path to a kissdx configuration file.

This switch can be used to specify a configuration file to be used by kissdx, overriding the standard behaviour of searching for a config file in predetermined locations.

If this switch is not specified, kissdx will search for the config file in the standard locations, as described in the configuration reference

-d, --daemon

    kissdx -d
    kissdx --daemon

This switch tells kissdx to go into the background and run disconnected from the terminal. The switch also causes output messages to be directed to the syslog instead of standard output. The -d switch is normally used on the command line that launches kissdx automatically from a startup file.

If this switch is not specified, kissdx will run in the foreground, with output messages displayed to standard output.

-h, --help

   kissdx -h
   kissdx --help

The -h switch causes kissdx to display a brief explanation of all command switches and general usage, and then exit immediately.

Combine with the -v switch to obtain more verbose help, including network TCP port usage.

-v, --verbose

   kissdx -v
   kissdx --verbose

When this switch is used, output messages to standard output will include a timestamp and process number, and many informational messages will be displayed, primarily to aid in debugging.

If this switch is not specified, kissdx outputs messages only when unexpected errors occur.

Also modifies -h / --help to provide more verbose help.

This switch should not be used in normal operation of kissdx.

-s, --send

   kissdx -s command
   kissdx --send command
  • command

Administration command to be sent.

This switch is used to send an administration command to a running kissdx. Refer to the Administration Commands section for descriptions of the individual administration commands and how this feature can be used.

Combine with -m and / or -p switches to send the command to a specific server / port.

This switch should not be specified when starting the kissdx server.

-m, --mediacenter

   kissdx -s command -m host
   kissdx --send command --mediacenter host
  • command

Administration command to be sent.

  • host

IP address or name of the computer to which the command is to be sent.

This switch can be used in conjunction with the-s / --send switch to specify the server to which the administration command is to be sent. The host can be specified as an IP address or a host name on the network.

The default host is localhost (i.e. the local computer) and will be used when this switch is not present.

This switch should not be specified when starting the kissdx server.

-p, --port

   kissdx -s command -m host -p port
   kissdx --send command --mediacenter host --port port
  • command

Administration command to be sent.

  • host

IP address or name of the computer to which the command is to be sent.

  • port

TCP/IP port on host to which the command is to be sent.

This switch can be used in conjunction with the -s / --send switch to specify the TCP/IP port to which the administration command is to be sent.

This switch can also be used when starting the kissdx server, to specify which TCP/IP port kissdx should be listening on for incoming administration commands.

The default port is 8003 and will be used when this switch is not present.


Retrieved from "http://www.famille-kahn.com/kissdxmanual/Kissdx_user_manual:_Command_Line"

Retrieved from "http://familien-hartvig.dk/wiki/index.php?title=Command_Line&oldid=674"