URL: http://www.firstbasesoftware.com/man/man5/setup.htm
Last modified: 4 January 1996
Copyright © by FirstBase Software.
[ Index of Contents] [ FirstBase RDBMS Overview]


NAME

setup - the setup (rc) file

SYNOPSIS

.firstbase-init

.fb-init

DESCRIPTION

The setup file is used to define most all environment variables that can be used to tune FirstBase. Global and local setup files are supported. The name of a setup file is .firstbase-init on machines that support arbitrary length file names, and .fb-init on those that do not. All FirstBase programs process any setup files before running.

One environment variable, $FIRSTBASEHOME, must be a true UNIX environment variable. This variable, usually set in either the .cshrc or the .login, along with the $PATH, controls the location of the FirstBase home directory.

The FirstBase home directory contains the global setup file. After processing the global setup file, FirstBase programs can process other setup files. These local setup files can be used to override or augment the definitions from the global setup file.

As another alternative, and for those situations where global or local setup files do not provide the needed flexibility, all FirstBase tools will accept command line environment commands of the form ENV_VARIABLE=VALUE. This is handy in situations where NOADDREC or REGEXP might be needed for a single database application only.

Note that processing of the local setup files and of the command line environment commands can be disabled by turning the LOCALRC variable to OFF in the global setup file.

The location of any local setup files is determined as follows: one setup file from the user's HOME directory or PATH list, and one from the working database directory. Either or both of these files will be processed if they exist. (Note: '.' must be in your PATH if you expect a 'current directory' setup file to be processed).

The lines of the setup files are of the form:

set variable value

Note: To store embedded blanks in a string value, use underscores.

Here is the sample setup file distributed with FirstBase:


set ASKGEN ON
set ASKWRITE OFF
set CHOOSEFIELD ON
set DIRNAME ON
set INFOLINE ON
set INTERRUPT OFF
set LOCKLEVEL 2
set LOCKMESSAGE 2
set LOCKTIME 60
set MAKEINDEX ON
set MENUPAUSE ON
set NAME_LENGTH 18
set NEGATIVE OFF
set PGENCOLS 132
set PUTFILE putidx
set RECLOG OFF
set REGEXP OFF
set REVERSE ON
set RUNFLAGS -y
set SHELL /bin/sh
set STANDOUT ON
set USRLOG 0
set VIPAUSE ON
set VIADDPAUSE ON
set WRAPSCAN ON

The following is a description of each of the setup variables and the values used for controlling the variables.

ASKGEN
Accepted values are ON and OFF (default). Controls the "Do you want to Run" questions at the end of most FirstBase dbd dictionary editors. Set to OFF, no process chaining is ever done.

ASKWRITE
Accepted values are ON and OFF (default). Controls the "Write Record Now" question at the end of Record Level Mode within the FirstBase tools dbedit(1) and dbvedit(1).

BLOCKSIZE
Accepted values are positive integers, usually in multiples of 1024. Defines the size of the block buffer used by blockeach(3) to process as many records in as few disk reads as possible. The default is 1024. The blockeach mechanism is also used by all FirstBase generators that accept the -B command line flag. For example, dbigen(1).

CENTURYMARK
Accepted values are integers between 0 and 99. This value, representing the last two digits of a year, marks a point in time that helps define which century a given 6-digit FirstBase date occurs in.

Internally, FirstBase dates are represented as MMDDYY. When dates into the next century are required, DATEDISPLAY can be set to 10, and all dates will be logically viewed as MMDDCCYY.

The following formula determines the value of CC, the century value:

	if (YY > CENTURYMARK)
	   CC = CENTURYBASE
	else
	   CC = CENTURYNEXT

The default value for CENTURYMARK is 50, CENTURYBASE is 19, and CENTURYNEXT is 20. All of these FirstBase setup variables are settable in the normal manner.

CHOICEADDPAUSE
Accepted values are ON and OFF (default). Controls whether or not dbedit(1) will pause before displaying the choicefield during new record entry only.

