Cliq for Linux....... Getting Started
Welcome......
Thank you for selecting software from Quadratron's Cliq family of products and welcome to the community of more than 1,500,000 users of our products since 1983. We believe them to be the best character-based office automation software products for LINUX as well as UNIX users and we hope you agree. The following information will assist you in installing and getting started with Cliq.
Selecting the Correct Cliq Product Set:
As of September 1999, our Standard Release has been tested to operate correctly on:
The Standard Release will not operate correctly on certain Linux distributions so we have therefore provided a "Special Release" for these releases. The Special Release has been tested on the following
Red Hat 5.x requires two simple modifications which may be done
after installation. They are:
Rename $/qlib/fonts/linux.bak to linux.00
Rename $/qlib/tkc/linux.rh5 to linux.tk5 (You may wish to first
save the existing linux.tk5 to linux.bak.)
Installation Instructions:
The procedure for installing Cliq on your system involves three steps:
(1) Loading Cliq from the distribution media.
(2) Running the Cliq Install Script.
(3) Post installation housekeeping.
Before you start.......
During both loading and install, you must be logged in as root or errors will result.
Choose a file system on your system which is large enough to accommodate all of the files on the Cliq distribution media. Approximately 28 mb is required for all Cliq Modules.
Loading Cliq on your system.......
Normally, you will have obtained Cliq via download from the Internet. If you received it on physical media, you may copy the Cliq distribution files form the distribution media into any directory within the selected file system. If you are upgrading, it is recommended that you install into a new directory rather than writing over the existing installation. After you are satisfied that the new installation is properly installed, the old version may be deleted.
If you received Cliq via download, it will be in the form of a tar file which will need to be unzipped. If you received Cliq on CD, you simply need to copy all the files to the desired directory and run the Cliq Install Script. Note that CD distributions include all modules so if installation of all modules is not desired, the applicable subdirectory should be deleted prior to running the install script.
If the entire contents of the CD Rom were copied to your hard disk, the subdirectory names and the applicable module name are as follows:
| $/new/0050COR $/new/0100ACC $/new/0150WRD $/new/0200FRM $/new/0250MNU $/new/0400DCT $/new/0450CLC $/new/0500TYP |
CliqDesk CliqAccessories CliqWord CliqForm CliqIT Dictionaries CliqCalc CliqPage |
(Must be Installed) (Used with CliqWord) (Must be used with CliqWord) |
If all modules are installed, approximately 28 MB of disk space is required.
Zipped files may be unzipped using the command:
tar -xvzf cliq???.tgz [where ??? is the module label]
After the files have been extracted and installed, the cliq???.tgz file(s) may be removed.
Note that all files are positioned relative to the directory you started from. No files are loaded into absolute pathnames. Once you have loaded and extracted all of the files, you are ready to run the Cliq install script.
Running the Cliq install script......
The install script is located in the directory you installed Cliq. Make sure you are logged in as root, connected to the installation directory, and enter the following command:
./install [return]
As part of the install script, you will be prompted for a Release Key. This is an alphanumeric code which will enable you to load the program once it is installed. Carefully enter this key making sure to distinguish between the letter "O" and the number "0". If you have a demo copy, this key will eventually (normally 30 days) expire after which you will not be able to load Cliq. To register and obtain a permanent release key, contact Quadratron via E-mail. If you have obtained a permanent release key, you will need to connect to the directory in which you installed Cliq and run a program called ./qlicense which will prompt you to enter the the permanent release key.
After the release key has been entered, the installation will be completed and "Installation Complete" will appear on your screen followed by the shell prompt. At this point,the Cliq Programs you have installed may be started by entering the command cliq [return]. See "Running Cliq from the Command Line Prompt" below for further information
The script will also prompt you for a series of responses which will
vary depending on the modules to be installed. Here are the questions and instructions for
responses.
Do you wish to continue installation ? (y or n)?
What directory should contain the Cliq execution script?
(Press <return> for the default of: /usr/bin)
When the Install Script has been completed, the environment variables, directories and files required by Cliq will have been set, created and/or initialized. Nearly all of the directories and files are located relative to the directory into which you loaded the contents of the distribution media. However, the specific directories and files listed below, which were either created or modified by the install script are located as follows:
/usr/spool/qspool
/usr/lib/crontab or /usr/spool/cron/crontabs/root
/usr/bin/cliq
If TERMDIR and MENUDIR environment variables were set, the Install Script resets them to the directories used by Cliq.
Post-Installation Housekeeping.......
The following steps should be performed after running the install script and prior to running Cliq:
Running Cliq From the Command Line Prompt.......
You may now run Cliq from the command line by entering cliq [return] . Note that individual applications are called from the <command> key - < tools > or <accessories > after CliqDesk has been loaded. An optional cliq - k [return] , will run the keytest program so that key assignments can be determined. The first screen you will see is called the "Desk Top" which will normally be a list of files which may be selected and viewed with CliqWord. If CliqWord was not installed, the plain text version of these files may be opened with another editor such as vi. The files are located in $qlib/qodflts/ext. From the Desk Top, all of the other Cliq facilities are available through the Command Menu or other keys described below under Function / Control Key Assignments.
Other options to utilize non-English prompts and help files are also available on special request. Contact Quadratron for information.
Cliq TERMCAPs:
TERMCAPs are terminal capabililties files which allow most terminals to function properly with Cliq. Cliq is function key driven, so these TERMCAPs provide a a standard set of key assignments which are the same from terminal to terminal. The termcaps included with Cliq for Linux are located in $QLIB/tkc. Additional TERMCAPs may obtained from Quadratron. Alternative TERMCAPs may be loaded for testing by simply entering Cliq [TERMCAP Name]
The following list of key assignments shows the control key sequence, the function key assignment (if the proper TERMCAP is set) and the applicable Cliq Function. Refer to the specific application user guide for Cliq functions or the keytest program described above to test your keyboard. A complete discussion of TERMCAPs and technical reference material for creating and modification is available from Quadratron and is also included on our Website.
Function / Control Key Assignments
(Example for SCO OpenServer with Term of "ansi")
|
|
Cliq Directories:
Cliq requires that a series of user level directories exist - primarily to support CliqAccessory files. Here are the directories Cliq uses:
$HOME/cliq...................... Contains all of the special directories for CliqAccessory files.
$HOME/cliqcall................ Contains all CliqCall phonebook files.
$HOME/cliq/clip............... Contains the clipboard files.
$HOME/cliq/date.............. Contains the CliqDate calendar and scheduling group files.
$HOME/cliq/mail.............. Contains all CliqMail mail basket files.
$HOME/cliq/mail/aliases.. Contains all CliqMail mailing list files.
$HOME/cliq/note.............. Contains all CliqNote notepad files
$HOME/godflts................. Contains user settings and user-defined macro files for all Cliq applications, the desk and tools list files, and the CliqWord clipboard record import format and Add-on Functions files.
These directories must exist for each user. If the do not exist, they will be created when first needed along with any default files needed.
Cliq Run-Time Environment:
The variables described below are established by Cliq and are accessible by processes running under Cliq:
QLIB - The "root" directory of the standard Cliq Qlib tree. QLIB will be set from a compiled-in-default if not present in the environment.
MENUDIR - The search path where menus and help volumes should be found. MENUDIR will be set according to the value of QLIB unless it is set in the process environment.
QPROMPTS - The three character operator language. It is used as a suffix on some language-dependent files. QPROMPTS will be set from a compiled-in default unless it is set in the process environment. Note that the Cliq execute script sets this variable.
PROMPTDIR - The search path where language dependent prompt files and user interface files should be found. If not set in the process environment, PROMTDIR defaults to $TERMDIR if TERMDIR was set in the process environment, and to $QLIB/goprompt/QPROMPTS.
TCAPDIR - The search path where Cliq TERMCAP files should be found. If not set in the process environment, TCAPDIR defaults to $TERMDIR if TERMDIR is set in the process environment, and to $QLIB/tkc otherwise.
PCAPDIR - The search path where Cliq PRINTCAP files should be found. If not set in the process environment, PCAPDIR defaults to $TERMDIR if TERMDIR is set in the process environment, and to $QLIB/pc otherwise.
FONTDIR - The search path where Cliq font files should be found. If not set in the process environment, FONTDIR defaults to $TERMDIR if TERMDIR was set in the process environment, and to $QLIB otherwise.
DFLTDIR - The search path where Cliq system files should be found. If not set in the process environment, DFLTDIR defaults to $TERMDIR if TERMDIR was set in the process environment, and to $QLIB otherwise.
DICTDIR - The search path where files used by the CliqWord spelling checker would be found. If not set in the process environment, DICTDIR defaults to $TERMDIR if TERMDIR was set in the process environment, and to $QLIB/qodflts otherwise.
ETCDIR - The search path where most other files used by Cliq will be found. If not set in the process environment, ETCDIR defaults to $TERMDIR if TERMDIR is set in the process environment, and to $QLIB/etc otherwise.
TERMDIR - A variable representing a search path where any file normally found in PROMPTDIR, TCAPDIR, PCAPDIR, FONTDIR, DFLTDIR, DICTDIR or ETCDIR can be found. If not set in the process environment, TERMDIR is set as a default searchpath consisting of a concatenation of the values that were determined for these variables.
ENVDIR - A search path where personal default files should be found. If not set in the process environment, ENVDIR is set to a compiled-in, system dependent default value (~/.godflts for UNIX).
QSPOOLDIR - The directory where print queue and related files are found. This variable is set from a compiled-in default. For security reasons, it cannot be overridden by an environment variable.
TMPDIR - A directory where temporary files should be created. If not set in the process environment, TMPDIR is set to a compiled-in, system dependent value (/tmp on UNIX).
QTERM - The type of terminal for which output is to be prepared. If not set in the process environment, QTERM is initialized to the TERM environment variable if it is set in the process environment, and "UNKNOWN" otherwise.
Bypassing the Desktop:
It may sometimes be advantageous to load one of the Cliq applications directly if the CliqDesk functions are not needed. For example CliqCalc users may wish to eliminate any confusion caused by key assignments when using CliqDesk as opposed to CliqCalc.
The procedure for accomplishing this is quite simple and straight forward involving a minor edit to the start up script used to call CliqDesk. First, the Cliq start up script (normally located in /usr/bin) needs to be copied to a new file name; e.g. "123" in the case of CliqCalc. This is because the environment settings contained in the start up script must be set regardless of the program being called. Next, the filename 123 is modified to call the appropriate application. In the case of CliqCalc, the actual program name is qcalc. To edit the script, go to the next to the last line which begins with the word "eval" and substitute the word "cliqdesk" with the desired application name - e.g. qcalc. In addition to qcalc, qedit applies to CliqWord and qform applies to CliqForm. Some of these programs also may be run with additional command options - contact Quadratron for details.
Printer Setup:
Only a System Administrator (logged in as "root") may add, change or delete a printer to be utilized by Cliq. Up to 300 printers (numbered 0-299) may be defined. Defined printers (up to 15) are listed on the Printer Definition screen which is accessed from the Cliq Desktop or Index by entering <COMMAND> - System utilities - System administrator -Define a printer. Printer definitions are added or modified by selecting the desired Pr # and entering <EXECUTE>. The following explains each field for a selected printer definition:
Printer # - The Cliq assigned printer number of the printer you are defining.
Printer Type - The code name (printcap name) for the printer as listed in the qlib/pc directory. The more commonly used printcaps included with Cliq for Linux are listed at the end of this section. Enter the code name without the ".pc" file extension.
Options - Used to specifiy optional spooling features for a printer. Normally left blank, this field is used only under very special circumstances.
Status - The current status of the printer; online, local, or accept. A printer that is online is connected and ready to print. Local means that print jobs will not be accepted or sent to the printer. With accept, the printer will accept jobs but will list them as waiting until the printer status is online. Lower case text must be used to enter this information.
Device Name - Refers to the full device name - e.g. /dev/lp1.
Locking Key - The information used to interact with the system locking convention for a particular printer Normally, this is the name of the lock file.
Controlling TTY - The terminal to send messages to if the submitting TTY is unavailable. Use the full name of the device - e.g., /dev/....
Stty for device - The stty command used to initialize the device to the proper modes - e.g., stty 1200 < /dev/lp1.
Command to restart system spooler - Used to enable non-Quadratron spoolers to begin printing. If other spoolers are in use, enter the appropriate UNIX command here. Leave blank if only Quadratron software is used for printing.
Description - Use this field to indicate a name which will be presented on the printer selection screen. e.g. - "Laser III in Accounting"
The following is a listing of the basic set of driver codes for the Printer Type field. If the printer you are using does not work properly with one of these codes, contact Quadratron.
fx80 - Use this printer type code for any Epson dot matrix printer and other printers in Epson mode of operation.
hpdesk Use this printer type code for the Hewlett Packard DeskJet series and other printers in this mode of operation.
hplaser3 - Use this printer type code forHewlett Packard laser printers and other printers emulating HP Laser operation.
pscript - Use this printer type code for all postscript printers.
plain - Use this printer type code for printers with independent return, linefeed, backspace and formfeed.
plainnb - Use this printer type code for printers with independent return, linefeed, and formfeed, but no backspace.
plainnl - Use this printer type code for printers with no independent return and linefeed; but with backspace and formfeed.
Printing with 'lp' or 'lpr':
Cliq can be configured to print with lp or lpr instead of the Cliq print spooler, Qspool. This may be appropriate if the printer is located some distance from the user or if some users wish to print with Cliq while others are using lpr. The procedure involves creation of a script which is called from the printcap each time a document is printed.
These are the steps:
Modify the printer definition.
Create a one line shell script.
Modify the printcap.
Rename font files.
Modifying the printer definition.........
Display the printer definition screen as described above.
Change the device name to /dev/null.
Delete any entry in the "Stty for device" field.
Save changes.
Exit Cliq.
Creating a shell script.........
Select a directory in the user's path - e.g., the /usr/bin directory.
Create the script with any desired name.
Enter a line similar to the following in the script: /usr /bin/lpr -P<HP_LP> where "HP_LP" is the printer name assigned with the printer configuration tool. Note that this example is applicable to Redhat Linux 6.0 - other Linux distributions may require different arguments and/or parameters. A raw printing option may need to be added as the last argument to this command. In most configurations, lpr is setup to print plain text files. Most Cliq files will contain control codes for the printer so the raw printing option allows data other than plain text to be sent to the printer. Since this option is different from one system to another, the operating system documentation may need to be checked for the correct syntax.
Save the file to a directory in the users' path.
Make the script executable.
Editing the Printcap........
Open the printcap file intended to be used. Printcap files are found in $QLIB/pc. It may be desirable to first copy the applicable Cliq printcap to a new file name to be used as the printer Type. This will be the name used in the Printer Definition setup.
At the end of the file, add the line, setup.post_filter=[path]script where script is the name of the shell script created above. Note that "path" may be omitted if the script is located in the user's path environment.
Modify the line, type_setup.post_filter=Qtypeset to read, type_setup.post_filter=Qtypeset, [path]script where script is the name of the shell script created above.
Save the file and exit.
Renaming Font Files........
Font files are text files found in $QLIB/font. They are grouped and named by using the same base name as the printcap file. Secondly, they use a file extension of "00" through "54" depending on the typeface, point size and other font characteristics. These characteristics can be determined by opening the file with any text editor. More information regarding fonts can be found in the Cliq Technical Reference Guide.
When Printcap files are renamed in order to print with "lp", the font files must also be copied to the new printcap name. Otherwise, the font files will not be located when printing with the new printcap. The file extension should be kept the same as the original.
Note: Complete information regarding printcaps and other printing issues can be found in the Cliq Technical Reference. This document may be found on our website at Product Support | Documents