Print

Defaults.ssi

The default behaviour of many features of the software are defined in the file "SSI_ETC:defaults.ssi". This is a text file which can be edited with any text editor. Note that the file has a particular syntax which is outlined as below. An alternative method of modifying these settings during use of Surpac is using the SETTINGS function. This function provides a simple and efficient mechanism for changing the defaults and is the recommended method to use.

"SSI_ETC:" is a logical name (defined in the translate.ssi file) which is translated to the physical path name where the defaults.ssi file is located. If you have defined the environment variable PRODUCT_DEFAULTS (e.g. SURPAC2_DEFAULTS) as described in Description of Environment Variables in the installation chapters, the defaults file will be located and named as described by the environment variable setting. The file may be restored, if you experience difficulties after modifying it, by copying the master distribution version of it (defaults.mst).

The defaults.ssi file consists of a number of lines which take the form of 'name=value' where name is some specifier that the software understands and value is the value being assigned to the specifier to modify the behaviour of the software. Any line beginning with the `#' character is treated as a comment and is ignored.

# An extract from a defaults file
#
debug=off
warning=on
warning bell=1
error bell=2
grid colour=red
grid label size=0.02 sru
draw styles file=SSI_STYLES:styles.ssi
drill hole pattern file=SSI_STYLES:dholes.ssi
ref label=NORTHING
ref abbrev=N
non ref abbrev=E
non ref label=EASTING
z label=ELEVATION
z abbrev=Z
mass units=tonnes
distance units=METRIC
angle units=DEGREES
design grade units=P

Following is a description of all possible specifiers and values at the time of printing. For the most up to date descriptions of specifiers and legal values that they can be assigned look in the defaults.mst file which is distributed with every upgrade of the software.

alias(n)

Alias specifiers determine files which contain alias names for the standard software commands. You may specify up to nine alias files. Alias files are described later in this document.

Examples

alias1=SSI_ETC:surpac1.mst
alias2=/home/jones/my_commands.ssi

angle units

Angle units determines the system in which angles are measured. It may take the values DEGREES or GRADS.

Example

angle units=DEGREES

background colour

Background colour can be used to alter the background colour used in the graphics module. A window contrast clause can also be used to define the colour of the graphics viewport border. A text clause can be used to define the default colour to be used for drawing text.

Example

background colour=white,window contrast=black,text=black

See also rubberband colour.

blast.styles_file

This option defines the drawing styles file that will be used by the drill and Blast module to draw drill holes in the 3D Graphics module.

Example:

blast.styles_file=SSI_STYLES:blast.ssi

busy cursor

Busy cursor is used to define the style of cursor that will be displayed when the software is busy processing data. A large selection of cursor styles are available and are listed in the defaults.mst file. The default selection for the busy cursor is an hourglass. Please note that you may also specify any Windows cursor (.cur) file or animated cursor (.ani) file with this specifier.

Example

busy cursor=c:/winnt/system32/dinasaur.ani

See also pointer cursor, graphics cursor.

clash colour

Clash colour specifies the colour to use in Plot Preview for identifying plot clashes.

Example

clash colour=dark blue

cursor position

Defines the initial position for the cursor in an input field on a data entry form. Valid values are:

• start, the cursor will be at the start of the input field
• end, the cursor will be positioned after the last character of the input field

Example

cursor position=start

cursor mode

Defines the typing mode for the cursor. It can take the following values:

• insert, characters will be inserted at the cursor position with characters to right of the cursor being displaced to the right
• overtype, characters under the cursor will be replaced by the typed character

Example

cursor mode=overtype

database file locking

This option only has an effect if you are using functions which read and write database files using the "informix" database type. Furthermore this option only has an effect on workstation platforms which have an implementation of the INFORMIX Embedded SQL database interface.

Valid entries for this option are:

• on

Whenever insert, update or delete operations are executed on a table in the database an exclusive lock is used to prevent other users from accessing the table while changes are being made. Whenever read operations are executed on a table in the database a shared lock is applied. The shared lock permits other users to simultaneously read the table but prevents any attempts to insert, update or delete rows in the table. This strategy ensures the highest level of data integrity in a multi-user environment.

One drawback of this however is that INFORMIX will reject any attempt to apply an EXCLUSIVE LOCK to a VIEW. If the VIEW is in fact a single table view it is perfectly legal to perform inserts, updates and deletes and so you may need to use the "off" value for this option.

• off

No explicit locks are used when inserting, updating, deleting or reading rows from a table in the database. The database engine is expected to ensure data integrity so that access by multiple users does not cause data inconsistencies. Since explicit locks are not applied to tables it becomes possible to insert, update and delete through single table views.

The only potential drawback with this method is that it may be possible for one user to modify samples in a drill hole while another user is reading samples from a different part of the same drill hole.

debug

Debug is used to control the level of messaging that is reported by the software. It can only take the values on or off. Its recommended setting is off.

Example

debug=off

default plotter

Default plotter specifies your default plotter. It must be a plotter that is described in the SSI_PLOTTING:plotter.chr file.

Example

default plotter=HPDM2

design grade units

See grade units.

display

The display option determines the type of graphics display device you are using. If the environment variable PRODUCT_PICTURE (e.g. SURPAC2_PICTURE) is set, then it will override any setting of the display specifier. The default display settings are msw/window0 for MS Windows NT/95.

Normally you do not need to adjust these defaults settings unless you wish to use a special graphics adaptor such as an OpenGL device or you are using a remote display.

Examples

display=msw/window0
display=opengl/window0

display options

This specifier is only relevant to systems which run in a windows environment (e.g. Windows NT/95). Display options determines the size and position of the main application window and also the number of colours that may be consumed from the system colour map.

Example (entered on a single line)

display options=subscreen=(-.6,.6,-.6,.6),number of colors=128

distance units

Distance units determines units of measurement. It may take the values METRIC or IMPERIAL.

Example
distance units=METRIC

draw styles file

Draw styles file specifies the file containing default drawing styles to use in the graphics module.

Example
draw styles file=SSI_STYLES:styles.ssi

drill hole pattern file

Drill hole pattern file specifies the file containing definitions of drill hole patterns for the display of geology strings (created from the drill hole database section extract and display functions).

Example
drill hole pattern file=SSI_STYLES:dholes.ssi

error bell

Error bell determines how many bells to sound for error messages. It can take values in the range 0,1,2,3,..., 10

Example
error bell=2

error message colour

Colour of message prefix for error messages.

Example
error message colour=red

fatal message colour

Colour of message prefix for fatal messages.

Example
fatal message colour=red

file locking

File locking determines if file locking is to be used. It can take the values on or off.

Example
file locking=on

Note: You may experience problems using file locking if you are working on a heterogeneous network (i.e. SPARCstation & DEC stations)

file manager

File manager defines a file manager program to be invoked when the command file manager is invoked from within the software.

Example

file manager=xtgold

file_print_command

File_print_command defines the command that is used to print files through the software. A file name place holder, !AS can be used in the command. This place holder will be substituted for the actual file name at run time. If the file name is the last part of the command then the !AS place holder can be omitted.

Examples

file_print_command=command.com /c copy !AS com1: (Windows 95 printing to local port)
file_print_command=cmd.exe /c copy !AS com1: (Windows NT printing to local port)
file_print_command=cmd.exe /c copy !AS \\quokka\\hp1200c (Windows NT network printing)
file_print_command=notepad.exe /p (Windows NT/95 printing via notepad)
file_print_command=lpr -#1 -h -l !AS (SunOS)
file_print_command=lp -d hplj3 (HPUX)

See also file_view_command.

file_view_command

File_view_command defines the command/program that is used to view/display files through the software. A file name place holder, !AS can be used in the command. This place holder will be substituted for the actual file name at run time. If the file name is the last part of the command then the !AS place holder can be omitted.

Examples

file_view_command=notepad (Windows 95/NT)
file_view_command=jot (Irix)
file_view_command=textedit !AS & (Solaris)

See also file_print_command.

form_background

Background colour of a form.

form_foreground

The foreground colour of a form. Text on a form will be this colour

form_field_background

Background colour for a data field.

form_field_foreground

Foreground colour of a data field. Text in data fields will be this colour.

form_field_highlight

Background colour for the active data field.

form_heading_background

Background colour of the form header.

form_heading_foreground

Foreground colour of the form heading. The text in the form header will be this colour.

form_text_highlight

Some text on menus and forms is designed to stand out from the general text on forms and menus. Set the required colour for highlighted text with this user option.

function_text_size

Defines the size of the text in the dialog region where the Function prompt is displayed. This may need to be changed to allow for different size screens. On small screens the default size may be too small and difficult to read. The default setting for this parameter is:

function_text_size=name=roman,size=0.02 sru

grade units

Gradients used in the GRAPHICS module can use a value which is expressed as a percentage, a ''1 in x'' ratio, or as an angle. When using an angle, the angle must be expressed in the angle units defined by the `angle units' option. Valid entries are:

