Difference between revisions of "Recitaladmin"

From Recital Documentation Wiki
Jump to: navigation, search
(recitaladmin shell script)
Line 1: Line 1:
 +
==recital administration==
 +
Administration management tool used with the Recital software suite
  
 +
===Options===
 +
 +
      --server [ options ]
 +
Perform administration of the recital server daemon. See recitalserver [http://www.recitalsoftware.com/index.php?option=com_content&view=article&id=88] for full details.
 +
 +
      --replication [ options ]
 +
Perform administration of the recital replication daemon. See recitalreplication(1) for full details.
 +
 +
      --integrity  [ -f table  |  -d directory  | -D database | -r | -y  | -q  | -a]
 +
This  option  is  used  to verify and if needed, repair a Recital data files. Use -f table to verify a table. Use -d directory to verify all files in a directory. Use -D database to verify a database. Use -r  to  recursively  process sub-directories.  Use  -y  to  repair data errors if any are found. Use -q to only display errors. Use -a for verbose mode.
 +
 +
      --convert  [ all | prg | dbf | fmt | mem  | frx ] [ <files> ]
 +
This options is used to convert data from disparate hardware  platforms  and  databases  into  and  out  of  Recital Databases.  The first parameter is the file type to convert and the second optional parameter is the file(s) to convert.
 +
 +
      --execute  filename [ Args ]
 +
Execute program file.  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.
 +
 +
      --users  [ -c | -r | -l  ]
 +
The  -r  options  will  reset the existing recital users file. All users must be log out before this task can be performed. The -c options will create a new users file if one doesn’t already exist. The -l option will list  the  current recital users.
 +
 +
      shutdown  [ message ]
 +
Shutdown  the recital daemon and interactive users. This will prevent new connections and disconnect existing connections and users. A shutdown message can be sent to interactive users before the shutdown.
 +
 +
      disable
 +
Disable the recital daemon and interactive users. This will prevent new connections, but not disconnect existing connections and users.
 +
 +
enable
 +
Enable the recital daemon and interactive users. This will enable new connections and users
 +
 +
      suspend
 +
Suspend the recital daemon and interactive users. This will suspend all connections to the recital server and existing users.
 +
 +
      resume
 +
Resume the recital daemon and interactive users. This will resume all suspended connections and users.
 +
 +
      logout  [ message ]
 +
Log out interactive users.  A log out message can be sent to interactive users before the they are logged out.
 +
 +
      broadcast  [ message ]
 +
Broadcast a message to all current interactive users. If no message is specified then any previous broadcast message will be cleared.
 +
 +
      terminate  [ pid ]
 +
Terminate cleanly the specified recital process.
 +
 +
      help 
 +
Display this information
 +
 +
      version
 +
Display product version

Revision as of 08:49, 26 October 2009

recital administration

Administration management tool used with the Recital software suite

Options

      --server [ options ]

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

      --replication [ options ]

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

      --integrity  [ -f table  |  -d directory  | -D database | -r | -y  | -q   | -a]

This option is used to verify and if needed, repair a Recital data files. Use -f table to verify a table. Use -d directory to verify all files in a directory. Use -D database to verify a database. Use -r to recursively process sub-directories. Use -y to repair data errors if any are found. Use -q to only display errors. Use -a for verbose mode. 

      --convert  [ all | prg | dbf | fmt | mem  | frx ] [ <files> ]

This options is used to convert data from disparate hardware platforms and databases into and out of Recital Databases. The first parameter is the file type to convert and the second optional parameter is the file(s) to convert. 

      --execute  filename [ Args ]

Execute program file. 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. 

      --users  [ -c | -r | -l  ]

The -r options will reset the existing recital users file. All users must be log out before this task can be performed. The -c options will create a new users file if one doesn’t already exist. The -l option will list the current recital users. 

      shutdown  [ message ]

Shutdown the recital daemon and interactive users. This will prevent new connections and disconnect existing connections and users. A shutdown message can be sent to interactive users before the shutdown. 

      disable

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

enable Enable the recital daemon and interactive users. This will enable new connections and users 

      suspend

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

      resume

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

      logout  [ message ]

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

      broadcast  [ message ]

Broadcast a message to all current interactive users. If no message is specified then any previous broadcast message will be cleared. 

      terminate  [ pid ]

Terminate cleanly the specified recital process. 

      help

Display this information 

      version

Display product version

Retrieved from "https://www.recitalsoftware.com/wiki/index.php?title=Recitaladmin&oldid=8413"