CHOICEPAUSE
Accepted values are ON and OFF (default). Controls whether or not dbedit(1) will pause before displaying the choicefile. However, pausing on new records is controlled by the CHOICEADDPAUSE variable.

CHOICEPAUSE_MSG
String value used in dbvedit(1) as the prompt during the CHOICEPAUSE question. The default is
Edit Choice Field `FieldName' Now? (y=yes, <other>=no):

CHOOSEFIELD
Accepted values are ON and OFF (default). Normally, field names are used to build selection criteria in the dictionary editors. However, if the CHOOSEFIELD environment variable is ON, fields can be selected from a list of numbered entries. This feature works only with dbdind(1), dbdprt(1), and dbdupd(1),

CCOMMAND
Actual environment variables are CCOMMAND0 through CCOMMAND9. These environment variables allow the tying of custom executable commands to the Record Level of dbvedit(1). Each CCOMMAND is fed a set of data files from the current record. See dbedit(1) from more details. See also the HOME_CCOMMAND and WDIR_CCOMMAND environment variables.

CCOMMAND_PROMPT
Actual environment variables are CCOMMAND_PROMPT0 through CCOMMAND_PROMPT9. These environment variables allow the tying of custom prompt strings to each of the executable custom commands as defined via CCOMMAND. These prompt strings will be printed as the custom command is executed.

CCOMMAND_SHELL
This variable controls the shell used by dbvedit(1) during custom command execution. Accepted values are full path names of UNIX command interpreter shells, with the default being /bin/sh. Note that a value of /bin/csh_-f could be used to execute the Cshell with the -f argument for fast startup. The default shell is /bin/sh.

CPU_BYTEORDER
This variable controls whether the CPU uses big endian or little endian byte ordering. The value 4321 is used for big endian and 1234 for little endian. If set to 0, an attempt is made to determine the native byte ordering by reading the file $FIRSTBASEHOME/BIGE. In conjunction with DBASE_BYTEORDER, this variable can be used to enable a database to be shared among computers with different byte orderings. The general idea is to pick one database ordering, set that in the .firstbase-init file in the database directory, then set CPU_BYTEORDER to 0 in a global file.

DATEDISPLAY
Accepted values are 8 (default), 10 and 11. Defines how FirstBase will display dates. A value of 8 indicates MM/DD/YY displays, 10 means MM/DD/CCYY. A value of 11 means "DD Mon CCYY", as in "16 Feb 1993". See also CENTURYMARK and DATESTYLE.

Note that all manner of FirstBase date behavior is affected by changing this environment variable, including index generation, index searches, and the dates displayed in all FirstBase output tools and generators.

DATESTYLE
Accepted values are 1 and 2. This variable controls the style of dates within FirstBase: a value of 1 (default) indicates American style dates (MM/DD/YY), a value of 2 indicates European style dates (DD/MM/YY).

DBASE
Accepted values are normal file names -- with no extensions. The file name will be used as the default database name, instead of the internal default dbase. Similar set commands can be used for INDEX, SCREEN, and VIEW.

DBASE_BYTEORDER
This variable controls whether the database is using big endian or little endian byte ordering. The value 4321 is used for big endian and 1234 for little endian. If set to 0, an attempt is made to determine the native byte ordering by reading the file $FIRSTBASEHOME/BIGE. In conjunction with DBASE_CPUORDER, this variable can be used to enable a database to be shared among computers with different byte orderings. The general idea is to pick one database ordering, set that in the .firstbase-init file in the database directory, then set CPU_BYTEORDER to 0 in a gloabl file.

DBSHELL_ECOMMAND
toggles the ability to use the dbshell(1) environment control screen. Accepted values are ON (default) and OFF.

DBSHELL_PSTRING
String value used in dbshell(1) as the prompt string. The default is
Enter Selection:

DBSHELL_PLOC
String value used in dbshell(1) to control the prompt location. For example, a value of 17,5 would use row 17, column 5 as the location for the prompt. The prompt string (DBSHELL_PSTRING) is accounted for before the actual input location is determined. The default coordinates are row 24, column 1.

DBSHELL_PILENGTH
Numeric value used in dbshell(1) as the prompt input length, the maximum number of characters allowed to be typed at the prompt. The default is 15.

DBSHELL_SHELL
This variable controls the shell that dbshell(1) uses when executing command scripts. Accepted values are full path names of UNIX command interpreter shells, with the default being /bin/sh. Note that a value of /bin/csh_-f could be used to execute the Cshell with the -f argument for fast startup.

DBVEDIT_REC_PLOC
String value used in dbvedit(1) to control the prompt location for record level. For example, a value of 17,5 would use row 17, column 5 as the location for the prompt. The prompt string (PROMPT_RECORDMSG) is accounted for before the actual input location is determined. The default is 24,1.

DBVEDIT_REC_PILENGTH
Numeric value used in dbvedit(1) as the record level prompt input length, the maximum number of characters allowed to be typed at the prompt. The default is 8.

DBVEDIT_CHO_PLOC
String value used in dbvedit(1) to control the prompt location for choice and extended choice screens. For example, a value of 17,5 would use row 17, column 5 as the location for the prompt. The prompt string (PROMPT_CHOICEMSG) is accounted for before the actual input location is determined. The default is 24,1.

DBVEDIT_CHO_PILENGTH
Numeric value used in dbvedit(1) as the prompt input length for choice and extended choice screens. Prompt input length is the maximum number of characters allowed to be typed at the prompt. The default is 10.

DBVEDIT_CHO_FIRSTLINE
Numeric value used in dbvedit(1) as the first line of display for all extended choice screen displays. The default is 3.

DECIMAL
Accepted values are ON and OFF (default). Controls the style of dollar input. The default is to not accept a decimal in DOLLAR input, and to force the user to enter all penny values.

If DECIMAL is turned ON, then dollar input accepts a decimal, and provides trailing zeros for the pennies value if no decimal is input.

DIRNAME
Accepted values are ON (default) and OFF. Controls the display of the directory name in the information line which foots all the screens of the FirstBase tools.

EDITINPUT
Accepted values are ON and OFF. Controls the use of the editable input mechanism described in input(5) and keyboard(5). Since this setting triggers an extensible set of keyboard signals, the default is OFF. To enable the full editable input mode throughout the FirstBase, change this value to ON.

ERRORLOG
Controls the logging of FirstBase system error messages. To turn the error logging on, set ERRORLOG to a writeable file name, for example /usr/adm/firstbase.error. When a FirstBase error occurs of any kind (except the most trivial) the error is logged in the indicated file. The default is not to log system error messages.

EX_CHOICEADDPAUSE
Accepted values are ON and OFF (default). Controls whether or not dbvedit(1) will pause before displaying the extended choice database selections during new record entry only.

EX_CHOICEPAUSE
Accepted values are ON and OFF (default). Controls whether or not dbvedit(1) will pause before displaying the extended choice database selections. However, pausing on new records is controlled by the EX_CHOICEADDPAUSE variable.

EX_CHOICEPAUSE_MSG
String value used in dbvedit(1) as the prompt during the EX_CHOICEPAUSE question. The default is
Edit Extended Choice Field `FieldName' Now? (y=yes, <other>=no):