• PERCENTAGE, for percentage
• RATIO, for `1 in x' ratio or
• ANGLE, for angle.

Example

grade units=percentage

graphics cursor

Graphics cursor is used to define the style of cursor that will be displayed when the software is in a graphics select or digitise mode. A large selection of cursor styles are available and are listed in the defaults.mst file. The default selection for the graphics cursor is a crosshair. Please note that on MS Windows systems you may also specify any Windows cursor (.cur) file or animated cursor (.ani) file with this specifier.

Example

graphics cursor=uparrow

See also pointer cursor, busy cursor.

grid colour

Grid colour specifies the colour to draw grid lines in the graphics module.

Example

grid colour=red

grid label size

Grid label size determines the size of characters used in grid labels. It is specified as a percentage relative to the size of the graphics viewport. (e.g. 0.02 means 2% of the GRAPHICS viewport size)

Example

grid label size=0.02 sru

GUI window separate

This option was formerly used to indicate that the system will try to display forms in a separate window under X11 on UNIX workstations. This considerably reduced the amount of redrawing required.

Valid values for this option are:

• on, use external forms
• off, use internal forms

help message colour

Colour of message prefix for help messages.

Example

help message colour=blue

help_viewer_path

In order to have the software automatically start the Help Viewer when requesting help you need to modify the following option to reflect the correct pathname where netscape (or your designated html browser program) has been installed. This specifier is only used on Windows 95/NT systems.

Example

help_viewer_path=C:/Program Files/Netscape/Navigator/Program/netscape.exe

help_viewer_service_name

This specifier is only required if you want to use a different html browser program than the default netscape. This defines the Windows DDE service name that the html browser communicates on. Use this specifier with extreme caution.

The example below is the setting required if you choose to use the Internet Explorer software that ships with Windows.

Example

help_viewer_service_name=ixplorer

hidden surfaces

This option determines if hidden surfaces will be enabled or not in the 3D Graphics module when the software starts. Valid choices are:

• on
• off

Example:

hidden surfaces=off

hsr algorithm

This determines the type of hidden surface removal algorithm that the system will use. Valid choices are:

• painters, the default method
• software z-buffer, uses more memory but much faster
• hardware z-buffer, uses hardware if available otherwise reverts to `painters' - fastest method

