CTL-SETUP Command Reference
Synopsis
ctl-setup [-fv] -n nodename
Overview
The CTL-SETUP command is used to setup the CTL software after the distribution has been extracted into its installation directory.
The role of the ctl-setup command is to create a new instance of the CTL framework. CTL allows and encourages the splitting of the CTL software distribution (i.e., the executables that change from release to release), from the user specific configuration, data and module files.
During the first time installation or if the -f flag is set ctl-setup will create a new instance of the framework and generate all the configuration files found in $CTL_BASE/etc.
General Options
| Option | alternate | argument | description |
|---|---|---|---|
| -h | false | displays the usage information presented above | |
| -v | false | run verbose | |
| -f | false | Force re-generation of configuration files | |
| -n | true | The nodename |
Environment variables
The following environment variables are assumed during the execution of ctl-setup:
| key | description |
|---|---|
| JAVA_HOME | Java installation directory |
| CTL_HOME | CTL installation directory |
| CTL_BASE | CTL framework instance directory |
Execution
Examples:
ctl-setup -n adminhost
This executes the ctl-setup command defining the framework hostname as "adminhost"
ctl-setup -n user@targethost
Specifying the node name with a user@host format signifies the remote commands will be done as "user".