EX_FORCEONE
Accepted values are ON and OFF. Controls the forced selection of a single extended choice when there are no other choices available. The default, OFF, means the user must select a choice even when the choice list has only a single entry.

EX_FULLKEY
Accepted values are ON and OFF. Flag to control whether all filter fields are used as the extended choice filters. The default, OFF, means that characters beyond an empty filter field are not considered during the record searching.

EX_REVERSE
Accepted values are ON and OFF. Flag to control whether extended choice selections are displayed in reverse video or not. Default is ON.

FIXEDWIDTH
Accepted values are 0 (default) and 1. When set to 1 causes the FirstBase engine to store records in a fixed width manner as opposed to the normal variable length format. See also putrec(3).

FORCEAUTOINCR
is used to force the <RETURN> keystroke when AUTOINCR fields are being edited using dbedit(1) or dbvedit(1). Accepted values are ON and OFF (default). This feature can be used to further force the automatic numbering of records.

However, use of this environment variable means that the contents of the AUTOINCR field cannot be overridden by the user. Specifically, if the field being incremented needs to be seeded, FORCEAUTOINCR will need to be OFF for the creation of the first record. It can then be turned back ON.

FUNCTIONKEYS
Accepted values are ON (default) and OFF. Toggles the use of extended terminal (termcap(5)) function keys. Turn this ON to enable arrow and function keys. Used only when EDITINPUT is OFF.