Example

hsr algorithm=painters

keymaps

Keymaps specifies a file that contains definitions for keyboard mapping. The default should suffice at most installations.

Example

keymaps=SSI_ETC:keymaps.ssi

label specifiers

Label options specify text to appear as axis labels in graphics and reports. A full name and an abbreviation can be specified for the reference, non reference and Z axis. The actual label specifiers and their default values are:

• ref label=NORTHING
• ref abbrev=N
• non ref abbrev=E
• non ref label=EASTING
• z label=ELEVATION
• z abbrev=Z

language

The language parameter determines the language to display messages, forms, menus and other text output by the software. At present, languages supported are English (default), German (german), French (french) and Spanish (spanish). Use the name in brackets when specifying each language.

Examples

language=default

lines per page

This is the number of lines per page for printed reports. Typical values are 66 for imperial paper sizes and 70 for metric paper sizes.

log_file_action

Log_file_action describes what the system should do when it produces a log (.log) file. Possible values are none, view, or print. If none is set, then no further action will take place. If view is set, then the log file will be view/displayed by the program specified with the file_view_command specifier. If print is set, then the file will be printed using the command specified with the file_print_command specifier.

Example

log_file_action=view

See also log_file_macro_action, file_print_command, and file_view_command.

log_file_macro_action

Log_file_macro_action describes what the system should do when it produces a log (.log) file while running a macro. This is to allow you to have an alternative action to the one set with the log_file_action specifier. Possible values are none, view, or print. If none is set, then no further action will take place. If view is set, then the log file will be view/displayed by the program specified with the file_view_command specifier. If print is set, then the file will be printed using the command specified with the file_print_command specifier.

Example

log_file_macro_action=print

See also log_file_action, file_print_command, and file_view_command.

logging

Logging determines if system messages will be saved to a file. It can only take the values on or off. If logging is set to on then all system messages will be saved in the file specified by the logfile option.

Example

logging=off

logfile

Logfile names the file in which to store system messages. It can have any path and filename that is valid on your operating system as its value. This specifier is ignored if the logging specifier is set to off.

Example

logfile=ssi.log

logo timeout

This specifier determines how long in seconds to display the startup banner when you invoke the application.

Example

logo timeout=2

macro file confirm

Macro file confirm determines if the file overwrite confirm form is displayed when in macro playback mode. Values can be on or off.

Example

macro file confirm=off

macro logo timeout

This specifier determines how long in seconds to display the startup banner when running macros from the command line.

Example

macro logo timeout=0.5

mass units

Mass units is text that is used for report titles.

Example

mass units=tonnes

maximum undo operations

This option specifies the number of undo operations which are maintained for each layer in graphics.

A limit of zero means that no undo information is retained. A limit greater than zero is the number of operations which may be undone. A limit less than zero means that undo information is retained for all operations and can very rapidly use up all of the available memory and so is not recommended.

The default value is zero, i.e. no undo information is kept.

message_text_size

Defines the text size of the text in both the internal and external message windows. This may need to be changed to allow for different size screens. On small screens the default size may be too small and difficult to read. The default setting for this parameter is:

message_text_size=name=roman,size=0.02 sru

network_sentinel_timeout

This describes the timeout period after which a license which has been obtained from a network sentinel is considered idle and becomes a candidate for being revoked in the event a license request is made by another user and no more licenses are available.

The value of the timeout period is defined in minutes with any attempt to set the value less than 3 minutes resulting in a minimum value of 3 minutes being used. If the value is never defined in the defaults file then a default value of 10 minutes is used. Note that the network_sentinel_timeout option only works as documented if the network sentinel is invoked with the /h:(number of users) switch.

Example

network_sentinel_timeout=5

not_file_action

