System-wide Set-up Options

CliqCalc provides a number of set-up, or profile options that apply to the entire system or serve as the default options for all users. Most of these option settings are contained in a special profile options file named qcalc_pro located in a directory named $QLIB/qsp/profiles (see Cliq Installation Guide and Release Notes for explanation of the $QLIB environment variable).

Each time CliqCalc starts up, it looks for a qcalc_pro profile options file in $QLIB/qsp/profiles. It will read and process this file if it exists (it is not required). Next, CliqCalc looks for a file in the same directory with a name that matches the user’s current terminal name, as specified in the TERM environment variable. This allows particular settings, such as function key bindings to CliqCalc commands, to be terminal-dependent. For example, if the terminal type is vt100, the file $QLIB/qsp/profiles/vt100 will be processed, if it exists.

Next, CliqCalc looks for a file called qcalc_pro in the user’s personal profiles directory, as specified by the value of the HOME environment variable ($HOME/profiles/qcalc_pro). Finally, CliqCalc looks for a terminal-specified profile in this directory, e.g., $HOME/profiles/vt100.

There need not be any profiles of any kind for CliqCalc to operate. However, it may be desirable to alter some of CliqCalc’s behavior in which case it is usually advisable to use a terminal-specific profile (see the Bind profile option discussion below) with CliqCalc.

CliqCalc does not use standard Cliq Termcaps. Instead, it uses the standard termcap or terminfo terminal descriptions defined for the operating systems you are using. Before running CliqCalc, make sure that there is an entry in the system’s terminal description database for each terminal description database for each terminal that will be used to access CliqCalc.

In addition, CliqCalc supports special terminal profiles that bind keys on the keyboard of a particular terminal to special CliqCalc functions. These terminal profiles are made up primarily of Bind option statements, and are contained in special files which must have the same name as the entry in the termcap or terminfo database for the terminal specified by the TERM environment variable setting. Bind option statements may also be placed in the qcalc_pro file. This will cause these key bindings to apply to all terminals used.

Terminal profiles may also contain other profile options having to do with terminals including Terminit, Termfin, Widestart, and Wideend. These files must be located in the CliqCalc profile directories mentioned above at either the system level ($QLIB/qsp/profiles) or user level ($HOME/profiles).

A pre-defined set of terminal profiles are included in the CliqCalc distribution and will be placed automatically in the system-level profile directory ($QLIB/qsp/profiles) by the installation procedure. Each of these pre-defined terminal profiles assigns regular Cliq function keys to CliqCalc functions as shown on pages D-6 through D-10 in the Appendix section of the CliqCalc Guide.

Pre-defined terminal profiles are included for the following terminals:

If any of the above terminals are in use, and the standard Cliq function key assignments shown in the Appendix are satisfactory, it is recommended that the pre-defined terminal profiles be used. These key assignments will best match the keystrokes shown in the CliqCalc user guide. However, if terminals other than those listed above are in use, or the key assignments shown above are unsatisfactory, terminal profiles must be defined as described below.

Using the Bind Profile Option

To define a terminal profile, use the Bind profile option to assign each key on the terminal keyboard to a CliqCalc function or operation. As shown below, the Bind profile option assigns the code sequence sent by one of the keys on the keyboard to the code sequence for the CliqCalc function to be tied to the key. Here is the syntax for the Bind profile option:

Bind = inseq – outseq

Where inseq is the code sequence sent by the terminal for that keystroke, and outseq is code sequence to be sent to CliqCalc each time the inseq is received. Each Bind profile option is placed on one line in the terminal profile file, and there may be any number of Bind statements as necessary to properly define the keys on the terminal for use with CliqCalc.

There may be various reasons to change the behavior of selected input keystroke sequences. For example, to give particular meaning to otherwise unrecognized terminal-specific function keys, or to solve problems caused by the sequences sent by a particular terminal’s arrow keys. The Bind profile option tells CliqCalc that upon receipt of the input sequence inseq, it should behave as the sequence outseq was actually sent.

In specifying inseq and outseq, the following can be used:

• ^X to denote a control character, e.g., CTRL-X
• \nnn (three octal digits) to denote any ASCII character
• \E, \\, \^, \n, \r, \t, \b, \f, \# to denote escape (\033), backslash, uparrow, line-feed, carriage return, tab, backspace, formfeed, and the number symbol respectively.

The following are some examples of how the Bind profile option can be used:

On a VT100, there are four function keys labeled PF1, PF2, PF3, and PF4. If a special terminal profile for the VT100 is not used (note that one is provided with the distribution), CliqCalc will not recognize these keys. Suppose, however, that the PF1 key is to signify /worksheet insert row to CliqCalc. The PF1 key transmits the key sequence \EOP with the following line added to the profile:

