Difference between revisions of "Recitalserver"

From Recital Documentation Wiki
Jump to: navigation, search
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
===recitalserver===
 
 
The Recital Server daemon can be managed using the recitalserver script.
 
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’.'''
+
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 [http://www.recitalsoftware.com/index.php?option=com_content&view=article&id=242] will be enabled.
+
−
 
+
−
<pre># recitalserver start [-l | logging]</pre>
+
  
 +
===start [ -l | logging ]===
 +
Used to start the Recital Server daemon.  An optional -l or ''logging'' parameter can be specified to enable server logging.
 +
<pre>
 +
recitalserver start -l
 +
</pre>
  
 
===stop===
 
===stop===
 
Used to stop the Recital Server daemon.  A confirmation message will be displayed showing whether the daemon was successfully stopped or not.
 
Used to stop the Recital Server daemon.  A confirmation message will be displayed showing whether the daemon was successfully stopped or not.
  
−
<pre># recitalserver stop</pre>
+
<code lang="bash">
−
 
+
  recitalserver stop
−
 
+
</code>
−
===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.
+
−
 
+
−
<pre># recitalserver shutdown message Please log out</pre>
+
−
 
+
−
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:
+
−
 
+
−
<pre>Recital logins are currently disabled. Please try again later.</pre>
+
−
 
+
−
===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===
+
−
Enable the recital daemon and interactive users. This will enable new connections and users
+
  
 
===restart===
 
===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.
 
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.
−
 
+
<code lang="bash">
−
<pre># recitalserver restart</pre>
+
  recitalserver restart
−
 
+
</code>
−
===suspend===
+
−
Suspend the recital daemon and interactive users. This will suspend all connections to the recital server and exist-ing users.
+
−
 
+
−
===resume===
+
−
Resume the recital daemon and interactive users. This will resume all suspended connections and users.
+
−
 
+
−
===logout [<message>]===
+
−
logout interactive users. A logout message can be sent to interactive users before the they are logged out.
+
−
 
+
−
===terminate [ pid ]===
+
−
Terminate cleanly the specified recital process.
+
−
 
+
−
===broadcast [ < message> ]===
+
−
broadcast a message to all current interactive users. If no message is specified then any pervious broadcast message will be cleared.
+
  
 
===status===
 
===status===
 +
Used to return if the server is currently running.
 +
<code lang="bash">
 +
  recitalserver status
 +
</code>
  
 
===fullstatus===
 
===fullstatus===
Line 68: Line 36:
 
* How many concurrent connections are currently being used for each server
 
* How many concurrent connections are currently being used for each server
 
* Whether logging is enabled or not
 
* Whether logging is enabled or not
−
 
+
<code lang="bash">
−
<pre># recitalserver status</pre>
+
recitalserver status
−
 
+
</code>
  
 
===help===
 
===help===
 
Used to display usage information.
 
Used to display usage information.
−
 
−
<pre>
 
−
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
 
−
</pre>
 
  
 
===version===
 
===version===
 
Used to display version and compilation date information for the Recital Server:
 
Used to display version and compilation date information for the Recital Server:
 +
<code lang="bash">
 +
recitalserver version
 +
</code>
  
−
<pre># recitalserver version</pre>
+
[[Category:Documentation]]
−
 
+
[[Category:Reference]]
 
[[Category:RDS_Configuration]]
 
[[Category:RDS_Configuration]]

Latest revision as of 14:35, 28 June 2010

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 [ -l | logging ]

Used to start the Recital Server daemon. An optional -l or logging parameter can be specified to enable server logging. 

 recitalserver start -l

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

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

status

Used to return if the server is currently running. 

recitalserver 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.

version

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

recitalserver version
Retrieved from "https://www.recitalsoftware.com/wiki/index.php?title=Recitalserver&oldid=15000"