Not_file_action describes what the system should do when it produces a note (.not) file. Possible values are none, view, or print. If none is set, then no further action will take place. If view is set, then the note file will be view/displayed by the program specified with the file_view_command specifier. If print is set, then the file will be printed using the command specified with the file_print_command specifier.

Example

not_file_action=view

See also not_file_macro_action, file_print_command, and file_view_command.

not_file_macro_action

Not_file_macro_action describes what the system should do when it produces a note (.not) file while running a macro. This is to allow you to have an alternative action to the one set with the not_file_action specifier. Possible values are none, view, or print. If none is set, then no further action will take place. If view is set, then the note file will be view/displayed by the program specified with the file_view_command specifier. If print is set, then the file will be printed using the command specified with the file_print_command specifier.

Example

not_file_macro_action=print

See also not_file_action, file_print_command, and file_view_command.

os_log

This option is used by the EXECUTE OS COMMAND function to determine the method to be used for redirecting output from operating system commands for subsequent display in the message window. Currently, you are likely to use the Windows shell (command interpreter).

os_log=> os_log.ssi (Windows)

The redirected file must ALWAYS be called os_log.ssi as this file is used be the software to get the results of the operating system command.

Example

os_log=> os_log.ssi

os shell

This determines the program to run when the operating system command is invoked from within the software.

Example

os shell=command.com  (Windows 95)
os shell=cmd.exe  (Windows NT)

other command

Other command defines any program you would like be able to invoke from within the software by using the command other command.

Example

other command=c:\programs\netscape.exe

pattern file

Pattern file specifies the file containing pattern definitions for plotting.

Example pattern file=SSI_PLOTTING:patterns.ssi

plot command

Plot command specifies a default hardcopy plot command to use when generating local plot files. If you are running under Windows, then by specifying the keyword windows as the plot command you will be able to spool the plot file onto a windows print queue by selecting from a list of available printers at run time.

In the examples below the !AS is replaced with the name of the LF file currently being processed. Below are examples of this option for Windows.

Examples

plot command=windows (Windows NT/95)
plot command=command.com /c copy !AS com1: (Windows 95)
plot command=cmd.exe /c !AS lpt2: (Windows NT)

plot_editor

The program to use when you open a .dwf file in Surpac, or use Autoplot:

• surpac - the Surpac Plotting window
• draftsight - DraftSight.

You need to have DraftSight installed and to be licensed to use the DraftSight Connector module.

plotting.background_colour
plotting.rubberband_colour

In the same way that background colour and rubberband colour define the colours to use in Graphics, these two switches define the colours for plot preview. These are independant of Graphics colours, and can be set differently. Usually, this allows you to specify a black background in Graphics and a white background in Plot Preview.

Examples

plotting.background_colour=white,window contrast=black,text=black
plotting.rubberband_colour=red

plotting.pen_file

This switch specifies the pen file is used to determine the palette and the pen colours used in both plot preview and the plot drivers. This pen file can be edited with the PLOT EDIT PEN FILE function. The default is SSI_ETC:plotting.pen.

Example

plotting.pen_file=SSI_ETC:plotting.pen

plotting.thickness_adjustment

This switch only affects plot preview. This adjustment is used to modify the thickness of lines in plot preview. If you specify different widths for different pens, then this thickness adjustment can be used to make the difference more or less noticeable. It is impossible to have a standard value for this adjustment, because every different monitor resolution needs a different value, so this value can be tailored for your particular monitor setup.
Regular values are between 1.0 and 2.0. A value of zero will leave all lines at a uniform thickness.

Examples

plotting.thickness_adjustment=1.5

Default plotting presentation parameters

The following system options are used by the plotting module to determine the various plotting characteristics for the first time a map is processed.
The sheet, border, drawing_area, grid and title_block options define the sheet setup features that will be used from the sheets.ssi, borders.ssi, drwareas.ssi, grids,ssi and titles.ssi files respectively. The default values supplied will work with the sheet setup files installed with a new installation.
You may change these values to suit your requirements

plotting.sheet=A3

plotting.border=BORD

plotting.drawing_area=DRAW

plotting.grid=YXA3

plotting.title_block=NMA3

The following system options are used by the plotting module to determine how a map is to be processed. Each of these values, excluding plotting.advertisment, are displayed during the course of processing a map and can therefore be changed for each map.

plotting.orientation

Determines the default orientation for new maps valid choices and their meanings are:

• NC - Landscape orientation, north up the page and plot data centred on the plot sheet
• RC - Portrait orientation, north from right to left of the page and plot data centred on the plot sheet in this rotated orientation
• NF - Landscape orientation, north up the page and a coordinate entered for the lower left position of the plot sheet
• RF - Portrait orientation, north from right to left of the page and a coordinate entered for the lower left position of the plot sheet
• RD - Rotated through a specified angle about the centre of data and data centred on the sheet in its rotated orientation
• RX - Rotated through a specified angle about a specified coordinate value for the lower left corner of the plot sheet

plotting.data_units