HITANYKEY
String value used as the simple and fatal error message prompt within all FirstBase tools. The default message/prompt is:
**_HIT_ANY_KEY_TO_CONTINUE_**_.

HOME_CCOMMAND
Controls the home directory of the CCOMMAND custom commands. The default is $FIRSTBASEHOME/ccommand.

INFOLINE
Accepted values are ON (default) and OFF. Controls the display of the information line.

INTERRUPT
Accepted values are ON and OFF (default). Most all generators (except dbcgen(1) and dbigen(1)) will allow themselves to be interrupted, no matter what they are doing, if you have the INTERRUPT variable set to 'ON'. Otherwise, all interrupt and quit signals are ignored.

In addition, dbload and dbrload will follow this firstbase environment variable. However, if either of these database load tools is interrupted, the database and index objects being updated should be deleted. See rmdb(8).

KEYPAD
Note: the following are used only when EDITINPUT is OFF.

These are a series of variables that control the signals assigned to the internal FirstBase keypad or k slots. The numbered function key slots, k0 through k9 are defined using KEYPADN. These correspond directly to the function key strings allowed in termcap(5).

When a function key is pressed, FirstBase determines what position, or k-slot, was used. Then, a search of the FirstBase KEYPADN definitions is done. If a match is found, the signal defined is emitted by the internal FirstBase data input mechanism.

For example, if the termcap(5) definition lists k4=\E227z, then ANY keyboard key that emits this sequence when depressed is known to the FirstBase system as KEYPAD4. Continuing, say that the .firstbase-init file contains a set KEYPAD4 WRITEREC line, then this function key will generate the internal FirstBase WRITEREC signal.

These are some other keystrokes that can be defined for use with FirstBase. These keys are assigned signals using KEYPAD_KEY where KEY is one of DOWN, UP, LEFT, RIGHT, ESCAPE, or TAB. For these, only the first four need termcap(5) entries: kd, ku, kl, and kr.

These keys are assinged just like the other function keys. For example, set KEYPAD_LEFT PREV would align the internal FirstBase signal PREV with the left arrow (assuming kl is properly set in termcap(5)).

The valid internal FirstBase signals that each of these KEYPADN and KEYPAD_KEY slots can generate are assigned using one of ABORT, DEFAULT, DELETEREC, END, HELP, NEXT, PAGEUP, PAGEDOWN, PRINT, PREV, CLEARFIELD, or WRITEREC.

LINES
Accepted values are >= 24. This environment variable is used to control the number of screen lines dbvedit(1) will use as a display window. This value is initially read from the terminal definition file, and then from the local window structure if applicable, but LINES can be used to force dbvedit(1) and dbshell(1) to use a 24 line window -- like all other FirstBase tools do anyway -- even when the terminal definition has the lines at a different setting.

LOCALRC
Accepted values are ON and OFF, the default is ON. When this variable is set to OFF, users local .firstbase-init files are not processed during the startup of FirstBase. In other words, turning this variable off disables users overriding global FirstBase settings.

LOCKDAEMON
Accepted values are ON and OFF, the default is OFF. When set to OFF, record and file locking (in a network environment) are done using fcntl and the standard NFS lock daemon, rpc.lockd.

