home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
OS/2 Shareware BBS: 6 File
/
06-File.zip
/
os2-tree.zip
/
OS2HELP.DOC
< prev
next >
Wrap
Text File
|
1993-11-21
|
23KB
|
485 lines
QUICK HELP SESSION FOR OS2TREE
FIRST DRAFT 1.00b
OS2TREE is a UTILITY for Managing and Traversing your HARD DISKS.
To EXIT from anywhere in OS2TREE,
TYPE <ESC> or <F3>.
DOCUMENT CONVENTIONS
This document describes the most commonly used features of OS2TREE.
All commands are activated by a single keystroke or mouse button.
The default keys are described, but any command can be assigned to
any key by changing the OS2TREE definitions file, OS2TREE.DEF. See
the OS2TREE DEFINITIONS FILE document for information on changing
the definitions file.
In this document, a string enclosed in angle brackets (<>)
represents a keyboard key. A single character in angle brackets
refers to that character's key, for example <L> for the letter 'L'.
<F1> through <F12> are the function keys.
<UP>, <DOWN>, <LEFT> and <RIGHT> are the cursor movement keys.
A key name preceded by 'A-' means press the 'ALT' key and the
specified key. For example, <A-F1> is ALT+F1.
A key name preceded by 'C-' means press the 'CTRL' key and the
specified key.
All commands are case insensitive. Either the lower-case or
upper-case key for a command can be used.
Many commands will prompt you for input. In most prompt fields,
the cursor keys can be used to look at previous inputs, as done
at the OS/2 prompt. Moreover, a complete pop-up list of previous
inputs can be generated by pressing <C-W>.
1. TRAVERSING THE DIRECTORY TREE
You can move about in the tree using either the keyboard or the
mouse. The cursor keys can be used to move up, down, left and
right. The <PAGE_UP> and <PAGE_DOWN> keys will page up and down
in the tree. The <HOME> and <END> keys move to the top or bottom
of the current tree. The display will automatically scroll when
necessary. Pressing <LEFT> at the leftmost directory will wrap
to the rightmost directory and vice versa.
To quickly find a desired directory, press the </> key. You will
be prompted for the directory name. Enter the name and press
<ENTER>. OS2TREE will move to the first occurance of the directory
specified. Pressing <C-F> will continue the search to the next
occurance of the name.
To Move to a directory using the mouse, place the mouse pointer
over the desired directory and click the left button. Clicking
the left button when the pointer is in the first column of the the
screen will cause the cursor to move to the left, scrolling if
necessary. Clicking the left button when the pointer is in the
last column will move the cursor to the right. The right mouse
button will cause movement in the opposite direction.
Clicking the left button above the tree will cause the tree to
scroll up. Clicking the left button below the tree will cause
the tree to scroll down.
2. DIRECTORY LIST
To list the files of a directory, first move to the directory using
the cursor keys or the mouse. Pressing <L> will generate a list of
files in that directory.
To list files using the mouse, place the pointer over the desired
directory and double click the left button.
Pressing the <ENTER> key will display a full screen list of the
directory. This list matches the pop-up list, but contains additional
information about upload/download capabilities from a mainframe.
Pressing <ENTER> again will return to the pop-up list.
To limit the scope of the directory listing, the file
specification can be changed. The default file spec is
"*.*". To change the file spec, press the <F> key. This will
prompt you for a new file spec.
To change the type of files shown in the directory listing, the
file list options can be changed. The default file list options
are:
READ-ONLY FILES NO
HIDDEN FILES NO
SYSTEM FILES NO
DIRECTORY FILES NO
ARCHIVE FILES YES
EXCLUSIVE HIDDEN FILES NO
EXCLUSIVE READ-ONLY FILES NO
To change the file list options, press the <F2> key. This will
display a pop-up list of the above options. Move the cursor up and
down using the cursor keys or the mouse. The value of each file
list option can be toggled by pressing the space bar or double
clicking the left mouse button.
3. USING THE DIRECTORY LIST OF FILES
The directory file list can be used for printing, copying, deleting
or editing files. Commands can be performed on individual files or
on a set of marked files.
The <UP> and <DOWN> keys can be used to move about in the list.
In addition, if the mouse pointer is placed on the arrow heads of
the scroll bar on the right side of the list and the left button
is clicked the list will scroll up or down correspondingly. The
scroll bar is only displayed when the list contains more files than
can be displayed at one time.
To MARK/UNMARK a file in the list, move to the file by
using the cursor keys or the mouse and press the <SPACE> bar. The
current file will be marked, signified by changing the color of the
file name, and the file list header will be changed to reflect the
number of marked files. If the file was already marked, it will be
unmarked.
Using the mouse, click with the left button to select a file, double
click with the left button to mark or unmark a file.
The key <A-A> will mark all files in the list. Pressing <A-A>
again will toggle between marking and unmarking all files.
All of the basic commands operate on either a single file or a
group of marked files.
Below are some examples:
SINGLE FILE MARKED FILES
COPY <C> <A-C>
MOVE <M> <A-M>
DELETE <D> <A-D>
RENAME <R> <A-R>
PRINT <P> <A-P>
EDIT <E> <A-E>
VIEW <V> <A-V>
EXECUTE <V> <A-V>
Type <?> for a list of all available functions.
For example,
</> is called FIND in the pop-up list.
<C> is called COPY FILE.
<D> is called DELETE FILE.
<A-C> is called COPY MARKED FILES.
To refresh the list of files, type <F10>. This will result in a
new up-to-date listing of the current directory to be generated.
By default, the list is sorted by file name and extension. To
sort the list differently, type <A-S>. This will pop-up a sort
prompt. The first request is the order of the sort. The default
is always displayed along with the current status. Typing a '*'
will automatically reset the sort to the default settings.
4. MANIPULATING THE TREE,
OS2TREE allows you to easily insert, delete and rename
directories, copy or move entire subtrees, and collapse or expand
portions of the directory tree display.
The following keys are used for tree functions:
<INS> - INSERT a new directory.
<DEL> - DELETE a directory.
<A-C> - COPY a directory or subtree.
<A-M> - MOVE a directory or subtree.
<C-DEL> - COLLAPSE directory, i.e., remove all subdirectories
from the tree display. A '+' will be placed
before the directory name to denote that
there are directories under this directory
that are not show.
<C-INS> - EXPAND all directories under the current directory.
The RIGHT MOUSE BUTTON will toggle between the EXPAND and COLLAPSE
states. If the directory is currently collapsed, it will be expanded,
if it is currently expanded, it will be collapsed.
To rebuild the entire tree display, type <F12>. You can also use <F11>
to build the trees for your hard disks but not the floppy disks.
<C-F12> will build the tree for the current disk only, and <F10>
refresh the display with a saved tree display. You can use <C-F12>
to make a tree of a floppy and then use <F10> to quickly restore
the full display of all drives.
Additionally, their is a field in the CUSTOM OPTIONS pop-up
(see item #9) that allows customization of the entire tree build process.
maketree_exclusion_list = "[d:],[E:]"
This variable determines which directories in the system to ignore
or only build a main root directory tree.
"[x:]" - says to only build the main root directory tree,
and is very useful for large lan disks.
"[X:]" - says to ignore this disk completely.
5. CUSTOM TODO LISTS,
OS2TREE allows you to create two lists of up to 50 items that map
to indivdual files.
OS2TREE defaults this option to contain five basic examples. The
purpose of this feature is to allow the user to maintain two to-do
lists, i.e., personal and work, which are nothing more then lists of
files, with meaningful names.
examples: VERY IMPORTANT MATTERS ---> C:\WORK\#very.nte
IMPORTANT DATES ---> C:\PERSONAL\dates
You can select an entry in the list and edit the corresponding
file. Each todo list can have up to 50 items in it. To get todo
list 1, press <C-X>. To get todo list 2, press <C-G>. Remember,
if you do not like these key assignments, you can define these
functions to any key you would like. You can also type '?' and
pick the "TODO LIST" feature from the list.
Once the TODO list pop-up is displayed, you can insert, delete and
rename entries by pressing <INS> to insert, <DEL> to delete, and
<R> to rename.
Note: When entering the file name for a corresponding TODO list
item, it is important to ONLY INCLUDE A PATH if you do not
wish to use the default TODO path. In the CUSTOM OPTIONS
pop-up (see item #9), three fields exist for each TODO list.
Note: TODO LIST ONE is referred to as todo_list.
TODO LIST TWO is referred to as generic_list.
todo_list_title , generic_list_title
todo_list_trailer , generic_list_trailer
todo_file_directory , generic_file_directory
If the filename contains a path, the default todo file directory
is ignored. If the filename does not contain a path, the todo
file directory is inserted.
Ex. todo_file_directory = "C:\\GENERAL"
If the filename entered is: "#WORK", the filename becomes:
"C:\\GENERAL\#WORK".
If the filename entered is: "C:\\#WORK", the file name
remains as "C:\\#WORK".
Please note that you must enter a '\' character before any
special character (as in the C language). Another commonly
used special character is ", entered as '\"'.
ex. todo_list_title = " MY \"CUSTOM\" TODO LIST"
would yield a title looking like:
MY "CUSTOM" TODO LIST
The other two fields are used in the TODO pop-up as the TITLE
and the TRAILER of the POP-UP. This allows the user to name
each TODO pop-up and determine the bottom information line.
The defaults include the default key assignments.
6. FILE SEARCH FACILITY.
OS2TREE allows you to search a sub-tree, a single disk, or your
entire system for all files matching a given file spec.
Press <A-X>. At the prompt, enter the desired search file spec.
For example, use "*.CMD" to search for all OS/2 command files.
At the next prompt press <N> to search only the current sub-tree,
<Y> to search all system disks. After the Y or N response, OS2TREE
will graphically scan the selected tree structure and inform you
of how many matches have been found and how far the search has
progressed. Typing 'ESC' at anytime will end the search.
Typing any key will stop the search and display a list of files
found up to that point. When the search is completed, it will
display a list of all the files that matched the filespec.
This list is the same as a list generated by typing the <L>
key, except that it contains files from many different
directories. As you curse down the list, you will notice that
the corresponding path to each file is displayed at the top of
the pop-up. This list can be manipulated in the same fashion
as the <L> list. Files can be copied, deleted, printed, etc.
Additionally, there is a field in the CUSTOM OPTIONS pop-up
(see item #9) that allows customization of the search directories:
showall_disk_exclusion_list = "[VM],[A:],[B:]"
This variable determines which directories in the system to ignore
when searching for files in the tree.
"[X:]" - says to ignore this disk completely.
Please note that "[VM]" is a special case representing a disk
on a VM mainframe system.
7. CUSTOM PRINT AND FORMATTING FACILITY
Press <A-F>. in a file list to display the CUSTOM
FORMATTING pop-up. Pick one of the formatting options and follow
the directions.
Please note, at this time, the custom formatter is unable to handle
enbedded printer sequences. This feature will be added in future
releases. The most popular use of this feature is the DUAL PAGE
PRINTING CAPABILITY.
8. QUICK HELP
For QUICK HELP, press <A-F1> or the left mouse mouse button. A
help pop-up will appear. This pop-up contains the basic commands
for OS2TREE. The help pop-up is completely customizable
by using the CUSTOM OPTIONS pop-up (see item #9).
9. MODIFY OS2TREE VARIABLES - CUSTOM OPTIONS POP-UP
To modify an OS2TREE variable, press <C-O>. A pop-up
list of every variable used in OS2TREE and its current value will
be displayed. The variables are described in the OS2TDEF.DOC file
included with the documentation. To change a variable, move the
cursor or mouse to the desired field and type <ENTER>. A prompt
will appear with the current variable value prefilled. Type over
the current value and press <ENTER>. This feature can also be
selected from the WINDOW OPTIONS pop-up (<C-W>) or the COMMANDS
pop-up (<?>).
10. MODIFY SCREEN COLORS
To modify the screen colors, type <F9>. A pop-up with
every color field used in OS2TREE and its current color will be
displayed. The color fields are described in the OS2TDEF.DOC file
included with the documentation. To change a color field, move the
cursor or mouse to the desired field and type <ENTER>. A pop-up of
all available colors will appear. Pick the desired color and type
<ENTER>. This feature can also be selected from the WINDOW OPTIONS
POP-UP ('CONTROL' & 'W') or the COMMANDS POP-UP ('?').
11. MAINFRAME SUPPORT
A list of mainframe files can be obtained by performing the list
function (<L> or double click left mouse button) on the MAINFRAME
directory in the tree display. OS2TREE stores the list of
mainframe files on the workstation to speed displaying the list;
you will be asked whether you want the list to be refreshed. If
you answer 'Y', a fresh file list will be downloaded from the
mainframe and displayed in an OS2TREE list window.
These files can be processed just like workstation files:
<D> - will delete the file on the MAINFRAME.
<A-D> - will delete marked files on the MAINFRAME.
<R> - will rename the file on the MAINFRAME.
<A-R> - will rename marked files on the MAINFRAME.
<U> - will DOWNLOAD the file to the workstation. <U> also can
be used to upload a file from a workstation file
list,
<A-U> - will DOWNLOAD/UPLOAD marked files.
ONE OF THE SPECIAL UPLOAD/DOWNLOAD FEATURES is automatic
type conversion, ie. all EXE files are named EXEBIN for
example and visa versa. This is accomplished by defining
the type conversions in the OS2TREE.DEF file that OS2TREE
generates for you on INSTALLATION.
Some examples:
trans_ext "EXE" "EXEBIN" 1
trans_ext "OBJ" "OBJBIN" 1
trans_ext "PMP" "PMPBIN" 1
trans_ext "SCR" "SCRIPT" 0
trans_ext "BRO" "BROWSE" 0
** The first example tells OS2TREE to convert all WORKSTATION
*.EXE files to * EXEBIN when UPLOADING and convert all
MAINFRAME * EXEBIN files to *.EXE when DOWNLOADING. It
also tells OS2TREE to perform the UPLOAD and DOWNLOAD
processes using the BINARY option. If the last parm is
1 - BINARY mode is used, if 0 - ASCII mode is used.
PLEASE NOTE, in order for this feature to work, several OS2TREE variables
must be correctly set in the OS2TREE OPTIONS pop-up (<C-O>).
The system is defaulted to a simple VM SYSTEM. Please see the OS2TDEF.DOC
or call for detailed instructions.
12. ADDITIONAL MOUSE SUPPORT FEATURES
In future releases, the mouse buttons will be fully programmable.
Currently they are fixed as described above. In addition to
the above mouse functions, the following also exist:
All selections below refer to the use of the left mouse button:
Select the word 'QUIT' in the box at the bottom of the screen
and OS2TREE will exit from what ever mode it is in (same as
<F3> key).
Select the word 'HELP' in the box at the bottom of the screen
and OS2TREE will display CUSTOM HELP pop-up (same as <A-F1>).
Select the word 'COMMANDS' in the box at the bottom of the
screen and OS2TREE will display COMMANDS pop-up (same as <?>).
Select a letter from the OS2TREE INFO: string in the BOX at the
bottom of the screen and OS2TREE will execute that letter as
though that key was pressed. E.g., if you select L, the key <L>
will be processed and a list of files will be displayed.
QUICK REVIEW
<F1> - GENERIC HELP for OS2TREE.
<F3> - ESCAPE or EXIT.
<ESC> - ESCAPE or EXIT.
<A-F1> - POP-UP LIST of user customized HELP
<?> - POP-UP LIST of all available FUNCTIONS
<A-X> - FILE SEARCH FACILITY
<C-X> - POP-UP TODO LIST 1
<C-G> - POP-UP TODO LIST 2
<C-O> - POP-UP LIST of all customizable fields
<C-W> - POP-UP LIST of general functions
<UP>, <DOWN>, <LEFT>, <RIGHT>, <PAGEUP>, <PAGEDOWN>, <END>
and <HOME> - move around the TREE and POP-UP LISTS.
<L> - LIST DIRECTORY FILES
<R> - RENAME A TREE DIRECTORY
<F2> - CHANGE FILE LIST OPTIONS (readonly, hidden, etc.)
<F> - CHANGE THE FILESPEC
</> - FIND A DIRECTORY or FILE
<C-F> - REPEAT FIND A DIRECTORY or FILE.
<A-S> - CHANGE THE SORT ORDER
<INS> - INSERT A NEW TREE DIRECTORY
<DEL> - DELETE AN EXISTING TREE DIRECTORY
<C-DEL> - COLLAPSE DIRECTORY TREE
<C-INS> - EXPAND COLLAPSED DIRECTORY TREE
<SPACE> - MARK and UNMARK files
<ENTER> - FULL SCREEN FILE LIST
<F12> - GENERATE NEW TREE STRUCTURE
<C> - COPY FILE
<M> - MOVE FILE
<D> - DELETE FILE
<R> - RENAME FILE
<P> - PRINT FILE
<E> - EDIT FILE
<V> - VIEW FILE
<U> - UPLOAD/DOWNLOAD FILE
<F10> - REFRESH FILE LIST
PROGRAM OPTIONS
-xx number of rows {ex. 43 = 43 line mode}
-w number of columns
-~ sets first_time_in and fl_lan_check flags OFF
-+ sets trace_flag ON
-= sets trace_flag ON and trace_thread_flag ON
-(a or A) update OS2TREE tree (HARDDISKS & 'A' Drive)
-(b or B) update OS2TREE tree (HARDDISKS & 'B' Drive)
-(c or C) update OS2TREE tree (CURRENT DRIVE ONLY)
-(d or D) force to FULL SCREEN LIST MODE
-(i or I) set auto_setup flag=YES
-(m or M) set auto_mfmaint flag=YES
-(l or L) use last directory OS2TREE was in
-(n or N) set new_pc_list, mf_refresh_flag & ask_new_mf_list flags ON
-(p or P) set session priority to MAX: (3,+31)
-(q or Q) set query flag=YES
-(s or S) Suppresse dates reminder
-(r or R) set display_tree_roots_only=YES (only roots in tree)
-(t or T) force to TREE STRUCTURE MODE
-(u or U) set update_keys_def flag=YES
-(v or V) force to FULL SCREEN LIST MODE (MAINFRAME MODE)
-(z or Z) update OS2TREE tree (HARD DISKS INCLUDING LAN DISKS)
-(# or *) update OS2TREE tree (LOCAL HARD DISKS ONLY - NO LAN DISKS)