Manual Page

 The following is the UNIX-style manual page for CLEO. Most users can ignore this documentation and should either take a look at the "Getting Started with CLEO" or "CLEO Fundamentals" documentation.

 

---

cleo -- Main csh/Tcl script for CLEO, the Control Library for Engineers and Operators.

SYNOPSIS

/opt/local/bin/cleo [ -h | -help ] [ -display screenName ] [-ygor installDir ] [ -list ] [ -gbt | -gbi ] [-geometry WxH+X+Y] [ application ]

OPTIONS

The user can supply the following optional arguments:

-h or -help	Brings up a help page. All other options and operands are ignored.
-display screenName	Overrides the current DISPLAY environmental variable with one the user has specified. If not provided, the current value of DISPLAY is used. CLEO will produce an error message if DISPLAY isn't set and the -display option isn't specified.  Example:  -display vega:0.2
-ygor installDir	Overrides the currently defined YGOR_TELESCOPE environmental variable (i.e., M&C installation directory) with the directory the user has specified. CLEO will use /home/MU if YGOR_TELESCOPE isn't set and the -ygor option isn't specified.
-geometry WxH+X+Y	Standard X Window geometry specification for the placement of an application's screen.  W and H are the width and height of the application and X and Y are the placement of the screen from the top left corner of the screen (if positive) or the bottom right corner (if negative).  The values are only a suggestion and might be ignored by some applications.  Example:  -geometry 200x300-400+200
-gbt | -gbi	Whether the user wants to launch the GBT or GBI version of an application.  The default is -gbt.
-list	Produces a list of possible applications the user can specify.  All other options and operands are ignored.

OPERANDS

The user can supply the following operand if the -list, -help, or -h options aren't specified:

 

application

Name of the Tcl application the user wants to run. If an application isn't specified, the CLEO Launch application will be started.

EXAMPLES:

1. The following command:

   example% cleo

   will start up the GBT version of the CLEO Launch application using the current DISPLAY and YGOR_TELESCOPE environmental variables, if they are set. If DISPLAY is not set, an error message will be produced. If YGOR_TELESCOPE isn't set, /home/MU will be used.
   
   

2. The following command:

   example% cleo devexplorer -display vega:0.0 -geometry -200+300

   will start up the devexplorer application on the display vega:0.0 with the suggested position of 200 pixels from the right and 300 pixels from the top edge of the CRT.
   
   

3. The following command:

   example% cleo -gbi -ygor /gbt1/whoever -display vega:0.0

   will start up the GBI version of the CLEO Launch application using the the display vega:0.0 and the installation directory of /gbt1/whoever.
   
   

4. The following command:

   example% cleo -list

   will generate a list of applications that CLEO could start.
   
   

5. The following command:

   example% cleo devexplorer

   will start up the GBT version of devexplorer using the current DISPLAY and YGOR_TELESCOPE environmental variables if they are set. If DISPLAY is not set, an error message will be produced. If YGOR_TELESCOPE isn't set, /home/MU will be used.

ENVIRONMENT

CLEO will uses the following environmental variables if they have been set:

• YGOR_TELESCOPE -- path to the M&C installation directory).
• DISPLAY -- the X Window specification of what machine and display to use for an application.
• CLEODIR -- path to the version of CLEO one wants to use.

A user can override or set the YGOR_TELESCOPE  and DISPLAY variables with command line options.  CLEO will assume default values for the YGOR_TELESCOPE and CLEODIR  environmental variables if they are not set or overridden by a command-line option.

CLEO appends to the PATH and LD_LIBRARY_PATH environmental variables the names of appropriate directories relative to the YGOR_TELESCOPE directory.

CLEO runs in the user's current directory.