The units of the data so that map scales can be interpreted appropriately.
M = Metric units where a scale value of 500 means 1:500
I = Imperial units where a scale value of 500 means 1 inch = 500 feet

plotting.text_rotation

This determines the default value for the input that controls whether text is to be rotated so that is readable from the bottom of the plotting sheet or not.
Y - rotate text, this generally gives best results
N - don't rotate text

plotting.advertisment

The advertisement that appears on the bottom of the plotting sheet. Up to 32 characters of text.

plotting.overprint

Determines the default value to be used for new maps to determine of priorities are to be ignored and thus permit overprinting of overlapping plot items ("Y") or if priorities are to be considered to prevent overprinting ("N") unless priorities of overlapping entities demands it.

plotting.quadrant

The quadrant defines the directions for the reference direction (North) and the non-reference direction (East). This makes it possible to comply with different mapping systems in use throughout the world.

• NE - used in most parts of the world where North (Y) is up the page and East (X) is to the right
• NW - used in South Africa where North (Y) is to the left of the page and East is Up the page
• SE - Probably not used anywhere in the world but it is included for completeness. North (Y) is to the right of the page and East (X) is down the page
• SW - Probably not used anywhere in the world but it is included for completeness. North (Y) is to down of the page and East (X) is to the right of the page

pointer cursor

Pointer cursor is used to define the style of cursor that will be displayed when the software is in normal input mode. A large selection of cursor styles are available and are listed in the defaults.mst file. The default selection for the pointer cursor is the left arrow. Please note that on MS Windows systems you may also specify any Windows cursor (.cur) file or animated cursor (.ani) file with this specifier.

Example

pointer cursor=pointing_hand

See also graphics cursor, busy cursor.

progress_bar1_colour

This defines the colour to be used for the first progress feedback bar. There may be more than one feedback bar displayed at any one time. The colours for the second and subsequent feedback bars may be defined by 'progress_bar2_colour', 'progress_bar3_colour', etc. Contrasting colours should be used for alternating feedback bars. For example:

progress_bar1_colour=blue
progress_bar2_colour=red
progress_bar3_colour=red

report_format

Specify the default output format. Valid options are:

• .csv - Comma Seperated Values
• .not - Simple Text Note File
• .html - Hyper Text Markup Language (web browser)
• .rtf - Rich Text Format (MS Word)
• .pdf - Portable Document File (Adobe Acrobat)
• .ps - PostScript

Example:

report_format=.csv

report_pdf_compress

Set if PDF files compress(ZIP) image data. Only compatible with Adobe Acrobat reader V3.0 and above. Valid options are:

• true - compress data. Recommended
• false - dont compress data. creates large files

Example:

report_pdf_compress=true

report_table_style

Set default table style. Valid options are:

• tbstyle0 - Classic4
• tbstyle1 - Professional
• tbstyle2 - NoLinesSeparator
• tbstyle3 - Subtle1
• tbstyle4 - Grid6
• tbstyle5 - LedgerHeader

Example:

report_table_style=tbstyle1

report_group_style

Set table grouping style. Valid options are:

• gpstyle0 - Leading break, bold and underlined summary and headers
• gpstyle1 - Trailing break, bold and underlined summary and headers
• gpstyle2 - Drop table, summary cells are in dropped down cells
• gpstyle3 - Summary and header cells are shown in shadow border

Example:

report_group_style=gpstyle0

Report writer font specifications:

The following report writer fonts are defined using a three part font name with each part separated from other parts of the name using a hyphen character. Thus a name like Times New Roman-bold-12 is constructed. The font specifications consist of, font name-style-size.

Valid choices are constructed from these values:

• Font names - serif, sans serif or Times New Roman
• Style - plain, bold, italic or bolditalic
• Size - 0...100

report_font_table

Font used on data within a table.

Example:

report_font_table=sansserif-plain-8

report_font_table_bold

Font used on bold data within a table.

Example:

report_font_table_bold=sansserif-bold-8

report_font_plain

Plain normal text font definition

Example:

report_font_plain=sansserif-plain-12

report_font_bold

Bold normal text font definition

Example:

report_font_bold=sansserif-bold-12

report_font_italic

Italic normal text font definition

Example:

report_font_italic=sansserif-italic-12

report_font_bolditalic

BoldItalic normal text font definition

Example:

report_font_bolditalic=sansserif-bolditalic-12

report_font_heading0

Largest heading font

Example:

report_font_heading0=sanserif-bold-20

report_font_heading1

Larger middle heading font

Example:

report_font_heading1=sanserif-bold-18

report_font_heading2

Middle heading font

Example:

report_font_heading2=sanserif-bold-16

report_font_heading3

Smallest heading font

Example:

report_font_heading3=sanserif-bold-14

report_font_header_footer

Header and footer font

Example:

report_font_header_footer=sansserif-plain-8

report_zoom_percentage

The percentage to use to determine the magnification for the previewer window. Permitted values are 10, 25, 50, 75, 100, 150, 200 and 500. A value of 100 gives normal size. Smaller values reduce the size of the preview report and larget values increase the size.

