home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 6 File
/
06-File.zip
/
os2-tree.zip
/
OS2TDEF.DOC
< prev
next >
Wrap
Text File
|
1993-11-19
|
94KB
|
1,605 lines
The OS2TREE Profile
The operation of OS2TREE is regulated by the OS2TREE profile,
OS2TREE.PRO. This file must be in one of the directories in your
DPATH. OS2TREE's operation can be modified by changing
the profile. OS2TREE commands are changed in the OS2TREE definition
file, which is then compiled by the program OS2TPRO.EXE. Simply run
OS2TPRO.EXE with no parameters and the file OS2TREE.DEF will be
compiled to the file OS2TREE.PRO, which can then be copied to an
appropriate directory.
The definitions file, OS2TREE.DEF, contains a list of key definitions.
Each key definition specifies the commands to be executed when that
key is pressed. Undefined keys cause a beep to be issued, and are
otherwise ignored.
A key definition has the following form:
<key> : <command list> ;
where <key> is a key specifier, one of the following:
'c', where c is any character. Specifies character c.
A decimal number. the number is the ASCII value for the key to
be set. E.g., 79 corresponds to 'O'.
A hexidecimal number, preceded with '0x'. Same as above. E.g.,
0x4f corresponds to 'O'.
A pre-defined key identifier, listed in appendix A. E.g., A_O
corresponds to alt-O.
startup - this is a special name that doesn't correspond to any
key. The commands given for this name are executed when OS2TREE
starts, before user input is accepted.
Case is ignored when processing the OS2TREE.DEF file, except for quoted
character constants and quoted strings (below). By default, all input
to OS2TREE is automatically forced to upper-case, so it is only possible
to give definitions for upper-case keys. Definitions for lower-case keys
will NOT be flagged as errors, but will have no effect when OS2TREE is
run. You can, if you wish, allow mixed-case key processing by changing
the variable 'upcase', as is explained below. If you do so, a definition
for an upper-case key will not be executed when the lower-case key is
pressed. Different commands may be specified for upper- and lower-case
versions of the same key.
Key definitions may run over several lines; a newline is treated exactly
the same as a blank character.
A # begins a comment; all characters from the # to the end of line are
ignored.
OS2TREE Expressions
An EXPRESSION is one of:
A numeric constant. Exactly the same as a key specifier. Only
integer constants and expressions are supported.
An arithmetic expression. The arithmetic operators are:
+, -, *, /
Plus, minus, times, divide.
==, <, >, <=, >=, !=
Equal, less than, greater than, greater equal, less
equal, not equal. These evaluate as 1 if true, 0
if false.
Operators are evaluated sequentially with no precedence. For example,
the expression "3+4*5" is evaluated as "(3+4) * 5". Parentheses may
be used to change the order of evaluation.
If an operand to an arithmetic operator is a string, it is first
evaluated to an integer. There is no error checking on this
conversion; if the string contains non-numeric characters, but begins
with a digit, the numeric prefix is converted. If it does not
start with a digit, the string is evaluated as 0. E.g., the string
"23skidoo" would evaluate as 23, and the string "not a number"
would evaluate as 0.
WARNING: Due to the way that negative numbers are interpreted, a
minus operator must be followed by a space or parenthesis if the
following operand is a number. E.g., the following are interpreted
as you would expect:
5-a 3-(2+4)
However, the expression
5-3
is interpreted as: 5 followed by -3 (no minus operator seen)
This can be properly represented in the
following ways: 5- 3 or 5 - 3 or 5-(3)
An OS2TREE variable. This may be one of the pre-defined OS2TREE
variables, listed in appendix B, or a temporary variable, which
is created by an assignment statement. See "OS2TREE Commands", below.
Temporary variables may take either string or numeric values.
Pre-defined variables are defined as string or numeric, but
if they are assigned or used in an expression as the wrong type,
a conversion is automatically made.
A variable name consists of an arbitrarily-long sequence of
alpha-numeric or underscore characters not beginning with a
digit. If an acceptable variable name is detected that is not
already known as a pre-defined or temporary variable name, and
is not the target of an assignment statement, it is treated as
a string constant.
A string constant. Any sequence of characters surrounded by
double-quotes ("). If you want to use a " or \ character, it
must be preceded by a \.
A string expression. The concatenation operator, |, between
2 string operands. An operand can be a string constant, variable or
another string expression. If an arithmetic expression is used as
an operand, it is evaluated and converted to a string. E.g., in
the expression
"xyz" | 14 + 5
14 is added to 5, the result, 19, is converted to the string "19"
and concatenated with "xyz" to yield the result "xyz19".
OS2TREE Commands
An OS2TREE command list consists of a comma-separated list of OS2TREE
commands.
Possible commands are:
An assignment statement. This has the form:
<variable> = <expression>
Pre-defined OS2TREE variables are listed in appendix B. If a variable
name is given that is not pre-defined, a temporary variable is
created.
An OS2TREE command. The command name is given, followed by any
parameters. Parameters may be string or numeric expressions.
OS2TREE commands are listed in appendix C.
An executable program. The character '@' indicates that a program
is to be executed. The program name, followed by any parameters,
follows the @. The name and parameters are string expressions. An
arithmetic expression can be used as a parameter; it will be
converted to a string.
Example:
@"lockup" "/B"
will run the lockup program with parameter "/B". Note that the
quotes are not necessary, however, they are recommended since
if they are left off and a temporary variable named lockup is
created, a variable substitution will take place before
executing. E.g.,
lockup = 43
@lockup /B
will cause a substitution of "43" for "lockup", and the system
will attempt to run a program called 43. Also note that the
program name must be a distinct string from its arguments.
The line
@"lockup /B"
will cause the system to search for an executable file named
"lockup /B".
A command to be executed by the OS/2 command processor. The
syntax is the same as for programs, except ! is used instead of @.
This form must be used for CMD files and for commands such
as DIR which are built into the command processor. '!' can also be
used to execute EXE files, but it is less efficient and uses more
overhead (for the command processor) than '@'.
An IF statement. This has the form
IF <arithmetic-expression> then <command list> ;
or
IF <arithmetic-expression> THEN <command list> ;
ELSE <command list> ;
The arithmetic expression is evaluated; if the result is non-zero,
the THEN clause is executed, otherwise the ELSE clause (if any) is
executed.
Example:
if i<j then
max = j,
say "MAX=" | max ;
else
max = i ;
A WHILE statement. This has the form
WHILE <arithmetic-expression> DO <command list> ;
The arithmetic expression is evaluated; if the result is non-zero,
the DO clause is executed, then the expression is again evaluated.
As long as the expression is non-zero, the loop continues to be
executed.
EXAMPLE:
'Y' : i=1,
while i < 5 do
i = i+1,
if flag == 0 then sum = sum+i;
else
sum = sum-i,
@prog
; # end if
; # end while
; # end key def
APPENDIX A: Key Names
The following is a list of allowable KEY DEFINITIONS for OS2TREE.DEF:
ALT-KEY + A = A_A
ALT-KEY + B = A_B
ALT-KEY + C = A_C
ALT-KEY + D = A_D
ALT-KEY + E = A_E
ALT-KEY + F = A_F
ALT-KEY + G = A_G
ALT-KEY + H = A_H
ALT-KEY + I = A_I
ALT-KEY + J = A_J
ALT-KEY + K = A_K
ALT-KEY + L = A_L
ALT-KEY + M = A_M
ALT-KEY + N = A_N
ALT-KEY + O = A_O
ALT-KEY + P = A_P
ALT-KEY + Q = A_Q
ALT-KEY + R = A_R
ALT-KEY + S = A_S
ALT-KEY + T = A_T
ALT-KEY + U = A_U
ALT-KEY + V = A_V
ALT-KEY + W = A_W
ALT-KEY + X = A_X
ALT-KEY + Y = A_Y
ALT-KEY + Z = A_Z
ALT-KEY + 1 = A_1
ALT-KEY + 2 = A_2
ALT-KEY + 3 = A_3
ALT-KEY + 4 = A_4
ALT-KEY + 5 = A_5
ALT-KEY + 6 = A_6
ALT-KEY + 7 = A_7
ALT-KEY + 8 = A_8
ALT-KEY + 9 = A_9
ALT-KEY + 0 = A_0
ALT-KEY + ~ = A_TILDE
ALT-KEY + - = A_HYPHEN
ALT-KEY + = = A_EQ
ALT-KEY + \ = A_BSL
ALT-KEY + Back-space = A_BS
ALT-KEY + , = A_COMMA
ALT-KEY + . = A_DOT
ALT-KEY + / = A_SL
ALT-KEY + UP = A_UP
ALT-KEY + LEFT = A_LEFT
ALT-KEY + DOWN = A_DOWN
ALT-KEY + RIGHT = A_RIGHT
ALT-KEY + INS = A_INS
ALT-KEY + HOME = A_HOME
ALT-KEY + PAGE_UP = A_PAGE_UP
ALT-KEY + DEL = A_DEL
ALT-KEY + END = A_END
ALT-KEY + PAGE_DOWN = A_PAGE_DOWN
ALT-KEY + TAB = A_TAB
ALT-KEY + F1 = A_F1
ALT-KEY + F2 = A_F2
ALT-KEY + F3 = A_F3
ALT-KEY + F4 = A_F4
ALT-KEY + F5 = A_F5
ALT-KEY + F6 = A_F6
ALT-KEY + F7 = A_F7
ALT-KEY + F8 = A_F8
ALT-KEY + F9 = A_F9
ALT-KEY + F10 = A_F10
ALT-KEY + F11 = A_F11
ALT-KEY + F12 = A_F12
CNTL-KEY + A = C_A
CNTL-KEY + B = C_B
CNTL-KEY + C = C_C
CNTL-KEY + D = C_D
CNTL-KEY + E = C_E
CNTL-KEY + F = C_F
CNTL-KEY + G = C_G
CNTL-KEY + H = C_H
CNTL-KEY + I = C_I
CNTL-KEY + J = C_J
CNTL-KEY + K = C_K
CNTL-KEY + L = C_L
CNTL-KEY + M = C_M
CNTL-KEY + N = C_N
CNTL-KEY + O = C_O
CNTL-KEY + P = C_P
CNTL-KEY + Q = C_Q
CNTL-KEY + R = C_R
CNTL-KEY + S = C_S
CNTL-KEY + T = C_T
CNTL-KEY + U = C_U
CNTL-KEY + V = C_V
CNTL-KEY + W = C_W
CNTL-KEY + X = C_X
CNTL-KEY + Y = C_Y
CNTL-KEY + Z = C_Z
FUNCTION-KEY 1 = F1
FUNCTION-KEY 2 = F2
FUNCTION-KEY 3 = F3
FUNCTION-KEY 4 = F4
FUNCTION-KEY 5 = F5
FUNCTION-KEY 6 = F6
FUNCTION-KEY 7 = F7
FUNCTION-KEY 8 = F8
FUNCTION-KEY 9 = F9
FUNCTION-KEY 10 = F10
FUNCTION-KEY 11 = F11
FUNCTION-KEY 12 = F12
SPACE = " "
INSERT = INS
HOME = HOME
PAGE_UP = PAGE_UP
DELETE = DEL
END = END
PAGE_DOWN = PAGE_DOWN
UP = UP
LEFT = LEFT
DOWN = DOWN
RIGHT RIGHT
CNTL-KEY + F1 = C_F1
CNTL-KEY + F2 = C_F2
CNTL-KEY + F3 = C_F3
CNTL-KEY + F4 = C_F4
CNTL-KEY + F5 = C_F5
CNTL-KEY + F6 = C_F6
CNTL-KEY + F7 = C_F7
CNTL-KEY + F8 = C_F8
CNTL-KEY + F9 = C_F9
CNTL-KEY + F10 = C_F10
CNTL-KEY + F11 = C_F11
CNTL-KEY + F12 = C_F12
CNTL-KEY + TAB = C_TAB
SHIFT-KEY + F1 = S_F1
SHIFT-KEY + F2 = S_F2
SHIFT-KEY + F3 = S_F3
SHIFT-KEY + F4 = S_F4
SHIFT-KEY + F5 = S_F5
SHIFT-KEY + F6 = S_F6
SHIFT-KEY + F7 = S_F7
SHIFT-KEY + F8 = S_F8
SHIFT-KEY + F9 = S_F9
SHIFT-KEY + F10 = S_F10
SHIFT-KEY + F11 = S_F11
SHIFT-KEY + F12 = S_F12
SHIFT-KEY + TAB = S_TAB
BACK_TAB = BACK_TAB
CNTL-KEY + 2 = C_2
CNTL-KEY + 6 = C_6
CNTL-KEY + - = C_HYPHEN
CNTL-KEY + \ = C_BSL
CNTL-KEY + Back-space = C_BS
CNTL-KEY + INS = C_INS
CNTL-KEY + HOME = C_HOME
CNTL-KEY + PAGE_UP = C_PAGE_UP
CNTL-KEY + DEL = C_DEL
CNTL-KEY + END = C_END
CNTL-KEY + PAGE_DOWN = C_PAGE_DOWN
CNTL-KEY + UP = C_UP
CNTL-KEY + LEFT = C_LEFT
CNTL-KEY + DOWN = C_DOWN
CNTL-KEY + RIGHT = C_RIGHT
PAD 5 = PAD_5
CNTL-KEY + PAD 5 = C_PAD_5
CNTL-KEY + PAD / = C_PAD_SL
CNTL-KEY + PAD * = C_PAD_STAR
CNTL-KEY + PAD - = C_PAD_HYPHEN
CNTL-KEY + PAD + = C_PAD_PLUS
CNTL-KEY + PAD ENTER = C_PAD_ENTER
ALT-KEY + PAD / = A_PAD_SL
ALT-KEY + PAD * = A_PAD_STAR
ALT-KEY + PAD - = A_PAD_HYPHEN
ALT-KEY + PAD + = A_PAD_PLUS
ALT-KEY + PAD ENTER = A_PAD_ENTER
ESC = ESC
TAB = TAB
ENTER = ENTER
BACKSPACE = BACKSPACE
SPACE = SPACE
BLANK = BLANK
CARRIAGE RETURN = CR
LINE FEED = LF
APPENDIX B: OS2TREE variables
The following is a list of pre-defined OS2TREE variables:
Integer Variables
_________________
archive_enabled : OS2TREE list selection flag for archive files.
auto_backup_flag : Enable Automatic Backup Thread to function
when backup_str equals current time.
auto_backup_edit_flag : Automatically sets an editted file for backup!
auto_backup_clear_flag : Automatically clears backup queue after each !
backup.
auto_execute_flag : Enable Automatic Execution Thread to function
when auto_execute_str equals current time.
auto_a_tree : Flag set to YES if A disk to be included
in auto tree generation.
auto_b_tree : Flag set to YES if B disk to be included
in auto tree generation.
auto_c_tree : Flag set to YES if C disk to be ONLY DISK
in auto tree generation.
auto_cursor_flag : Flag that causes automatic selection of
copy option to curse the TREE structure.
auto_directory_list : Flag that causes automatic directory listing
after a find in the TREE.
auto_e_flag : Flag that causes automatic selection of
file name into the E editor after a find.
auto_e_editor_name : Name of Editor to be used with auto_e
option.
auto_edit_compress_flag: ** DISABLED in beta copy.
Flag set to YES would invoke a compression
program before editing a file to decompress
it on the fly.
auto_mfmaint : Flag that causes automatic MAINFRAME
maintenance by sending a CARRIAGE RETURN
key to the mainframe thru communication
specified to make it think the user is still
active, and therefore prevent auto logoff
procedures. Caution - this can DEFEAT SYSTEM
SECURITY MEASURES!
auto_update_tree : Flag that causes a NEW TREE to be built
everytime OS2TREE is started.
blanker_clock_flag : Flag set to YES if a LARGE CLOCK is desired
while in SCREEN SAVER MODE.
blanker_interval : Number of seconds to wait between key strokes
before blanking the screen. (Setting it
equal to 0 turns off the feature).
blanker_securewait_time_flag : Time in seconds to wait before
calling keyboard lock program.
Set to a negative number to disable
as default.
check_floppy_disks_flag: Flag set to YES if want OS2TREE TREE to check
for available, used and max disk size when
moving
to floppy disks.
chimeflag : Enable CHIME Thread to function when
chime_str equals current time.
confirm_error_msgs_flag: Flag set to YES if user wants to CONFIRM ALL
POPUP MESSAGES and ERROR MESSAGES. The
Default is NO, resulting in POPUP MESSAGES
ranging from 1/4 sec to 4 seconds.
WARNING: SETTING this flag will cause the
program to stop and wait for
USER CONFIRMATION!
commun_protocol : Communication protocol. The default protocol
is CP78. Assign it a new value to use a
different protocol. Possible protocols are
CP78, MYTE, COMMUNICATION_MANAGER or
ALMCOPY and SUPER_ALMCOPY. SUPER_ALMCOPY
is ALMCOPY with the special filelist option
enabled which allows for faster multiple
uploads.
cur_dir : Current DIRECTORY that the TREE is at.
ie. DISK LEVEL = 0;
cur_disk : Current DISK that the TREE is at.
ie. MAINFRAME = 0, A: = 1, etc.
custom_user_a : Key defined for CUSTOM USER FUNCTION A.
custom_user_b : Key defined for CUSTOM USER FUNCTION B.
custom_group_function_flag : If YES prompts user for EACH DIRECTORY
when COPYING/DELETING and MOVING
including skipping the PARENT DIR
COMPLETELY - ie. GRAFTING!!
dates_popup_warning_time : Amount of days before and after an
IMPORTANT DATE that you want to be WARNED.
default_help_flag : Flag set to YES if want default help despite
what is specified in the os2tree.def file.
default_path : Default path to set OS2TREE when startup.
detach_mktree_flag : Flag that causes automatic mktree detaches
if detectable changes have been made to
OS2TREE.
directories_enabled : OS2TREE list selection flag for directories.
display_dates_reminder_flag : Flag set to YES if AUTOMATIC DATES
reminder feature is desired.
display_structure : Flag set to YES causes OS2TREE to be started
up in FULL SCREEN LIST MODE. Same as using
the -d option on the command line:
ex. OS2TREE -d
file_no : Index in file list of current highlighted
file.
find_start_top_flag : OS2TREE find flag which equals YES if want
to start search from the top of the list vs
from the current position.
first_time_in_flag : Flag set to YES automatically by OS2TREE
the first time a user enters OS2TREE.
It gives basic directions and help to
the first time user, and then is
automatically reset to NO for future
OS2TREE sessions.
format_center_flag : Flag set to YES if want to center formatter
header and trailer lines.
format_dualpage_center_char : Character used to separate pages when
formatting in DUAL PAGE MODE.
format_printer_flag : Flag set to YES if want to specify
printer in FORMATER. Default printer is
LASER (2 header lines at top of page).
Note: Proprinter requires Flag set to
YES.
free_oper_system_memory: Flag set to YES if want to free OS2TREE
MEMORY to the system before calling another
program, like an editor or using
the command line.
Current OS2TREE
MEMORY is written to the TEMP_DISK and then
freed, being re-read and set after the
call.
grep_case_sensitive_flag : If YES, will ask user for CASE SENSITIVE
or CASE INSENSITIVE comparison.
If NO, CASE INSENSITIVE will be assumed!
h_off : Current Horizontal displacement in TREE.
help_mode_flag : ** DISABLED in beta version at this time.
Flag set to YES puts OS2TREE is HELP mode,
displaying a USER HELP POPUP at the bottom
of the screen.
hidden_enabled : OS2TREE list selection flag for hidden files.
hidden_exclusive : OS2TREE list selection flag for hidden files
exclusively.
hpfs_character : Character used to show hpfs files in a list.
jump_cur_dir : Jump DIRECTORY that the TREE is at.
ie. DISK LEVEL = 0;
jump_cur_disk : Jump DISK that the TREE is at.
ie. MAINFRAME = 0, A: = 1, etc.
jump_flag : Jump to jump dir and disk.
lan_check_flag : If YES, will check for LAN DISKS and perform
special read calculations to get USED SIZE.
left_disk : Current Left most disk. Used for tree
position calculations.
main_frame_tree_enabled: OS2TREE MAIN FRAME list enabled.
mark_character : Character used to mark files in a list.
max_maketree_line_width: Maximum width a tree can be when MAKE is run.
If make fails due to memory error,
increase this number. Default = 482!
max_maketree_num_lines : Maximum length a tree can be when MAKE is run.
If make fails due to memory error,
increase this number. Default = 512!
mode : Current modes are:
PC_MODE = FULL SCREEN PC
MF_MODE = FULL SCREEN MF
TREE_MODE = OS2TREE TREE DISPLAY
WINDOW_PC_MODE = OS2TREE PC POPUP
WINDOW_MF_MODE = OS2TREE MF POPUP
SPECIAL_EDIT_MODE =
OS2TREE WINDOW POPUP
special windows like
TODO LIST, TASK LIST, etc.
TREE_EDIT_MODE = OS2TREE TREE DISPLAY
for picking
MOVE/COPY/DOWNLOAD
destination.
EXTERNAL_MODE = EDITER, OUTSIDE OS2TREE!!
Special modifiers:
-----------------
IFPC, IFMF, IFTREE, IFTREEMF, IFTREEPC,
IFSPECIALEDIT and IFTREEEDIT.
To change the mode, use the "mode" command.
You may TEMPORARILY change this variable in
order to change the direction for the
download
command, but you MUST restore
it to the
original value.
memory_conservative_mode: Flag set to YES wish to conserve memory,
thus freeing memory when ever possible.
This results in slower OS2TREE processing
especially between TREEMODE
and FULL SCREEN OS2TREE MODE.
mono_flag : Flag set to YES if mono display is being used,
so reverse video is used for current line
hilighting.
mouse_delay : DELAY between mouse button pushes.
mouseasciimode : Flag set to YES if in ASCII mode; SET FLAG
to NO if in WINDOW MODE so PM can control
MOUSE!!!
mouseenabled : Flag set to YES if MOUSE support is desired.
mouse_list_button1 : Not available in beta.
mouse_list_button2 : Not available in beta.
mouse_list_buttonD1 : Not available in beta.
mouse_list_buttonD2 : Not available in beta.
mouse_tree_button1 : Not available in beta.
mouse_tree_button2 : Not available in beta.
mouse_tree_buttonD1 : Not available in beta.
mouse_tree_buttonD2 : Not available in beta.
n_queue : Size of queues for directory names and
filespecs. The default is 10. Assign it a
new value for larger or smaller queues.
num_files_sort_search_msg : Total number of files in a list before
the SORT message is displayed or SEARCHING
message is displayed.
num_rows : Total number of screen rows.
num_secure_writes : Number of times file is overwritten
during the secure delete procedure.
override_readonly_ask_flag: Flag set to YES will automatically allow
deletion and copy_over of READONLY FILES.
Very beneficial when doing GROUP COPIES,
DELETES, so user does not need to be
present to confirm readonly special case
files, which under normal conditions should
be DOUBLE CHECKED before deleting or over-
writing!
page_size : Number of rows in file list display (num_rows
minus the lines used for the header and
trailer.)
pulldown_mode1_flag : Flag set to YES if want SIMPLE, DEFAULT
TREE HEADER with ONE LINE PULLDOWN BAR!
{Automatically resets pulldown_help_flag=NO}
pulldown_mode2_flag : Flag set to YES if want pulldown fast path
key assignments displayed above pulldowns.
pulldown_mode3_flag : Flag set to YES if want pulldown simple display.
query : NOT USED ANYMORE!! (Future beta release?)
rc : Return code from last OS2TREE command.
readonly_enabled : OS2TREE list selection flag for read only
files.
readonly_exclusive : OS2TREE list selection flag for read only
files exclusively.
refresh_dirsizes_flag : Flag that causes the refresh of the
directory stats. If the stats are currently
displayed, then it is immediatly updated.
refresh_delete_flag : Flag that causes refresh after moves and
deletes in TREE LISTS.
return_directory_flag : Flag set to YES if desire OS2TREE to exit
and return user back to original directory
when OS2TREE was called, instead of
returning
in current OS2TREE directory.
secure_delete_enabled : YES if the SECURE DELETE option is enabled
allowing the user the choice of delete
types.
show_file_contents_flag: YES if want VIEW_BOX to show the contents of
the current file in the POPUP LIST!
show_file_number_lines : Number of lines to be displayed in VIEW_BOX.
sort_dir : YES if want to SORT the FILE LIST.
sort_special_list : YES if want to SORT the SPECIAL FUNCTION LIST.
POPUP Lists like TODO, GENERAL TODO, etc.
spcopy_after_ts_enabled: YES if want SPECIAL COPY FEATURE to copy/move
only files with a change date after
specified date.
spcopy_ts_enabled : YES if want SPECIAL COPY FEATURE to copy/move
only files with a change date.
spcopy_size_enabled : YES if want SPECIAL COPY FEATURE to copy/move
only files with a changed size.
spcopy_exact_enabled : YES if want SPECIAL COPY FEATURE to copy/move
only files with a changed byte.
spcopy_delete_enabled : ** Not currently supported in beta release.
If special COPY FEATURE and file is OLD,
will delete the file.
stat_separator : Character used to separate STATS in OS2TREE.
system_enabled : OS2TREE list selection flag for system files.
todo_separator : Character used to separate TODO LINES.
thermom_character : Character used to display thermometer reading.
trace_flag : Turns on OS2TREE TRACE FACILITY to assist in
debugging user problems!
trace_malloc_only_flag : Activates special MALLOC memory watching
Trace facility.
trace_thread_flag : Turns on OS2TREE TRACE THREAD FACILITY to assist
in debugging user problems!
tree_speed_function_flag: YES if want to ask if want SPEED feature
option when COPYING/MOVING/DELETING DIRS.
tree_compress_flag : YES if want to compress OS2TREE output files
like OS2TREE.DAT, DATES, etc.
window_border_bot_left : Character to be used to
draw bottom left border.
window_border_bot_right : Character to be used to
draw bottom right border.
window_border_horizontal_t : Character to be used to
draw top window horizontal border.
window_border_horizontal_b : Character to be used to
draw bottom window horizontal border.
window_border_top_left : Character to be used to
draw top left border.
window_border_top_right : Character to be used to
draw top right border.
window_border_vertical : Character to be used to draw window
vertical border.
upcase : Flag that causes all input to be forced to
upper case. Set to NO to allow lower case
input, YES to force upper case.
v_off : Current Vertical displacement in TREE.
zip_pgm_name : Name of the zip program os2tree is to use.
The Default is: "PKZIP2"
un_zip_pgm_name : Name of the un-zip program os2tree is to use.
The Default is: "PKUNZIP2"
Screen Colors
-------------
The following variables determine the colors of various OS2TREE fields.
Assign new values to them to change the colors. Appendix D contains
a list of color values that can be used.
binary_color : Binary flag.
binary_marked_color : Binary flag for marked files.
blanker_back_color : Clock background.
blanker_fore_color : Clock foreground.
clock_back_color : Clock background.
clock_fore_color : Clock foreground.
column_headers_color : Column headers.
directory_color : Current directory in header.
edit_back_color : Edit fields background.
edit_fore_color : Edit fields foreground.
error_back_color : Error message background.
error_fore_color : Error message foreground.
entry_back_color : Entry fields background.
entry_fore_color : Entry fields foreground.
filespec_display_color : Filespec in header.
header_back_color : Header background.
header_fore_color : Header foreground.
hilite_color : Current file highlight.
list_screen_back_color : Main Full Screen Background Color
list_screen_back_color : Main Full Screen Foreground Color
message_fore_color : Popup Message foregournd color.
message_back_color : Popup Message background color.
message_border_color : Popup Message border color.
message_title_color : Popup Message title color.
message_trailer_color : Popup Message trailer color.
mf_files_color : MF filenames in list.
mf_marked_color : Marked MF filenames in list.
mf_mode_files_color : MF mode file color.
msg_back_color : Message background color.
msg_fore_color : Message foreground color.
n_files_color : Number of files in header.
n_marked_color : Number of marked files in header.
window_back_color : Window background color.
window_fore_color : Window foreground color.
window_marked_back_color : Window Marked background color.
window_marked_fore_color : Window Marked foreground color.
window_hilite_color : Window hilite color.
window_fore_t_color : Window title color.
window_fore_tr_color : Window trailer color.
window_border_color : Window border color.
window1_back_color : Window1 bacground color.
window1_fore_color : Window1 foreground color.
window1_marked_back_color : Window1 Marked background color.
window1_marked_fore_color : Window1 Marked foreground color.
window1_hilite_color : Window1 hilite color.
window1_fore_t_color : Window1 title color.
window1_fore_tr_color : Window1 trailer color.
window1_border_color : Window1 border color.
window2_back_color : Window2 background color.
window2_fore_color : Window2 foreground color.
window2_marked_back_color : Window2 Marked background color.
window2_marked_fore_color : Window2 Marked foreground color.
window2_hilite_color : Window2 hilite color.
window2_fore_t_color : Window2 title color.
window2_fore_tr_color : Window2 trailer color.
window2_border_color : Window2 border color.
pc_files_color : PC filenames in list.
pc_marked_color : Marked PC filenames in list.
pc_mode_files_color : OS2TREE mode in header.
prompt_back_color : Prompt fields background.
prompt_fore_color : Prompt fields foreground.
size_marked_color : Size of marked files in header.
trailer_back_color : Trailer background.
trailer_fore_color : Trailer foreground.
tree_back_color : Tree Mode Screen Backgound Color
tree_fore_color : Tree Mode Screen Foregound Color
tree_availdisks_color : OS2TREE available disks color.
tree_availno_color : OS2TREE unavailable disks color.
tree_availyes_color : OS2TREE available disks color.
tree_box_fore_color : OS2TREE box foreground color.
tree_box_back_color : OS2TREE box background color.
tree_box_text_color : OS2TREE box text foreground color.
tree_box_stats_color : OS2TREE box stats foreground color.
tree_box_cmds_color : OS2TREE box cmds foreground color.
tree_box_highlite_color : OS2TREE box highlite background color.
tree_clock_fore_color : OS2TREE TREE MODE foreground color.
tree_clock_back_color : OS2TREE TREE MODE background color.
tree_edit_border_fore_color : OS2TREE TREE EDIT MODE border color.
tree_hilite_color : OS2TREE hilite color.
tree_name_fore_color : OS2TREE directory name foreground color.
tree_name_back_color : OS2TREE durectory name background color.
tree_pulldown_back_color : OS2TREE Pulldown background color.
tree_pulldown_fore_color : OS2TREE Pulldown foreground color.
tree_stats_fore_color : OS2TREE stats foreground color.
tree_stats_back_color : OS2TREE stats background color.
tree_stats_keyfore_color : OS2TREE stats key foreground color.
tree_stats_keyback_color : OS2TREE stats key background color.
tree_stats_keydef_color : OS2TREE stats key def foreground color.
tree_thermom_fore_color : OS2TREE thermometer foreground color.
tree_thermom_back_color : OS2TREE thermometer background color.
tree_thermom_merc_color : OS2TREE thermometer mercury color.
tree_title_color : OS2TREE title color.
tree_totalsize_color : OS2TREE total size color.
tree_netsize_color : OS2TREE net size color.
tree_viewbox_b_fore_color : OS2TREE viewbox border foreground color.
tree_viewbox_fore_color : OS2TREE viewbox foreground color.
tree_viewbox_back_color : OS2TREE viewbox background color.
String Variables
----------------
alarm_str : Character string with time for wakeup
alarms.
String Format: "HH:MM:SS,HH:MM:SS"
ex. "07:15:00" sets an alarm for
7:15am
ex. "07:15:00,12:00:00" sets an alarm
for 7:15am and 12:00 NOON!!
String Format: "HOURLY", "HALFHOURLY",
"NOON", "MIDNIGHT".
Setting string to "OFF" or "" disables
alarm
auto_execute_file_name : Name of file to read and execute commands
if AUTO_EXECUTE_FLAG == YES and the auto_execute_str
condition is satisfied.
Special Substitution Keywords that can be used
in the auto_execute_file:
&DAY - replaced with YEAR & DAY.
Example Date: June 22th, 1992
gen&DAY --> gen62292 (MDDYR = 5 chars)
&MONTH - replaced with YEAR,MONTH & DAY.
gen&DAY --> gen692 (MYR = 3 chars)
&TIME - replaced with YEAR,MONTH,DAY & TIME.
(MDHHMMYR = 8 chars)
Example: Monday June 14th, 1993 at 15:00:00
(6N150093)
&FULLTIME - replaced with YEAR,MONTH,DAY
& TIME in a more legible form.
(MMMDDYR.MMH = 11 chars)
Example: Monday June 14th, 1993 at 15:00:00
(JUN1493.F00)
auto_execute_file_out : Name of file to output results of executed
commands when auto_execute_file_name is
read and processed.
auto_execute_str : Character string with options for
Auto_execute Option.
String Format: "HH:MM:SS,HH:MM:SS"
ex. "07:15:00" sets an alarm for 7:15am
ex. "07:15:00,12:00:00" sets an alarm
for 7:15am and 12:00 NOON!!
String Format: "HOURLY", "HALFHOURLY",
"NOON", "MIDNIGHT".
Setting string to "OFF" or "" disables
alarm.
auto_e_editor_name : Name of the EDITOR program to use when
auto_e_flag
feature is enabled.
auto_e_exclusion_list : list of excluded file extensions for
auto_e_flag = YES option! Each extension
must be enclosed in brackets!!!
example: exclude BIN, EXE and OBJ
auto_e_exclusion_list="[BIN],[EXE],[OBJ]".
auto_task_exclusion_list : list of excluded character strings for
TASK LIST option! Each character string
must be enclosed in brackets!!!
example: exclude MANAGER
auto_task_exclusion_list="[MANAGER]".
backup_destination : BACKUP destination path.
Special Substitution Keywords that can be used
in the backup_destination PATH:
&DAY - replaced with YEAR & DAY.
Example Date: June 22th, 1992
gen&DAY --> gen62292 (MDDYR = 5 chars)
&MONTH - replaced with YEAR,MONTH & DAY.
gen&DAY --> gen692 (MYR = 3 chars)
&TIME - replaced with YEAR,MONTH,DAY & TIME.
(MDHHMMYR = 8 chars)
Example: Monday June 14th, 1993 at 15:00:00
(6N150093)
&FULLTIME - replaced with YEAR,MONTH,DAY
& TIME in a more legible form.
(MMMDDYR.MMH = 11 chars)
Example: Monday June 14th, 1993 at 15:00:00
(JUN1493.F00)
backup_str : Character string with time for wakeup
backup.
String Format: "HH:MM:SS,HH:MM:SS"
ex. "07:15:00" sets a backup for
7:15am
ex. "07:15:00,12:00:00" sets a backup
for 7:15am and 12:00 NOON!!
String Format: "HOURLY", "HALFHOURLY",
"NOON", "MIDNIGHT".
Setting string to "OFF" or "" disables
backup.
chime_notes_str : Character string with notes to play when
chime_str condition is satisfied.
chime_str : Character string with options for Chime
Option.
String Format: "HH:MM:SS,HH:MM:SS"
ex. "07:15:00" sets an alarm for 7:15am
ex. "07:15:00,12:00:00" sets an alarm
for 7:15am and 12:00 NOON!!
String Format: "HOURLY", "HALFHOURLY",
"NOON", "MIDNIGHT".
Setting string to "OFF" or "" disables
alarm.
commun_cmd_prog : The name of the communication program for
sending commands to MF.
commun_cmd_clear : The code used by commun_cmd_prog for CLEAR.
commun_cmd_enter : The code used by commun_cmd_prog for ENTER.
dates_list_title1 : Character strings containing DATES LIST
dates_list_title2 POPUP TITLE STRINGS.
dates_list_title3
dates_list_trailer : Character string containing DATES LIST
POPUP trailer.
dates_popup_file_name : Name of the file that the IMPORTANT DATES
dates are read from and stored in..
def_file_name : Name of OS2TREE.DEF file OS2TREE is to use.
dtfiles : The path to the file that contains the
OS2TREE data parameters.
editor_file_name : Name of the MAIN EDITOR program OS2TREE is to use.
files_list_trailer : Character string containing FILES LIST
POPUP trailer.
floppy_drives_list : list of floppy drives for current system.
example: "A:,B:,D:"
format_c_filename : Default OS2TREE FORMATTER cover page file
name = "OS2TREEFORMAT.COV";
format_dheader1 : File Formatter default header line 1.
format_dheader2 : File Formatter default header line 2.
format_dheader3 : File Formatter default header line 3.
format_dheader1 : File Formatter default header line 1.
format_dheader2 : File Formatter default header line 2.
format_dheader3 : File Formatter default header line 3.
format_dpage_size : Default page size for printer.
format_dtrailer1 : File Formatter default trailer line 1.
format_dtrailer2 : File Formatter default trailer line 2.
format_dtrailer3 : File Formatter default trailer line 3.
format_header1 : File Formatter current header line 1.
format_header2 : File Formatter current header line 2.
format_header3 : File Formatter current header line 3.
format_header4 : File Formatter current header line 4.
format_header5 : File Formatter current header line 5.
format_header6 : File Formatter current header line 6.
format_left_margin : The left margin for the formatter.
format_page_number : Starting Page number for the formatter.
format_page_size1 : Page size for Printer 1.
format_page_size2 : Page size for Printer 2.
format_special_char1 : Special General sequence for Printer 1.
format_special_char2 : Special General sequence for Printer 2.
format_special_clear1 : Special Clear sequence for Printer 1.
format_special_clear2 : Special Clear sequence for Printer 2.
format_special_land1 : Special Lanscape sequence for Printer 1.
format_special_land2 : Special Lanscape sequence for Printer 2.
format_special_reset1 : Special Reset sequence for Printer 1.
format_special_reset2 : Special Reset sequence for Printer 2.
format_trailer1 : File Formatter current trailer line 1.
format_trailer2 : File Formatter current trailer line 2.
format_trailer3 : File Formatter current trailer line 3.
format_trailer4 : File Formatter current trailer line 4.
format_trailer5 : File Formatter current trailer line 5.
format_trailer6 : File Formatter current trailer line 6.
** special note: %filename% in the header or trailer will be
automatically replaced with the formatted
filename.
%date% automatically replaced with date.
%page#% automatically replaced with page
number. ** additional note: CAPS ONLY or
LOWERCASE ONLY, no mixed case!!
ie: %DATE% and %date% ok, but %Date% no go!!
format_page_number : The starting line number for the formatter.
format_page_size : The number of lines per page (default=66).
format_special_ch : A special char to insert at top at the top
of the formatted file to specify:
condensed, 12 char/inch etc.
format_special_proprinter_ch :
A special ending char to insert at the bottom
of the formatted file to specify reset
condition: condensed, 12 char/inch etc.
(for proprinter type printer)
format_special_en : A special char to insert at top at the top
of the formatted file to specify:
condensed, 12 char/inch etc.
format_special_proprinter_en :
A special ending char to insert at the bottom
of the formatted file to specify reset
condition: condensed, 12 char/inch etc.
(for proprinter type printer)
generic_file_directory : Default directory for GENERIC TODO LIST FILES.
generic_list_title : Character string containing GENERIC
TODO LIST POPUP title.
generic_list_trailer : Character string containing GENERIC
TODO LIST POPUP trailer.
generic_backup_dest : GENERIC LIST POPUP backup destination.
generic0 thru generic49: Line in special User GENERIC TODO option.
grep_editor_file_name : Name of the editor program os2tree is to use.
to edit/browse the GREP OUTPUT FILE.
The Default is: "OS2TREE_VIEWER" - internal
OS2TREE view utility.
grep_exclusion_list : list of excluded file extensions for
grep feature. Each extension
must be enclosed in brackets!!!
example: exclude DLL, EXE and COM
grep_exclusion_list="[DLL],[EXE],[DLL]".
help0 thru help49 : Line in special User Help option.
help_file_name : Name of the OS2TREE help file.
host_session_delete : Host Session DELETE command string.
host_session_list : Host Session LIST command string.
host_session_name : Defaulted to H but can also be Ha, Hb, Hc, etc.
host_session_rename : Host Session RENAME command string.
host_session_file_out : Name of file to output HOST SESSION CMDS
for debug and verifications purposes.
keyboard_lock_name : Name of keyboard lock program and parms:
ex. "LOCKITUP /B";
legal_drives_list : List of pre-defined legal drives
lst_file_name : Name of mf list data file OS2TREE is to use.
main_frame_namef_ : MAINFRAME name to use: ie. "TSO", "VM", etc.
maketree_exclusion_list: List of DISKS not to be included
when the MAKE TREE option is executed.
If the Drive letter is UPPERCASE, it is
totally ignored.
If the Drive letter is LOWERCASE, only
the ROOT level directories are displayed.
mf_name : MF file name, without type or mode.
mf_type : MF file type.
mf_mode : MF file mode.
mf_file : Full MF file name.
mffiles : The path to the file that contains the
listing of MF files.
mfmaint_file_name : Name of the mfmaint data file for MFMAINT
to use.
mini_help_str : Character string for a miniture help line in
tree_stat_box at bottom of TREE DISPLAY
SCREEN.
mouse_key1_str : Name of First Mouse Area.
mouse_key1_ch : Key to emulate if First Mouse Area selected.
mouse_key2_str : Name of Second Mouse Area.
mouse_key2_ch : Key to emulate if Second Mouse Area selected.
mouse_key3_str : Name of Third Mouse Area.
mouse_key3_ch : Key to emulate if Third Mouse Area selected.
mouse_key4_str : Name of Fourth Mouse Area.
mouse_key4_ch : Key to emulate if Fourth Mouse Area selected.
mouse_key5_str : Name of Fifth Mouse Area.
mouse_key5_ch : Key to emulate if Fifth Mouse Area selected.
mouse_key6_str : Name of Sixth Mouse Area.
mouse_key6_ch : Key to emulate if Sixth Mouse Area selected.
mouse_key7_str : Name of Seventh Mouse Area.
mouse_key7_ch : Key to emulate if Seventh Mouse Area selected.
mouse_key8_str : Name of Eighth Mouse Area.
mouse_key8_ch : Key to emulate if Eighth Mouse Area selected.
net_drives_list : List of network drives for space calculations
(Also should include local CD ROMS, etc.)
pager_file_name : Name of the pager program os2tree is to use.
Default is: "OS2TREE_VIEWER" - internal
OS2TREE view utility.
password : Password for BLANKER ESC! (NULL as default)
pc_name : PC file name, without extension.
pc_type : PC file extension.
pc_file : Full PC file name.
printer_port1 : Not supported for beta.
printer_port10 : Not supported for beta.
printer_port2 : Not supported for beta.
printer_port3 : Not supported for beta.
printer_port4 : Not supported for beta.
printer_port5 : Not supported for beta.
printer_port6 : Not supported for beta.
printer_port7 : Not supported for beta.
printer_port8 : Not supported for beta.
printer_port9 : Not supported for beta.
printer_port : Name of printer port, defaulted to LPT1,
but can be set to LPT2, LPT3 or any
filename. Used by FORMATTER and PRINTER
POPUP LIST.
printer_string1 : Not supported for beta.
printer_string10 : Not supported for beta.
printer_string2 : Not supported for beta.
printer_string3 : Not supported for beta.
printer_string4 : Not supported for beta.
printer_string5 : Not supported for beta.
printer_string6 : Not supported for beta.
printer_string7 : Not supported for beta.
printer_string8 : Not supported for beta.
printer_string9 : Not supported for beta.
prm_file_name : Name of parm data file OS2TREE is to use.
pro_file_name : Name of OS2TREE.PRO OS2TREE is to use.
pro_exe_file_name : Name of OS2TPRO.EXE OS2TREE is to use.
pulldown0 : Pulldown lines for TREE HEADER DISPLAY.
pulldown1
pulldown2
pulldown3
pulldown4
queue_list_title : Character string containing QUEUE LIST
POPUP title.
queue_list_trailer : Character string containing QUEUE LIST
POPUP trailer.
send_cmd_prog : The name of the send program.
setup_directory : Default directory for SETUP FILES.
screen : The string returned when saving a screen
image.
show_all_disk_exclusionList : list of excluded DISKS not to be
searched when the SHOW_ALL option
is executed.
special_file_name : Name of special file name.
special_msg_file_name : Name of special message file name.
special_msg_search_str : Name of special message search string.
special_msg_str : Name of special message string.
system_drives_list : List of system drives (vs. NETWORK or readonly
drives like CDROMS) for space calculations!!
task_req0 thru task_req09 : Line in special User TASK_REQ option.
temp_disk : Disk to create Temporary files on, ie.
"C:" is the default.
tiny_editor_file_name : Name of the TINY editor program OS2TREE is to use.
todo_backup_dest : TODO LIST POPUP backup destination.
todo_list_title : Character string containing TODO LIST
POPUP title.
todo_list_trailer : Character string containing TODO LIST
POPUP trailer.
todo0 thru todo49 : Line in special User TODO option.
trailer0, trailer1, trailer2 : First, second and third line of
trailer. Only the lines that are
set are used.
tree_lst_file_name : Name of file containing latest OS2TREE.
tree_lst_file_oldname : Name of file containing backup OS2TREE.
rs : The string returned by OS2TREE commands that
return a string.
show_file_number_lines : Number of lines to display i the file view
box.
APPENDIX C: OS2TREE commands
after : Same as before in beta version.
ask <n> : Ask for a response to a YES/NO question,
<msg> where n is the row to display the question,
<esc> msg is the question and esc is a flag
(YES,NO) whether to allow the ESC key.
attribute_archive : Set archive attribute for current PC file.
attribute_archive_mark : Set archive attribute for all marked PC files.
attribute_system : Set system attribute for current PC file.
attribute_system_mark : Set system attribute for all marked PC files.
attribute_hidden : Set hidden attribute for current PC file.
attribute_hidden_mark : Set hidden attribute for all marked PC files.
attribute_readonly : Set readonly attribute for current PC file.
attribute_readonly_mark : Set readonly attribute for all marked PC files.
auto_backup : Start the FOREGROUND Thread Execution
of the Auto_backup function.
auto_backup_now : Start the BACKGROUND Thread Execution
of the Auto_backup function.
auto_execute : Start the FOREGROUND Thread Execution
of the Auto_execute_file_name.
auto_execute_now : Start the BACKGROUND Thread Execution
of the Auto_execute_file_name.
backup : Set the Dynamic Backup flag for the current file.
backup_perm : Set the Permanent Backup flag for the current file.
backup_mark : Set the Dynamic Backup flag for all marked files.
backup_perm_mark : Set the Permanent Backup flag for all marked files.
batch_mark : Execute the BATCH CREATION FUNCTION on marked files.
Mask Line: special chars are the following
%1 = FULL Path and Name and Extension of file
%2 = Drive letter only
%3 = Path only {no drive letter or colen etc.
%4 = Name only
%5 = Extension only
%6 = Name and Extension only
%% = The character '%'
Ex: C:\OS2\SYSTEM\TEST.EXE
%1 = "C:\OS2\SYSTEM\TEST.EXE"
%2 = "C"
%3 = "\OS2\SYSTEM"
%4 = "TEST"
%5 = "EXE"
%6 = "TEST.EXE"
%% = "%"
beep : Beep.
before : Move to the previous directory.
bin_all_mark : Set the binary flag for all marked files.
blanker : Execute the OS2TREE BLANKER ROUTINE.
box : Display BOX of statistics/commands in OS2TREE (YES/NO).
clear_area_screen <top row> <left column> <bottom row> <right column> :
Clear the rectangular area bounded by the four
parameters.
clear_screen : Clear the entire screen.
clock <rate> : Display a continuous clock, specify rate (updates
(no longer supported-dummy field)
<row> per second) and row and col to display it with
<col> (YES, NO) seconds for OS2TREE only.
<secs>
color_window : Popup window of OS2TREE Color Variables.
(left, top, right, bottom)
color_window_color : Popup window of OS2TREE colors available for selection.
(left, top, right, bottom)
command_line_rtn : Return after command line execution (YES/NO).
or allow another command line.
convert_mf_to_pc_name: Convert a mainframe name to the appropriate
pc name based on the OS2TREE TYPE DEFINITIONS.
concat_strings : Concatenate two strings into one string.
copy : Copy the current PC file. The user is prompted for
the destination. The syntax for destination is the
same as the DOS/OS2 COPY command.
copy_mark : Copy all marked PC files.
cursor_maximum : Set the cursor speed to the maximum.
cursor_minimum : Set the cursor speed to the minimum.
dates : Display the Dates Popup for setting important
dates for the Important Dates Reminder Function:
(left, top, right, bottom)
default_page_down : Default setting for page down key
default_page_up : Default setting for page up key
delete : Delete the current file. The user is asked to
confirm before the deletion occurs.
delete_dir : Delete the current directory in the tree.
delete_disk : Delete the current disk from the TREE!
delete_item : Delete an item from a SPECIALTY POPUP LIST.
delete_mark : Delete all marked files.
delete_queue_item : Delete a item from the special [C_W] QUEUE POPUP
LIST.
delete_tree_dirs : Delete all ROOT DIRECTORIES under the current DIR
from the TREE! (Only GRAPHICALLY, not an actual
DIRECTORY DELETE!
demo : Execute a DEMO of OS2TREE!!!
display_copy_options_list : Display SPECIAL COPY OPTIONS Popup.
(left, top, right, bottom)
display_dates_list : Display a list of all IMPORTANT DATES.
display_format_list : Display a list of FORMATTER SPECIAL OPTIONS.
display_generic_list : Display GENERIC Popup.
(left, top, right, bottom, SORT_OS2TREEFLAG)
display_help_list : Display CUSTOMIZED HELP Popup.
(left, top, right, bottom)
display_list_options_list : Display LIST OPTIONS Popup.
(left, top, right, bottom)
display_options_list : Display OPTIONS Popup.
(left, top, right, bottom)
display_mode_list : Display LINE MODE CHOICES Popup.
display_printer_list : Display PRINTER Popup.
(left, top, right, bottom)
display_task_list : Display the OS/2 LIST OF TASKS FOR SELECTION!
(left, top, right, bottom, SORT_OS2TREEFLAG)
display_task_req_list : Display the OS/2 LIST OF TASKS TO START!
(left, top, right, bottom, SORT_OS2TREEFLAG)
display_timers_list : Display timer options in OS2TREE Popup. Note
available in this beta release.
display_todo_list : Display TODO Popup.
(left, top, right, bottom, SORT_OS2TREEFLAG)
display_tree_roots_only: Flag set to YES causes OS2TREE to be started
up in the DEFAULT TREE MODE with a new
tree containing on the ROOT DISKS!
the -r option on the command line:
ex. OS2TREE -r
Note: Would only use -r option to override a
setting of display_tree_roots_only in the profile.
display_tree_structure : Flag set to YES causes OS2TREE to be started
up in the DEFAULT TREE MODE. Same as using
the -t option on the command line:
ex. OS2TREE -t
Note: Would only use -t option to override a
setting of display_tree_structure in the profile.
display : Note available in beta version.
dos_session_switch : Go directly to the DOS box from an OS/2 session.
download : Download (MF mode) the current file.
download_mark : Download all marked files.
edit : Involk the editor on the current file.
<refresh> Use YES to refresh list after edit, NO for
simple return.
<new> Use YES to specify new file, NO to edit file.
<clock> Use YES to request CLOCK, NO to remove CLOCK.
<rate> If YES, specify rate in seconds to update,
(no longer supported-dummy field)
<row> <col> row and col to display clock at,
<secs> (YES, NO) to display SECS and
<back> <fore> background and foreground colors.
Use 99 for defaults colors.
edit_auto : Not available in beta version.
edit_bad : Not available in beta version.
edit_copy : Not available in beta version.
edit_mark : Involk the editor on the marked files.
<refresh> Use YES to refresh list after edit, NO for
simple return.
<new> Use YES to specify new file, NO to edit file.
<clock> Use YES to request CLOCK, NO to remove CLOCK.
<rate> If YES, specify rate in seconds to update,
(no longer supported-dummy field)
<row> <col> row and col to display clock at,
<secs> (YES, NO) to display SECS and
<back> <fore> background and foreground colors.
Use 99 for defaults colors.
edit_name : Edit the upload MF name (in PC mode) or download
PC name (in MF mode).
edit_new : Select new directory in TREE_EDIT_MODE.
edit_old : Select old (last selected) directory in
TREE_EDIT_MODE.
edit_path : Select current path for editing in TREE_EDIT_MODE.
edit_select : Select current directory in TREE_EDIT_MODE.
entire_system : Perform ENTIRE SYSTEM function.
execute : If the current file is an executable program or
CMD or BAT file, execute it.
execute_mark : If the marked files are executable programs or
CMD or BAT files, they are execute.
execute_on_mark : The ENTERED program name is executed on each of
the marked files separately.
alt_find : Find a file name in the list. The user is prompted
for the name. This is the opposite to the find.
If find is defined to start at current position,
the alt_find will start at the top and visa-versa.
find : Find a file name in the list. The user is prompted
for the name.
find_next : Find the next file matching the previously entered
name.
find_save : Find the next file matching the saved name field.
format : Format the current PC file. The user is prompted for
the destination file name.
format_mark : Format all marked PC files.
generic_backup : Backup GENERIC LIST.
generic_file_directory: Directory Path used in GENERIC TODO LISTS!
generic_rename : Rename an item from the GENERIC LIST.
get_mf_file : Gets a user requested file from MF and downloads
it according to the OS2TREE TYPE DEFINITIONS!
grep_file_directory: Directory Path used in GREP FUNCTIONS! If no path
is specified, the CURRENT PATH is assumed.
header : Redisplay the header.
help_popup : Popup window of Custom Help as defined in the
OS2TREE.DEF file. (left, top, right, bottom)
help : Display help file (Using pager utility specified).
help_about_window : Display help about window message.
host_session_switch: Go directly to the HOST from an OS/2 session.
insert_dir : Insert a new DIRECTORY after the current directory
<move flag> in the tree structure. If move Flag is YES, moves
to inserted directory (default is YES!).
insert_after_disk : Insert a new/duplicate disk into the TREE after
Current Disk.
insert_before_disk : Insert a new/duplicate disk into the TREE before
Current Disk.
insert_item : Insert a new item in a SPECIALTY POPUP LIST.
insert_tree_dirs : Insert all ROOT DIRECTORIES under current DIR into
the TREE! (Only GRAPHICALLY, not an actual
DIRECTORY CREATE, since will only insert the
ROOT directorys it finds under the current DIR).
invert_backup_all : Invert the backup on all files (backuped files are
unbackuped, unbackuped files are backuped.)
invert_mark_all : Invert the mark on all files (marked files are
unmarked, unmarked files are marked.)
invert_tag_all : Invert the tag on all files (tag files are
untagged, untagged files are tagged.)
join : Join the current PC file. The user is prompted for
the destination file name. This doesn't make much
sense, but for completeness is still available.
Maybe remove in next beta release.
join_mark : Join all marked PC files.
keyboard_lock : Calls a program to lock the keyboard
mfmaint : execute MFMAINT to maintain MF session
note: must be called AFTER mfmaint_file_name
and commun_protocol have been initialized!
mf_popup : Popup Window of Main Frame files.
(left, top, right, bottom)
missing_directory : Request a POPUP FILE LIST for a missing directory
in the tree.
mk_tree : Not available in beta version.
mode_ <n_lines> : Change mode to desired size. ex. mode_ 50
mode_xx : Change mode to num_rows value.
mode_25 : Change mode to 25 line mode.
mode_43 : Change mode to 43 line mode.
mode_50 : Change mode to 50 line mode.
mouse_pulldown_1 : Request a MOUSE PULL DOWN #1.
(left, top, right, bottom, SORT_OS2TREEFLAG)
mouse_pulldown_2 : Request a MOUSE PULL DOWN #2.
(left, top, right, bottom, SORT_OS2TREEFLAG)
mouse_pulldown_3 : Request a MOUSE PULL DOWN #3.
(left, top, right, bottom, SORT_OS2TREEFLAG)
mouse_pulldown_4 : Request a MOUSE PULL DOWN #4.
(left, top, right, bottom, SORT_OS2TREEFLAG)
mouse_pulldown_5 : Request a MOUSE PULL DOWN #5.
(left, top, right, bottom, SORT_OS2TREEFLAG)
mouse_pulldown_6 : Request a MOUSE PULL DOWN #6.
(left, top, right, bottom, SORT_OS2TREEFLAG)
mouse_pulldown_7 : Request a MOUSE PULL DOWN #7.
(left, top, right, bottom, SORT_OS2TREEFLAG)
mouse_pulldown_8 : Request a MOUSE PULL DOWN #8.
(left, top, right, bottom, SORT_OS2TREEFLAG)
move_down <n_lines>: Move the cursor the specified number of lines. Use
a negative number to move up, positive to move down.
* Special cases: Default_page_down, Default_page_up;
move_right<n_lines>: Move the cursor the specified number of columns. Use
a negative number to move left, positive to move
right.
move : Move the current PC file. The user is prompted for
the destination. The syntax for destination is the
same as the DOS/OS2 COPY command. After a successful
copy, the file is delted.
move_mark : Move all marked PC files.
move_verification : (YES/NO) verify copied file before deleting
note: double check when moving important files,
but will slow things down!!
music : Play a string of notes, example:
MUSIC "A1 B1 C1 D4 D3 D2"
music_default : Play a default music string "Big Ben Chime".
new_directory : Change the current PC directory.
new_filespec : Change the filespec for displayed files.
Filespec delimiters: " ()[],;:-"
Filespec exclusion delimiters: "{}"
new_tree_current : Make a tree for the current Disk Only.
new_tree_harddisks : Make a tree for all Disks.
new_tree_harddisks_a : Make a tree for all Disks and Drive A.
new_tree_harddisks_b : Make a tree for all Disks and Drive B.
new_tree_harddisks_nolan : Make a tree for all Disks except Lan Disks.
new_tree_roots : Make a tree for all Disks (roots only).
operate_on : The ENTERED program name is executed with the
current file as the input.
operate_on_mark : The ENTERED program name is executed with the marked
files as the input (argv).
os2tree_stat : Toggle the display of the DIRECTORY STATS when the
tree is displayed.
os2_call : Prompt user for a DOS or OS/2 command.
os2_cmd : Start up a DOS or OS/2 command session. User can
then enter DOS commands to be executed. When the
user types 'EXIT', OS2TREE resumes.
print : Print the current PC file.
print_file_list : Print Current File Directory List.
print_mark : Print all marked files.
prog_call : Call a program.
prompt : Prompt the user for a Y/N answer.
prune_dir : Remove the current directory from tree.(pruning tree!)
quit : Quit OS2TREE.
redraw : Redraw the screen.
refresh : Refresh the list. Read in the directory and redisplay.
rename : Rename current file (MF or PC).
rename_dir : Rename the current directory in the tree.
rename_mark : Rename all marked files.
request <n> : Request for an input string on line n,
<msg> where msg is the question. rc = 0 if valid
input was entered.
restore_clock : Restore the current position etc. of the OS2TREE
CLOCK!!
restore_screen <screen> : Restore previously saved screen (see
save_screen).
save_screen : Save screen for later restore_screen. RS contains
a pointer to a buffer conting the saved screen.
Example:
save_screen ,
old_screen = rs ,
@"myprog" , # myprog messes up the screen
restore_screen old_screen ;
say <msg> : Display msg on top line of screen.
say_2 <msg> : Display msg on top line + 2 lines down of screen.
save_clock : Save the current position etc. of the OS2TREE CLOCK!!
save_options : Save the current OS2TREE settings to the OS2TREE.DEF
file for permanent storage.
save_options_and_keys : Save the current OS2TREE settings to the
OS2TREE.DEF file for permanent storage along
with resetting the key definitions to the
initial default settings.
searchpath <file name> [<env_var>] : Search a path for the file name. If
env_var is not specified, DPATH is used.
secure (wipe) : Writes over the current file num_secure_writes times.
The user is asked to confirm before the secure/wipe
occurs.
secure_mark (wipe_mark) : Wipe all marked files.
select_item : Select item in list and process accordingly.
send : Send the current PC file.
send_mark : Send marked files.
set_clock <rate>: MOVE the continuous clock, specify rate (updates
(no longer supported-dummy field)
<row> per second) and row and col to display it with
<col> (YES, NO) seconds.
<secs>
set_date : Set the time/date stamp of the current PC file.
set_date_mark : Set the time/date stamp of all marked PC files.
setup_directory : Directory Path used in OS2TREE REQUIRED FILE NAMES.
show_all : Perform SHOW_All file search function.
show_backup_all : Display list of DYNAMIC BACKUP FILES.
show_perm_backup_all:Display list of PERMANENT BACKUP FILES.
show_tag_all : Display list of TAG FILES.
sleep <secs> : Sleep for x seconds.
sort_order : Prompt for new sort order for general list boxes.
special_sort_order : Prompt for new sort order for special list boxes.
special_file_name : Edit SPECIAL FILE NAME with default auto_editor.
special_copy : Copy the current PC file based on SPECIAL COPY PARMS.
The user is prompted for the destination. The
syntax for destination is the same as the DOS/OS2
COPY command. See: display_copy_options_list.
special_copy_mark : Copy all marked PC files based on SPECIAL COPY PARMS.
See: display_copy_options_list.
speed_cursor <speed> : Change the cursor speed. <speed> must be between
1 (slowest) and 15.
switchmode <flag> : Switch current modes
flag = 0 clean up and switch to next mode.
flag = 1 clean up and switch to MF with no new list.
flag = 2 clean up and switch to MF with new mf list.
switch_percent : Switch the tree percent representations. (ie. Toggle)
tag : Tag the current file.
tag_mark : Tag all marked files.
timer_window : Popup window of Timers. Note available in beta version.
(left, top, right, bottom)
tiny : Invoke tiny editor on current file.
<refresh> Use YES to refresh list after edit, NO for
simple return.
<new> Use YES to specify new file, NO to edit file.
<clock> Use YES to request CLOCK, NO to remove CLOCK.
<rate> If YES, specify rate in seconds to update,
(no longer supported-dummy field)
<row> <col> row and col to display clock at,
<secs> (YES, NO) to display SECS and
<back> <fore> background and foreground colors.
Use 99 for defaults colors.
tiny_mark : Invoke tiny editor on marked files.
<refresh> Use YES to refresh list after edit, NO for
simple return.
<new> Use YES to specify new file, NO to edit file.
<clock> Use YES to request CLOCK, NO to remove CLOCK.
<rate> If YES, specify rate in seconds to update,
(no longer supported-dummy field)
<row> <col> row and col to display clock at,
<secs> (YES, NO) to display SECS and
<back> <fore> background and foreground colors.
Use 99 for defaults colors.
todo_backup : Backup TODO LIST.
todo_file_directory: Directory Path used in TREE TODO LISTS!
todo_rename : Rename TODO LIST.
toggle_mark : Mark the current line if it is unmarked, unmark it
if it is marked.
toggle_tag : Tag the current line if it is untagged, untag it
if it is tagged.
toggle_backup : Backup the current line if it is unbackedup, unbackup it
if it is backuped.
toggle_mark_all : Toggle the mark on all files (marked all files,
unmark all files).
toggle_tag_all : Toggle the tag on all files (tag all files,
untagged all files).
tog_bin : Toggle the binary flag on the current_file=file_no.
tog_bin_mark : Toggle the biinary flag on all marked files.
touch : Set the time/date stamp of the current PC file
to the current time/date, ie. touch the file.
touch_mark : Set the time/date stamp of all marked PC files
to the current time/date, ie. touch the files.
trailer : Redisplay the trailer lines.
trans_ext <pc_ext> <mf_type> <bin_flag> : Tells OS2TREE to automatically
translate the given file extension to the mf_type
when uploading, and vice versa when downloading.
If bin_flag is 1, the binary flag is automatically
set for files with the given extension.
tree : View the OS2TREE tree.
tree_list : Popup a FILE LIST for a selected Current Directory.
tree_clock <rate> : Display a continuous clock, specify rate (updates
(no longer supported-dummy field)
<row> per second) and row and col to display it with
<col> (YES, NO) seconds for TREE only.
<secs>
tree_display : Displays a TREE UTILITY, which allows the user
<clock> to select specific directories to enter OS2TREE
<rate> with or DELETE, RENAME, MOVE or COPY Directories.
(no longer supported-dummy field)
<row> Use YES to request CLOCK, NO to remove CLOCK.
<col> If YES, specify rate in seconds to update,
<secs> row and col to display clock at,
<back> (YES, NO) to display SECS and
<fore> background and foreground colors.
Use 99 for defaults colors.
tree_stat : Display STATS in OS2TREE (YES/NO).
tree_percent : Display header Info in OS2TREE as PERCENT!! (YES/NO).
unbin_all_mark : Clear the binary flag for all marked files.
un_backup : Remove the Dynamic Backup flag for the current file.
un_backup_mark : Remove the Dynamic Backup flag for all marked files.
un_backup_perm : Remove the Permanent Backup flag for the current file.
un_backup_perm_mark: Remove the Permanent Backup flag for all marked files.
un_tag : Remove the tag from the current file.
un_tag_mark : Remove the tag from all marked files.
upload : Upload (PC mode) the current file.
upload_mark : Upload all marked files.
view : View the current file.
view_mark : View all marked files.
viewbox_down : Default setting for viewbox down key
viewbox_end : Default setting for viewbox end key
viewbox_home : Default setting for viewbox home key
viewbox_page_down : Default setting for viewbox page down key
viewbox_page_up : Default setting for viewbox page up key
viewbox_up : Default setting for viewbox up key
window_stat : Toggle the current Window SIZE/TIME-DATE stat.
wipe (secure) : Writes over the current file num_secure_writes times.
The user is asked to confirm before the secure/wipe
occurs.
wipe_mark (secure_mark) : Wipe all marked files.
zip_mark : Execute the ZIP PROGRAM on marked files.
APPENDIX D: Colors
The following colors can be used:
BLACK DARK_GRAY
BLUE LT_BLUE
GREEN LT_GREEN
CYAN LT_CYAN
RED LT_RED
MAGENTA LT_MAGENTA
BROWN YELLOW
LT_GRAY WHITE