When LOCKDAEMON is set to ON, record and file locking will be done using RPC calls to fblockd(8), the FirstBase lock daemon. The lock daemon should be running on the machine named in the SERVER variable (see below). Additionally, the dblockmgr(8) tool can be used to monitor, set and clear these file and record locks.

LOCKDERROR
This variable controls the name of a file that is tied to the UNIX stream stderr during the running of fblockd(8). If not specified, the file fblockd.err in $FIRSTBASEHOME is used.

LOCKLEVEL
Accepted values are 0, 1, and 2. This environment variable is used to control the amount of record locking that takes place throughout the FirstBase system.

If the LOCKLEVEL is 0, then no locking takes place at all. Level 1 indicates that only simple record locking among the database editors will take place. Level 2, the highest level of record locking, indicates that all FirstBase tools will use record locking.

Note that even when using LOCKLEVEL 2, FirstBase tools that read some record N will request only a read lock on record N -- not a write lock. So, although some process may have record N open for writing, other processes can read these records. LOCKLEVEL 2 does guarantee that even these records are not changing during this read access.

LOCKMESSAGE
Accepted values are 0, 1, and 2 (default). This environment variable is used to control the return method of the lock procedure when a non-blocking write lock is requested.

A value of 0 will cause no response error message at all. A value of 1 will cause a simple screen error. A value of 2 will cause the FirstBase tool to ask whether the user wants try again to satisfy the lock request. This environment affects only those tools that write to records: dbedit(1), dbvedit(1), dbugen(1), and dbrload(1).

LOCKTIME
Accepted values are positive integers, default is 60. This environment variable is used to control the amount of seconds a FirstBase process will block before aborting a blocking lock request. If the timeout signal is received, the entire process is halted with an appropriate error message.

LSERVER
This environment variable controls the use of the FirstBase Floating License system, and is used to point to the server, the machine running the fblserver(8) process.

Normally, this variable is not set for Fixed CPU Licenses. However, if it is set, the UNIX environment variable FIRSTBASE_FIXEDNODE can be defined. If this UNIX variable exists, then the fixed node license for FirstBase will be used.

LSERVERERROR
This variable controls a file that is tied to the UNIX stream stderr during the running of fblserver(8). If not specified, the the file /usr/adm/fblserver.err is used.

LSERVERLOG
This variable controls whether a FirstBase Floating License activity log will be written, and where the file will be kept. Use a full path name, for example /usr/adm/fblserver.log. Again, if this FirstBase variable is not set, the activity log file will not be kept.

MAKEINDEX
Accepted values are ON (default) and OFF. Controls the automatic regeneration of indexes by most generators. If set to "OFF", regeneration of indexes is not automatic.

MENUMATCH
Accepted values are ON and OFF. Controls whether or not dbshell(1) will force exact matches of commands before executing them. The default is OFF, meaning that dbshell will execute commands if given just enough to discern that request from another request. For example, the keystroke d could be used to execute the define command if there are no other d commands in the menu.

MENUPAUSE
Accepted values are ON (default) and OFF. Controls whether or not dbshell(1) will pause before exiting.

MERGECOLS
Accepted values are integers, default 80. This variable controls the default number used in dbmerge(1) for the width (-w) or number of columns to use for merge output.

NAME_LENGTH
Accepted values are integers. The NAME_LENGTH variable is a number that is used for the maximum allowable file name size before FirstBase adds any extensions to it.

This file name size should be set to 7 for compatibility between any UNIX machines. This low file name size is because for some UNIX boxes, 14 or 15 characters is the longest a file name can be.

However, for those who are using BSD UNIX or other flavors of UNIX that allow long file names, this set up file can be used to override the internal default of 7, as shown above. Remember that FirstBase can add at most a 7 character file name extension. A good setting is 18.