Example:

report_zoom_percentage=150

report hoops errors

HOOPS is the graphics subsystem of Software Product and other associated products. Under certain conditions the error message "Error in GRAPHICS subsystem" may be displayed. This indicates that the HOOPS GRAPHICS subsystem has encountered a problem. Further diagnostic information as to the cause of the error may be obtained by setting the "report hoops errors" option to the value "on".

Valid values for this option are:

• off

HOOPS errors are reported with the generic error message "Error in Graphics subsystem"

• on

A more detailed error message generated by the HOOPS software is displayed.

report

Report determines where system messages will be displayed.

Valid entries are:

• external, use external message window
• internal, use internal message window
• stderr, don't use message window at all, use standard error

Example

report=internal

rubberband colour

Rubberband colour is used to define the colour of the rubber band used in the graphics module.

Example

rubberband colour=black

save all macro fields

When recording a macro you can elect to save all fields displayed on a form or just the ones whose default value has been changed. Valid settings for this specifier are:

• on, save all fields on the form
• off, save only fields whose value is altered from the default value

Example

save all macro fields=on

scale factor

This determines the point scale factor used by the surveying functions to adjust distances measured so that they are on the plane determined by the map projection being used and to adjust calculated distances so that they are on the spheroid.

Functions which divide calculated distances by the scale factor to adjust from the plane to the spheroid are: Setout Notes, Grade Line Setout, Chain and Offset Setout.

Functions which multiply measured distances by the scale factor to adjust from the spheroid to the plane are: Surface Traverse, Underground Traverse, EDM Survey, Generating Distance Stadia Survey, RDS Survey, Two-Wires Stadia Survey, Chain & Offset Survey, Profile Survey, Radiation Survey, and all data recorders.

A scale factor of 1.0 will have the effect of using no scale factor at all.

For small operations, using a mean scale factor for the area in which surveys are performed is acceptable. For large operations, you may need to enter a different scale factor for each survey. Use the Scale Factor function to alter the scale factor at any time.

scl_debug_host

This permits you to define the name of the machine on which TclPro Debugger is running. TclPro Debugger defaults to host name localhost.

Example:

scl_debug_host=localhost

scl_debug_port

This permits you to define the TCP port that TclPro Debugger uses to communicate with the application. TclPro Debugger defaults to port 2576.

Example:

scl_debug_port=2576

scl_prodebug_file

This permits you to define the platform-specific prodebug.tcl script required by the TclPro Debugger for remote debugging. Remote debugging is required for debugging scl extensions in Surpac's embedded TCL interpreter.

Example:

scl_prodebug_file=c:/Program Files/TclPro1.2/win32-ix86/bin/prodebug.tcl

scl_library_path

This permits you to define the path that Surpac's embedded TCL interpreter searches for package libraries.

Example

scl_library_path=SSI_LIB:;

status text size

Defines the size of the text in the status region where the current working directory and other information are displayed. This may need to be changed to allow for different size screens. On small screens the default size may be too small and difficult to read. The default setting for this parameter is:

status_text_size=name=roman,size=0.014 sru

string file format

This option defines the default format for the content of string and DTM files that is to be used when data are saved to these files by the software. Valid choices are:

• text = the files are human readable text
• binary = the files are binary format to conserve disk space

Example:

string file format=text

stringfile_format.fil

The number of characters in a string file name. The maximum allowable is 256.

Example:

stringfile_format.fil=60

stringfile_format.loc

The maximum number of characters in a file location. This value cannot exceed 252.

Example:

stringfile_format.loc=40

stringfile_format.id

The maximum number of digits in a file ID number. The maximum is 32.

Example:

stringfile_format.id=16

stringfile_format.fmt

The type of formatting for the file ID numbers. Valid choices are:

• 0 = round the ID number to one decimal place and truncate any high order digits to get length defined in the ID specifier
• 1 = format the ID according to the WID and DEC specifiers and remove leading spaces
• 2 = format the ID according to the WID and DEC specifiers and use a fixed length number with leading zeros.

Example:

stringfile_format.fmt=0

stringfile_format.wid

The total width of the formatted number.

Example:

stringfile_format.wid=5

stringfile_format.dec

The number of decimal places in the number.

Example:

stringfile_format.dec=0

stringfile_format.ochr

Character substitution parameters. These are generally used to ensure filenames only have a single "." in them as some systems have trouble with filenames which have more than one ".". The OCHR specifier defines the character which is to be replaced if it is found in a string filename and NCHR= defines the character which is to replace it. Typical values are OCHR=. and NCHR=_

Example:

stringfile_format.ochr=.

stringfile_format.nchr

Character substitution parameters. These are generally used to ensure filenames only have a single "." in them as some systems have trouble with filenames which have more than one ".". The OCHR specifier defines the character which is to be replaced if it is found in a string filename and NCHR= defines the character which is to replace it. Typical values are OCHR=. and NCHR=_

Example:

stringfile_format.nchr=_

