Recitaladmin

From Recital Documentation Wiki
Revision as of 17:26, 21 January 2010 by Yvonnemilne (Talk | contribs)

Jump to: navigation, search

Administration management tool used with the Recital software suite. It takes the following arguments.

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

--server

Perform administration of the recital server daemon. See recitalserver for full details.

--replication

Perform administration of the recital replication daemon. See recitalreplication for full details.

--integrity

This option is used to verify and if needed, repair Recital data files.

[ -f table ]

Specify a table to verify a table.

[ -d directory ]

Specify a directory to verify all files in a directory.

[ -D database ]

Specify a database to verify a database.

[ -r ]

Recursively process sub-directories.

[ -y ]

This will repair data errors if any are found.

[ -q ]

This will only display errors.

[ -a ]

Run in verbose mode.

recitaladmin --integrity  -D southwind

--convert

This option is used to convert data from disparate hardware platforms and databases into and out of Recital Databases.

[ all ]

Convert all files in the current directory.

[ prg ]

Convert program scripts in the current directory.

[ dbf ]

Convert tables in the current directory.

[ mem ]

Convert memory variable files in the current directory.

[ frx ]

Convert report files in the current directory.

[ <files> ]

An optional file list parameter can be specified to restrict the files converted.

[ -r ]

Recursively convert files in sub-directories.

recitaladmin --convert dbf ar*.dbf

--execute

filename [ <args> ]

Execute program file in the background as an agent. Args specified are declared as character variables in the called program. The file name extension defaults to .prg. Only program files that have no user input or display output can be run.

recitaladmin --execute  mqagent

--users

Perform user administration tasks on Recital

[ -r ]

This option will reset the existing recital users file. All users must be logged out before this task can be performed.

[ -c ]

This option will create a new users file if one doesn’t already exist.

[ -l ]

This option will list the current recital users.

recitaladmin --users -l

start

Start the recital daemon.

recitaladmin start

stop

Stop the recital daemon. This will prevent new connections and disconnect existing connections. It has no effect on interactive users.

recitaladmin stop

shutdown

Shutdown the recital daemon and interactive users. This will prevent new connections and disconnect existing connections and users. Subsequent interactive users logins are enabled.

[ Message ]

A shutdown message can be sent to interactive users before the shutdown.

recitaladmin shutdown  "Please log out."

disable

Disable the recital daemon and interactive users. This will prevent new connections, but not disconnect existing connections and users.

recitaladmin  disable

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

recitaladmin  enable

suspend

Suspend the recital daemon and interactive users. This will suspend all connections to the recital server and existing users.

recitaladmin  suspend

resume

Resume the recital daemon and interactive users. This will resume all suspended connections and users.

recitaladmin resume

logout

Log out interactive users.

[ Message ]

A log out message can be sent to interactive users before the they are logged out.

recitaladmin  logout  "Please log out for system maintenance."

broadcast

Broadcast a message to all current interactive users.

[ Message ]

If no message is specified then any previous broadcast message will be cleared.

recitaladmin  broadcast  "Hello everybody."

terminate

Terminate cleanly the specified recital process.

recitaladmin  terminate 999

help

Display this information

recitaladmin help

version

Display product version

recitaladmin  version