NEGATIVE
Accepted values are ON and OFF. The NEGATIVE variable from the setup file shown above is used to change formats of display for negative dollar amounts. The default display for negative dollar amounts is with parenthesis, like this (1,234.56). If you set NEGATIVE to OFF, negative dollar amounts will print as -1,234.56.

NOADDREC
is used to control the ability to add records to a database using either of the database editors, dbedit(1) or dbvedit(1). Accepted values are ON and OFF (default).

OKSTOP
is used to control the ability to issue a SIGTSTP signal from the keyboard. Accepted values are ON and OFF (default). The native UNIX shell must support job control for this feature to work.

If supported, a stop signal (typically <CTL>-Z) will freeze the FirstBase tool process, and return control to the shell. The fg command (see csh(1)) will resume the process. Note that a stop signal is accepted only during user input, i.e. from the input dots.

PGENCOLS
Accepted values are integers, default 80. This variable controls the default number used in dbdprt(1) for the number of columns to use for a printout.

PROMPT_ADDMODE1
String value used in dbvedit(1) and dbvemit(1) as the initial add mode prompt for field one of page one. The default message/prompt is:
Enter_Data,_-=END,_<CTL>-D=Defaults,_<CTL>-H=help

PROMPT_ADDMODE2
String value used in dbvedit(1) and dbvemit(1) as the secondary add mode prompt for all other fields. The default message/prompt is:
Enter_Data,_<CTL>-X=Abort_Record,_<CTL>-H=help

PROMPT_AUTOFIELD
String value used in dbvedit(1) and dbvemit(1) as the prompt displayed during auto field level. The default message/prompt is:
Enter_Data,_-=END,_<CTL>-X=Abort_Field,_<CTL>-H=help

PROMPT_NORMALFIELD
String value used in dbvedit(1) and dbvemit(1) as the prompt displayed during normal field level. The default message/prompt is:
Enter_Data,_<CTL>-X=Abort_Field,_<CTL>-H=help

PROMPT_RECORDMSG
String value used in dbvedit(1) and dbvemit(1) as the prompt displayed during normal field level. The default message/prompt is:
Field_#_(<CTL>-H=Help,_-=End):

PROMPT_COMMANDMSG
String value used in dbvedit(1) and dbvemit(1) as the prompt displayed during normal command level. The default message/prompt is:
<CTL>-H=Help,_-=End

PROMPT_CHOICEMSG
String value used in dbvedit(1) and dbvemit(1) as the prompt displayed during a choice field screen. The default message/prompt is:
Enter_choice,_<CTL>-X=Abort:

PUTFILE
Accepted values are UNIX file names. This variable can be used to change the default name of the put index file.

RECORD_LEVEL
Accepted values are ON (default) and OFF. Toggles whether dbvedit(1) will use the full functioned record level mode, or the modeless blend of record level and autofield level. Note that if you turn this OFF, you may need to use the KEYPAD mappings to achieve a bit more record editing functionality.

RECLOG
Accepted values are ON and OFF (default). Controls the logging of records for use with dbdump(8) and dbrestor(8). If set to ON, databases can be recovered if a system failure occurs during a database update.

RECORD_UMASK
This variable is used in the Secure FirstBase system to mask the permission settings of a record as it is created. This setting is similar to the UNIX system call umask(2) -- it masks (clears) the corresponding bits in the file mode of created files. For general purpose in the multi-user environment, files are created in mode 0666, meaning the RECORD_UMASK defaults to 0.

For example, a setting of 022 could be used to mask off other users write access to FirstBase records.

REGEXP
Accepted values are ON and OFF (default). Toggles the use of regular expression searching in dbedit(1)/dbvedit(1). When regular expression searching is enabled, all index searches are sequential.

REVERSE
Accepted values are ON (default) and OFF. Controls the use of reverse video on FirstBase screens.

RUNFLAGS
Accepted values are standard UNIX switches, like "-y". Controls the arguments used by FirstBase tools from within dbshell(1). Default is empty.