stringfile_format.delim

The delimiter used at the end of a logical name.

Example:

stringfile_format.delim=:

text alignment

The text alignment specifier allows you to define the alignment of the text relative to the point of interest. Valid alignment specifiers are:

Example

text alignment=^

text editor

Text editor defines a text editor program to be invoked when the command text editor is invoked from within the software.

Example

text editor=ne

text font

Text font is used to alter the font of text used for drawing text in graphics.

Text fonts which should be valid on all platforms are:

• roman
• sans serif
• typewriter
• stroked
• system default
• Newfield
• Enfield
• Brooktondale

Example

text font=roman

text size

Text size is used to alter the size of text used for drawing text in graphics. It takes the generic form:

text size=sizespec units

where sizespec is a numeric value whose units are governed by the value of units. Valid values for units are:

• oru, object relative units i.e. sizespec is a real world values
• sru, screen relative units i.e. sizespec is a fraction of the screen height
• points, point size e.g. 10, 12, etc.
• pixels, the number of pixels high for the font

`oru' and `sru' are the most useful units for the size specifier.

Example

text size=0.02 sru

text slant

The text slant option enables you to have italicised text. Valid values for the slant value may by between -75 and 75.

Example

text slant=10

text path

The text path describes a vector which is used to describe the path along which the text is drawn.

The vector consists of three numbers which describe the X, Y and Z components of a direction vector:

• 1 0 0 = horizontal
• 0 1 0 = vertical while other values will produce different effects.

If this value is left blank then the text will be horizontal.

Example

text path=1 0 0   

triangulate stitch algorithm

To speed up processing on all platforms (and windows in particular) a new algorithm has been implemented which gives an exact result always (provided the input data allows a valid stitchup triangulation) and runs considerably faster than the old algorithm for most inputs.

Since the new algorithm is still considered experimental users have the option to revert to the old algorithm via the user option "triangulate stitch algorithm". If this is set to the value zero (0) then the old algorithm is used, if this is set to the value one (1) then the new algorithm is used.

Two additional options have been added in Version 3.1 to help prevent the creation of twisted or self-intersecting trisolations. These new options use the old and new algorithms but have an additional step which transforms the segments so they are parallel and have aligned centroids before performing the stitching and then removing the transform. If the "triangulate stitch algorithm" is set to the value two (2) then the old algorithm with transforms will be used, if it is set to three (3) then the new algorithm with transforms will be used.

Valid choices are therefore

• 0 = use the old algorithm
• 1 = use the new algorithm
• 2 = use the old algorithm with transforms
• 3 = use the new algorithm with transforms

The default is to use option 3. The use of the transform algorithms will be beneficial for the 3DM creation functions, TRIANGULATE AUTOMATIC, TRIANGULATE MANY SEGMENTS, TRIANGULATE CENTRE LINE AND PROFILE, BIFURCATION ONE TO MANY and BIFURCATION UNION. At some stage in the future the ability to revert to the old algorithm will be removed and only the new algorithm will be available.

triangulate stitch exact size limit

If "triangulate stitch algorithm" is non-zero this option sets an upper limit on the amount of memory which will be used by the algorithm. If this limit would be exceeded then the algorithm is modified slightly so that it uses less memory at the expense of a longer processing time.

The default value of 10000000 (10 Mbyte) allows quick triangulation between segments of up to 1500 points each with slower triangulation for larger problems. Triangulation between segments with 300 points each only uses 350000 (350 kbyte). You may set this parameter to a higher or lower value as appropriate for the maximum amount of memory available, although the default value should be adequate for most users.

Example:

triangulate stitch exact size limit=10000000

undo purge on recall file

Valid values for this option are `on' or `off'. The default value is 'on'.

When this option is set to `on' all undo information, except for the data which exists immediately prior to the Recall File function is used, is destroyed whenever a file is recalled into the current graphics layer. This prevents excessive amounts of memory being used to maintain older undo versions.

When the option is set to `off' all previous undo information is retained.

use_software_frame_buffer

Determines if the HOOPS technology=software frame buffer setting is used to enhance graphics performance by buffering output. The software frame buffer is only used for 3D graphics as the memory cost does not outweigh the benefits for other graphics applications.

Permitted values are "Y" to enable and "N" to disable.

Example:

use_software_frame_buffer=Y

User_logicals

User_logicals allows you to specify a file of logical to physical path translations to the software. The file specified here will be loaded after both the translat.ssi and SSI_ETC:logicals.ssi files. You may want to use this specifier to cater for operating systems specifics in physical path names.

See also translate.ssi, logicals.ssi.

viewer axes length

The axes length parameter determines the basic length of the viewer axis arms (before applying any scale factors) with 1.0 indicating arms with lengths about half the screen height.

The default value is 0.1.

viewer axes line colour

The colour to use for the viewer axes arms.

The default value is light blue.

viewer axes text colour

The colour to use for the viewer axes X, Y, and Z labels.

The default value is grey.

viewer axes text font

This parameter determines the font used to display the viewer axes X, Y, and Z labels.