Bind = \EOP - /wir

Which is probably best set up in $QLIB/qsp/profiles/vt100. These are the CliqCalc internal representations for the arrow keys:

^Xl - Left Arrow

^Xr - Right Arrow

^Xn - Up Arrow

^Xd - Down Arrow

An outseq of ^Xd can be used to define an input sequence to stand for Down Arrow on a terminal without arrow keys. On some terminals, the Backspace and Left Arrow keys both send the same code, ^H. thus, when Backspace is pressed, CliqCalc cannot distinguish it from Left Arrow. This problem is solved in one of two ways.

One method is to use the DEL key to act as the backspace assuming DEL is not the system interrupt key. If it is the system interrupt, another key can be first specified as the interrupt key with the following line in the .profile or .login file:

Stty intr "^C" erase "^?"

making ^C the interrupt character.

The second method would be to choose another key, e.g., an unused function key, that sends \E1 to signify Backspace to CliqCalc.

Defining other Profile Options

This section explains how to use each of the other profile options listed above. General profile options are contained in a file named qcalc_pro. Terminal-specific profile options will usually be contained in files named after the entry in the termcap/terminfo data base for the terminal being used. System-wide profile options files are located in the directory $QLIB/qsp/profiles. These system-wide options can be overriden at the user level by profile option files located in the user's $HOME/profiles directory.

A profile option file is a normal UNIX file created with almost any editor, Cliqword for example. This file contains a sequence of lines of the form:

Keyword = Value

All possible keywords and values are explained as follows. The following keywords and value types are recognized in a CliqCalc profile.

number stands for any numeric value

yesno stands for either the word yes or no

Profile items which are updated in the $HOME/profiles directory from the / worksheet global default update command are marked with an asterisk (*). The number symbol character (#) starts a comment that runs to the end of the line.

Whenever you run CliqCalc, it will automatically perform the / file retrieve command on the specified file.

Backup Backup = yesno

Normally, CliqCalc will "backup" the existing copy of a worksheet file when you save a new copy of it. For example, if you save a file named sales, the old file sales.wk1 (if one exists) will be renamed sales.wk1.bak and a new sales.wk1 will be created. If you would rather not save these backup files, specify no in this profile option.

Beep Beep = yesno

CliqCalc will normally toggle the speaker on your terminal when you make a mistake entering a formula or command. If you would rather turn sound off, specify no in this profile option.

Blanks *blanks = number

By default, there are two blank lines at the top and bottom of each printer output page. You can set this to any number, including zero.

ColWidth ColWidth = number

When you first start CliqCalc, all columns have a default width of 9 characters. To change this global default, add or modify the above line in the profile ( number cannot exceed 72.)

Confirm Confirm = yesno

This option defaults to no meaning that rows or columns may not be deleted without first asking for confirmation.

CursorCtl CursorCtl = number

This option is available for tuning the behavior of your arrow keys while running CliqCalc. The number represents a discard count which is the count of keystrokes to be discarded after each keystroke processed when the arrow key is held down. The default value for number is 6. Increasing the value leads to faster cursor motion, with potential run-on after the key is released.

Directory *Directory = string

Normally, CliqCalc uses the current system directory as the default for reading and saving files. If another directory is desired, specify that directory as "string" above.

Extension Extension = string

The default file extension for CliqCalc is ".wk1". If another extension is desired, it may be specified as string above. Note that CliqCalc files must use the default of .wk1 if they are to be opened directly from CliqDesk.

HeadFoot HeadFoot = yesno

If set to yes (the default) every printed page will have one header line and one footer line regardless if there is any header or footer data to be printed.

IntlDate *IntlDate = X

X is one of the characters A, B, C, or D, corresponding to the choices in the / worksheet global default other international date menu.

IntlTime *IntlTime = X

X is one of the characters A, B, C, or D, corresponding to the choices in the / worksheet global default other international time menu.

Margin *MarginLeft = number (default = 4 characters)

*MarginRight = number (default = 4 characters)

*MarginTop = number (default = 2 lines)

*MarginBottom = number (default = 2 lines)

MoneyPrefix *MoneyPrefix = yesno

Set to yes if the MoneySymbol character is to appear to the left of the formatted values or no if it should appear to the right.

MoneySymbol *MoneySymbol = string

MoneySymbol is the currency symbol - the default string = "$".

PageLength *PageLength = number

The page length expressed in number of lines. The default is 66.

Play *Play = string

When CliqCalc starts, it will automatically execute the keystrokes contained in string.

Precision Precision = number

Represents the number of decimal places for which a number will be displayed. The default number is two.

Punctuation *Punctuation = X

X is one of the characters A through H representing the choices from the / worksheet global default other international punctuation menu.

RangeLimit RangeLimit = number

RangeLimit is the number of maximum cells allowed in a worksheet file. The default is 4096 but can be increased to 8192 by setting number above.

On some combinations of terminals and systems, scrolling the screen does not operate correctly. If this is a problem, set Scroll = no which will cause CliqCalc to repaint the screen several rows at a time.

TermInit send the sequence to the terminal when CliqCalc is started. TermFin sends the sequence to the program when it is exited. These functions can be used, for example, to put the terminal into keypad shifted mode so that arrow keys will operate correctly.

If the terminal is capable of displaying 132 columns, sequence can be used to invoke and quit that mode. It is not necessary that the "wide" mode support exactly 132 columns, just that there be termcap/terminfo entry for the wide mode. As an example, a VT100 terminal will normally have an accompanying vt100-w termcap/terminfo entry in addition to the vt100 entry.

Properly defining WideStart and WideEnd will enable the use of CTRL-X+ to toggle between normal and wide modes. Note that the wide termcap/terminfo entry must be named with the character "-w" appended to the normal terminal name.

WriteHead *WriteHead = yesno

If set to yes, the row and column numbers will be printed on each printed page. The default is no.

Chapter 9 of the CliqCalc User Guide describes the use of  |\??? commands which are used to modify the appearence of printed output. In general, when a |\??? font code is entered in a spreadsheet, the CliqCalc printing facility looks for a font file (font files are in $qlib\font) which has the same file name as the Printer Type contained in the Printer Definition Configuration and the same file extension ID (0 through 54) as equating to the |\??? code as referred to in Chapter 9 of the User Guide. In other words, if the Printer Type is set to "hplaser", the command |\193 will designate hplaser.01 as the applicable font file. Note that it is necessary to open the font file with a text editor to observe the font attributes - for example, hplaser.01 is described as portrait, roman 8, fixed, 10 pitch

To further illustrate, suppose an HP Laser 4 printer is set up with a Printer Type of "hplaserlp0" (to designate the renamed printcap of "hplaser3") in order to use the Unix spooler.

• It will first be necessary to copy the required hplaser3 font files (compressed print, etc) to new names (with the same numeric extension) but with the "hplaserlp0" name used in the Printer Definitions setup.

New in CliqCalc Version 1.2

Dates are represented in CliqCalc (and in early versions of Lotus 1-2-3 replaced by CliqCalc) by means of an integer - the integer "1' representing the date 1/1/1900. In the past, the integer "36525" represented the date 12/31/99 but dates beyond 12/31/99 did not display or calculate correctly. The common date display formats were either "mm/dd/yy" or "dd-mmm-yy" - in either case, the year represented by the last two digits of the year. In this situation, the program could not distinguish between "1/1/1900" and "1/1/2000." Version 1.2 solves this problem by enabling dates to display and calculate using a four digit year designation for years after 1999. Thus, for dates through 12/31/99, the program works exactly as before and dates should be entered using the two character representation. For dates after 12/31/99, dates must be entered using a four character year representation.

The following worksheet examples illustrate this discussion:

• Column "a" are dates expressed using @date(yy,mm,dd) or @date(yyyy,mm,dd) in the case of dates after 12/31/99 and are displayed with the "D4" format.
• Column "b" are the equivalent date integers using the function - e.g. @datevalue(a1) and displayed using the "general" format.
• Column "c" are the years using the function @year(a1...a6) and displayed with the "general" format
• Column "d" are the dates displayed using the "D3" format which is either "mmm-yy" or "mmm-yyyy"
• Column "e" are the dates in column "a" with 366 added to each - e.g. "+a1+366" - and are displayed in the "D1" format. Note that leap years are handled correctly.

The following are some additional limitations and/or conditions relating to CliqCalc.

1. If worksheets from other platforms or programs are set to manual recalculation and then loaded into CliqCalc, recalculation must be first re-executed and the file immediately saved. Editing may then proceed normally.
2. When a file is retrieved, there will no warning that changes have been made to a currently open worksheet. Users must therefore be sure to save current worksheets before retrieving another worksheet.
3. Protection on individual fields is ignored during /file combine and /worksheet erase commands. The contents of these fields will be changed.
4. Using the /range format money command to set a range to a specific currency symbol is not maintained after a save. Use the /worksheet global default other international currency command for a different symbol.
5. If an incorrect password is entered when opening a password protected worksheet, <RETURN> can be executed at the error message to open an empty worksheet.
6. An error message of "file already in use" may sometimes be encountered when attempting to load a spreadsheet file. This is normally caused by a previous improper shutdown of the program or the file. This condition prevents the lock file [filename.lck] from being deleted. If this condition occurs, the file may be manually deleted. Note also that a program error in this regard has been corrected in Version 1.2 of the CliqCalc program.