SCREENPRINT
Accepted values are ON and OFF. Controls whether or not the printout style generators, dbpgen(1), dblgen(1) and dbmerge(1), will run their output files through the scrprint(1) tool before exiting. The default is ON.

SCREENPRINT_PAUSE
Accepted values are ON and OFF (default). Controls whether or not FirstBase tools will pause before using the scrprint(1) tool on generated results.

SCR_AUTOINCR
Accepted values are ON (default) and OFF. Toggles display of automatic increment screen in the FirstBase database editors, dbvedit and dbedit.

SCR_HEADER
Accepted values are ON (default) and OFF. Toggles display of screen header, line one of standard FirstBase screens.

SCR_HELP
Accepted values are ON (default) and OFF. Toggles display of screen help, line 24 of standard FirstBase screens. Note that some display messages will still appear on this line.

SCR_INFOLINE
Accepted values are ON (default) and OFF. Toggles display of the information line, line 23 of standard FirstBase screens. Note that some error messages will still appear on this line.

SCR_INFOLINE_SOLID
Accepted values are ON and OFF (default). Toggles use of a solid, reverse video line, instead of the normal information line, line 23 of standard FirstBase screens. Note that some error messages will still appear on this line.

SCR_INPUTCLEAR
Accepted values are ON (default) and OFF. Toggles the clearing of input fields prior to accepting input throughout the entire FirstBase system. This is a good one to turn OFF when RECORD_LEVEL is also OFF.

SCR_INPUTDOTS
Accepted values are ON (default) and OFF. Toggles the character used internally by FirstBase to represent the area on the screen where input is allowed. If turned OFF, then blanks are used.

SCR_INPUTPASTEDGE
Accepted values are ON (default) and OFF. Toggles whether FirstBase will allow one character to be typed past the edge of the input field. The default is ON. If turned OFF, FirstBase will stop at the input boundary and wait for a <RETURN>, even for one character fields. Works only when EDITINPUT is OFF.

SCR_LABEL
Accepted values are ON (default) and OFF. Toggles display of a screen label area, (line 2, left side) used by many of the FirstBase standard screens.

SCR_STAT2
Accepted values are ON (default) and OFF. Toggles display of a secondary screen status area (line 2, right side) used by many of the FirstBase standard screens.

SCR_STATUS
Accepted values are ON (default) and OFF. Toggles display of the primary screen status area (line 1, right side) used by the FirstBase standard screens.

SCR_STATUS_MASK
Accepted values are ON and OFF (default). Toggles use of the word "Status:" before the primary screen status area (line 1, right side) used by the FirstBase standard screens.

SCR_TOOLNAME
Accepted values are ON (default) and OFF. Toggles the entire tool name string (including "FirstBase" and its version number) in the upper left corner of the standard FirstBase screens. Also see SCR_VERSION_MASK.

SCR_VERSION_MASK
Accepted values are ON and OFF (default). Toggles use of the string "FirstBase X.Y.Z:" in the upper left corner of standard FirstBase screens, where X.Y.Z is the software release version.

SERVER
This environment variable controls the use of the FirstBase database server and the lock daemon server. It is used to point to the machine running the fbserver(8) and fblockd(8) processes.

SERVERERROR
This variable controls a file that is tied to the UNIX stream stderr during the running of fbserver(8). If not specified, the the file /usr/adm/fbserver.err is used.

SERVERLOG
This variable controls whether an activity log for fbserver command requests will be written, and where the file will be kept. Use a full path name, for example /usr/adm/fbserver.log. Again, if this FirstBase variable is not set, the activity log file will not be kept.

SHELL
Accepted values are full path names of shells. Controls the sub shell used by dbshell(1), /bin/sh is the default..

SHOWRECCNT
Accepted values are ON (default) and OFF. Controls whether an interactive FirstBase tool will display the record and index counters in the standard information (footer) line.

SIGNATURE
Accepted values are ON (default) and OFF. Controls the miniature FirstBase Software signature that appears when a FirstBase tool exits.

STANDOUT
Accepted values are ON (default) and OFF. Controls the use of standout video on FirstBase screens.

TEMPDIR
Accepted values are full path names of existing directories. This variable controls the location of any temporary files used by dbedit(1), dbvedit(1), and dbshell(1). The default directory is /tmp.

TRAP_XON
Accepted values are ON and OFF (default). Used to control whether the ioctl tty line flags will be set to trap, or turn off, the IXON and IXOFF bits. When set to OFF, high speed modems and some hardware (like HP) will behave properly during FirstBase sessions. However, setting to OFF has the side effect of disabling the ^S and ^Q keystrokes. When OFF, use ^/ and ^V for the same functions. (dbvedit).

UALARM
Numeric unsigned value (default 150000) determining the alarm time used in detecting function key keystrokes. Only when EDITINPUT is OFF.

UNIXTYPE
For help in determining the system type, some architectures require this variable to be set. Current uses are SCO and INTERACTIVE, two different flavors of Unix that work on 386/486 hardware. The default is empty.

UMASK
This variable is used in the UNIX system call umask(2) to mask (clear) the corresponding bits in the file mode of created files. For general purpose in the multi-user environment, files are created in mode 0666, meaning the UMASK defaults to 0.

Setting the UMASK can be done here to create global or application dependent masks. For example, a setting of 022 could be used to mask off other users write access to FirstBase data objects

Additionally, setting UMASK to -1 will cause FirstBase to use the individual users mask setting as inherited by each process.

USRLOG
Accepted values are integers ranging from 0 (default) to 10. Controls the tracking of individual users who use FirstBase. The integer value controls the amount of detail that will be logged. A value of 0 does no logs, a value of 1 logs each tool use by entrance and exit points, and a value of 2 additionally logs all arguments to all tools. The other levels are not currently used.

This setup variable can only be set in the global .firstbase-init file located in the FIRSTBASEHOME directory. It cannot be set (or unset) via an local startup files, nor command line options.

VIADDPAUSE
Accepted values are ON (default) and OFF. Controls whether or not dbedit(1) will pause before going into visual mode on a long field during new record entry only.

VIPAUSE
Accepted values are ON (default) and OFF. Controls whether or not dbedit(1) will pause before going into visual mode on a long field. However, pausing on new records is controlled by the VIADDPAUSE variable.

A special hook to the database editors "display visual field" function is provided from the VIPAUSE prompt. A d command at this point will display the field, without editing, and return to the VIPAUSE prompt.

VIPAUSE_MSG
String value used in dbvedit(1) as the prompt during the VIPAUSE question. The default is
Visual Edit Field `FieldName' Now? (y=yes, d=display, <other>=no):

WDIR_CCOMMAND
Controls the working directory of the CCOMMAND custom commands. The default is /tmp. All temporary data files and indexes for these commands will be stored in this directory.

WRAPSCAN
Accepted values are ON (default) and OFF. Controls whether or not dbedit(1) will wrap back to the top of an index on index searches when a request is not located.

WRITEDIR
Defines a writable directory used by FirstBase to store the SEQF, USRLOG, and other files as well. When undefined, WRITEDIR defaults to the directory pointed to by the UNIX environment variable FIRSTBASEHOME.

If this variable is defined, move the SEQF file from FIRSTBASEHOME, the installation directory, to WRITEDIR. Additionally, if using FirstBase floating licenses, move (or regenerate) the floating license file, .firstbase-flicense, into WRITEDIR.

FILES

.firstbase-init
the FirstBase initialization file for BSD machines.

.fb-init
the FirstBase initialization file for other machines.

SEE ALSO

firstbase(5), input(5), keyboard(5), terminals(5), setup(3)

FirstBase User's Guide and Reference Manual


URL: http://www.firstbasesoftware.com/man/man5/setup.htm
Last modified: 4 January 1996
Copyright © by FirstBase Software.
[ Index of Contents] [ FirstBase RDBMS Overview]