The default value is `name=sans serif, size=0.02 sru'

viewer exponential angle base

This only has an effect on the Animated Constrained Rotate and Animated Rotate viewing functions.

To enable precision selection of rotation speeds the angular speeds are interpreted using an exponential function of the mouse displacement. These quantities select the base and the exponent multiplier for use in this mapping function. The default quantities should be fine for most applications.

The default value is 15.0.

The following formula is used to determine the angle through which the view is to be rotated.

rotation angle = (sign of displacement) * ((base ^ (mult * d))

Where:

displacement = the distance the mouse has moved

base = value of `viewer exponential angle base'

mult = value of `viewer exponential angle multiplier'

Changing (base) and (mult) values gives the following effects:

• as (base) increases the rotation angle tends to increase at an exponential rate when compared to the mouse displacement. Increasing (base) will make the rotation angle to become even more sensitive to mouse movement to the point where it may be difficult to achieve an acceptable result due to the increased sensitivity.
• as (mult) increases (by a factor of 2 for example) the effect is as if the mouse movement is changed in a linear fashion (by a factor of 2 for example). The result is that the same rotation angle can be achieved with less mouse movement.

viewer exponential angle multiplier

This only has an effect on the Animated Constrained Rotate and Animated Rotate viewing functions.

See viewer exponential angle base above for details of this option.

The default value is 2.5.

viewer mouse status left

The low level hardware reports the status of the mouse buttons as they are pressed and encodes the values as an integer. These fields allow you to modify the values which represent the left and right mouse buttons and any other value is taken to mean the middle mouse button. This means that on a two button mouse the middle button can be simulated by holding both mouse buttons down together. This would not normally be changed unless you are using some strange hardware which does not report the normal status values. In order to determine the status values reported by the mouse use the Viewer Test function.

The default value is 1.

viewer mouse status right

See viewer mouse status left for a description of this option.

The default value is 2.

viewer animation period

When using the animated modes this parameter determines the minimum time between frames. If frame updates take longer they will complete before a new frame is generated.

The default value is 0.2 seconds.

view active colour

The colour to use for the title bar and viewbar icon for the currently active viewport.

Example
view active colour=light blue

view inactive colour

The colour to use for the title bar and viewbar icon for any inactive viewports (i.e. all but the active viewport).

Example
view inactive colour=dark silver

view open title colour

The colour to use for the view name in the title bar and viewbar icon for open views.

Example
view open title colour=white

view closed title colour

The colour to use for the view name in the viewbar icon for closed views.

Example
view closed title colour=black

view icon colour

The colour to use for the icons in the view title bar.

Example
view icon colour=black

view resize icon colour

The colour to use the resize icons at the corners of the view.

Example
view resize icon colour=black

view background colour

The colour to use for any part of the graphics region which is not covered by an open view and also for the background of the viewbar.

Example
view background colour=silver

view default mode

The viewer mode to use as the default when the initial graphics viewport is created. It can take the following values:

• constrained dolly
• constrained rotate
• constrained scale
• orbit dolly zoom
• rotate
• dolly
• pan
• none

Example
view default mode=rotate

warning

Warning is used to control the level of messaging that is reported by the software. It can only take the values on or off. Its recommended setting is on.

Example
warning=on

warning bell

Warning bell determines how many bells to sound for warning messages. It can take values in the range 0,1,2,3,...

Example
warning bell=1

warning message colour

Colour of message prefix for warning messages.

Example

warning message colour=orange

window_in_method

Two different methods of defining the region of interest are available. The method employed is determined by this option. The methods available are:

• centre to corner

This permits you to define the centre of the region of interest and then size the box by moving away from the centre of the region.

• corner to corner

This permits you to define a corner (lower left or upper right) and then position the box by defining the opposing corner.

In either case, you must position the pointer depending on the method in use and then drag the pointer to define the area to be enlarged.

Example

window_in_method=centre to corner

world quadrant

This option is used by the GRAPHICS module to determine the direction to be used i.e. up, down, left or right for the reference direction.

Valid values are:

• NE,reference direction is UP and non-reference direction is to the RIGHT
• NW,reference direction is to the LEFT and non-reference direction is UP
• SE,reference direction is to the RIGHT and non-reference direction is DOWN
• SW, reference direction is DOWN and non-reference direction is to the LEFT

Example

world quadrant=NE

Using Logical constructs in the defaults file

An advanced feature available for use in the defaults file is the use of conditional constructs. This feature was useful if you had to support the software on a number of different operating systems and wish to maintain only one copy of the defaults file. You may find other uses for this feature.

The conditional constructs instruct the defaults file loader to include or exclude sections of the file based upon symbol definitions. The condition constructs available are:

The values for symbol differ over operating systems. The possible values are:

For MS Windows NT on Intel - WINDOWS_NT, WIN32, NT_I386
For MS Windows 95 on Intel - WINDOWS_95, WIN32, NT_I386

An possible example usage to set the system dependant specifiers display and os_shell could be: