Difference between revisions of "Recitalserver"

Revision as of 00:25, 25 October 2009

Template:YLM to do The Recital Server daemon can be managed using the recitalserver script.

Note: recitalserver must be run as root. For systems with a hidden root account, please precede commands with ’sudo’.

start

Used to start the Recital Server daemon. A confirmation message will be displayed showing whether the daemon was successfully started or not. If the optional 'logging' or '-l' parameter is specified, all server logging [1] will be enabled.

# recitalserver start [-l | logging]

stop

Used to stop the Recital Server daemon. A confirmation message will be displayed showing whether the daemon was successfully stopped or not.

# recitalserver stop

shutdown

Used to stop the Recital Server daemon and disable interactive Recital users. A confirmation message will be displayed showing whether the daemon was successfully stopped or not. The optional message parameter can be used to broadcast a message to interactive Recital users.

# recitalserver shutdown message Please log out

Once any interactive users have logged out and the shutdown has completed, attempts to start an interactive Recital session will cause the following message to be displayed:

Recital logins are currently disabled. Please try again later.

disable

Used to disable new interactive Recital sessions. Existing interactive Recital sessions are unaffected.

The Recital Server

NOTE: An ODBC client attempting to connect to a disabled server will receive the following message:

Invalid license: errno(-24)

enable

restart

Used to restart (stop, then start) the Recital Server daemon. A confirmation message will be displayed showing whether the daemon was successfully started or not.

# recitalserver restart

suspend

resume

logout

terminate

broadcast

status

fullstatus

Used to display the following status information for the Recital Server:

• Whether the Recital Server is running or not
• Whether the Recital Web Server is active or not
• Whether the Recital Web Server is listening on its default port and/or port 80
• How many concurrent connections are licensed for each server
• How many concurrent connections are currently being used for each server
• Whether logging is enabled or not

# recitalserver status

help

Used to display usage information.

Usage: /usr/bin/recitalserver [start] [stop] [shutdown [message] ]
                             [disable] [enable] [restart] [suspend]
                             [resume] [logout [message] ] [status]
                             [fullstatus] [help] [admin comamnd]
                             [version] [broadcast [message] ]
                             [terminate [pid] ]

Options:
  start [ -l | logging]  : start the recital daemon, optionally with logging
  stop                   : stop the recital daemon
  shutdown [ message ]   : shutdown the recital daemon and interactive users
  disable                : disable the recital daemon and interactive users
  enable                 : enable the recital daemon and interactive users
  restart                : restart the recital daemon
  suspend                : suspend the recital daemon
  resume                 : resume the recital daemon
  logout [ message ]     : logout the recital interactive users
  terminate [ pid ]      : terminate cleanly the recital interactive user
  broadcast [ message ]  : broadcast message to recital interactive users
  status                 : return the current status of the recital daemon
  fullstatus             : return the full current status of the recital daemon
  help                   : display this message
  version                : display version information

version

Used to display version and compilation date information for the Recital Server:

# recitalserver version