home *** CD-ROM | disk | FTP | other *** search
/ Hall of Fame / HallofFameCDROM.cdr / australi / branch98.lzh / BRANCH.HLP < prev   
Text File  |  1990-02-19  |  17KB  |  442 lines
  1. BRANCH Version 0.983545
  2.  
  3. BRANCH is the ultimate in hard disk directory
  4. management currently available in the Public Domain
  5. Libaries. This program was inspired by the high cost
  6. of commercial software. Of course, this is an
  7. Australian produced computer software. It is a Public
  8. Domain software program, and normal Public Domain
  9. rules apply.  The programmer would like to thank all
  10. involved in this project.
  11.  
  12. Most functions of the program is fairly self-
  13. explanatory. This help screen is available to provide
  14. information and instructions regrading the use of
  15. BRANCH.
  16.  
  17. Basics of using BRANCH
  18.  
  19. A pull-down menu has been is use in BRANCH to make it
  20. easy to operate. Most of the functions in BRANCH are
  21. accessible from the pull-down menu. To activate a
  22. pull-down menu, press the first letter of the item on
  23. the top menu bar. Use the cursor keys to move about in
  24. the menu area.
  25.  
  26. Function Keys
  27.  
  28. F2   Change Drive, it only works when viewing the
  29.      directory tree.
  30.  
  31. F3   Execute a single line of DOS command.
  32.  
  33. F8   Configure BRANCH to suit your needs. Allows you
  34.      to select you favourite text-editor, and many
  35.      other available options .
  36.  
  37. F9   Switches between 43/50 lines and 25 lines mode
  38.      if you are using a EGA/VGA display.
  39.  
  40.      F10  Allow for temporary exit to DOS by executing a
  41.           DOS shell, type `exit' to return to BRANCH
  42.  
  43.  
  44. *    The Directory Tree
  45.      When look at the directory tree structure of you
  46.      drive, use the cursor keys to move up and down the
  47.      tree. To Enter a directory, just position the cursor
  48.      on that directory and press <ENTER>.
  49.  
  50.      There also several functions associated with
  51.      directories available from the 'Dir' Menu. You can
  52.      also logged by to another drive by choosing 'Log Disk'
  53.      from the Menu.
  54.      The File Display
  55.  
  56.      This display the files in the directory. When looking
  57.      at the files, use the cursor keys to move around in
  58.      the file area. The file are display just like they are
  59.      when you use 'DIR' from DOS. In addition, the file
  60.      attribue is also shown, so are all hidden files.
  61.  
  62.      To select (tag) a file, press the space bar.  Another
  63.      way would be to go to the TAG menu.  Selected files
  64.      are differentiated by a pointer on the left of the
  65.      filename. The file(s) will still be tagged even if you
  66.      accidentally (or intentionally) go to the the tree
  67.      diagram.
  68.  
  69.      There are 3 ways to view a file, as a text file, a hex
  70.      dump, as *.GIF graphics file or as a *.LZH archive
  71.      file.
  72.      To view a GIF file, an external GIF viewer is needed.
  73.      Place the GIF viewer in anywhere on your hard drive
  74.      and use the Configure option to enter the full path
  75.      name of your chosen GIF viewer. When the cursor is at
  76.      a GIF file, simply press ENTER to see the file.
  77.  
  78.      If the cursor is position on a LZH file. Its contents
  79.      will be shown. Refer to the Archiving Section for more
  80.      information.
  81.  
  82. *    Changing File Attribute
  83.  
  84.      To change the file attributes of a single file or a
  85.      group of files, tag them first and then choose Change
  86.      Attrib from the File menu.
  87.  
  88.      Press the keys H,S,R,A to toggle a particular
  89.      attribute on or off.  Pressing `Enter' will change the
  90.      attribute of all the tagged files. Press `ESC' to
  91.      abort.
  92.  
  93.  *   View File
  94.      To view a file, move the cursor to that file and then
  95.      choose View File from the File Menu. There are two
  96.      ways of viewing a file, as a binary file or a text
  97.      file. BRANCH automatically attemps to check if a file
  98.      is a text file or a binary file and invoked the
  99.      corresponding viewer.
  100.  
  101.  *   Viewing Binary File
  102.  
  103.      A hex-editor is also included. Use the cursor keys to
  104.      move the cursor to the required position. Typing
  105.      anything on the keyboard will replace the character
  106.      under the cursor. Items that have been modified will
  107.      be shown in a different colour.
  108.  
  109.      Key             Effects
  110.      ----------------------------------------------------------
  111.      ESC   Quit viewing.
  112.      TAB   switches you between HEX and ASCII mode.
  113.      F2    brings you to the block number you specify.
  114.      F3    lets you find a single or group of characters,
  115.            starting from the cursor and working downwards.
  116.            Only available for the characters on the
  117.            keyboard.
  118.      F4    searches for the next string of text as
  119.            specified in F3. Saves you typing it in again.
  120.      F5    writes current block to disk. If you wish to
  121.            abort, get out by ESCaping before you press F5.
  122.            This will revert the block to its last save.
  123.      F6    lets you switch to viewing a text file, much
  124.            like a word processor.
  125.      F8    Lets you highlight a particular HEX/ASCII byte
  126.            without doing anything to it.
  127.      PgUp/PgDn Move the next/previous block.
  128.  
  129.  
  130.  *   Viewing Text File
  131.      When viewing a text file, use the Up-arrow/Dn-Arrow to
  132.      scroll through the file. The moving scroll bar at the
  133.      right hand side of the screen shows you roughly which
  134.      part of the file you're in.
  135.  
  136.  *   Renaming File
  137.  
  138.      Use the function to rename files. The files must be
  139.      tagged first before they can be renamed.
  140.  
  141.      eg. renaming *aaa.* to *bbb.*
  142.             will rename all files with names ending with
  143.             aaa to files with names ending with bbb
  144.             regardless.
  145.  
  146.          renaming *.aaa to *.bbb
  147.             will rename all files with extension aaa to
  148.             file with extension bbb.
  149.  
  150.  *    Copying Files
  151.  
  152.       This function allows copying of files from one
  153.       directory to another. When copying files to floppy, if
  154.       the floppy disk is full, BRANCH will prompt for the
  155.       next disk.
  156.  
  157.       Using Copy:
  158.           After tagging files to be copied, chose this
  159.           option.  It will prompt for the drive and path to
  160.           be copied to.  If the subdirectory is not there,
  161.           it will create whatever is missing from the path
  162.           automatically and then copy the tagged files over.
  163.  
  164.       Using Xcopy:
  165.           Same as above but also copies the directory
  166.           structrue of source disk. Can only xcopy to a
  167.           different drive.
  168.  
  169.  *    Backup Tag Directories
  170.  
  171.       Copy all the files in the tagged directories to
  172.       another drive while maintaining the directory
  173.       structure.  Only tagged directories can be backup.
  174.       When the target floppy disk is full, please insert
  175.       next disk. If the target hard disk is full, please get
  176.       a bigger one.
  177.  
  178.  *    Changing Drive
  179.  
  180.       To change drive, select Change Drive from the Log Disk
  181.       Menu or press the F2 key.
  182.  
  183.       To change from the current drive to a new one. If it
  184.       is a floppy drive, BRANCH will automatically relog it
  185.       every time it changes into the drive. If it is a hard
  186.       disk, the old drive's directory structure if shown if
  187.       it has already been logged, otherwise it will log it
  188.       and store the information for later use.
  189.  
  190.       If you use Relog Drive, the drive will be re-read
  191.       regardless. This is useful in the directory tree
  192.       represented a drive is out-dated. Possibly cause by
  193.       the creation/removal of directories when you shell to
  194.       DOS or run another program from within BRANCH.
  195.  
  196.       Two other keys + and - can also be use to change
  197.       drive. Pressing '+' simply go the the next drive while
  198.       '-' select the previous drive.
  199.  
  200.       Change drive only works when in the directory tree
  201.       area.  Does not work when looking at files.
  202.       Run Another Program / Shelling to DOS
  203.  
  204.       To run a file from inside BRANCH, Move the cursor to
  205.       the desired file and activate this function. You will
  206.       be asked to enter the parameters for the program.
  207.       After the program has finished, it will bring you back
  208.       to where you left off. BRANCH will still reserve about
  209.       67K of memory when runing another program. If there
  210.       isn't enough memory for your program, then exit branch
  211.       first.
  212.  
  213.       To shell to DOS, press F10. Similar to executing
  214.       another program, some memory will be reserved by
  215.       BRANCH. When in DOS, type "EXIT" to get back to
  216.       BRANCH. To execute only a single DOS command, use F3
  217.       (DOS command) instead.
  218.  
  219.  *    File Archiving
  220.  
  221.       A file archiving utility has been provided by Branch,
  222.       using LZSS and Adaptive Huffman Coding technique, the
  223.       same as the file format for Lharc (*.LZH files).
  224.  
  225.       Special thanks goes to Haruhiko Okumura and Haruyasu
  226.       Yoshizaki for their work on Lharc. BRANCH always
  227.       compress files to smaller or equal size compare to
  228.       Lharc 1.13. The compression routine in BRANCH is
  229.       optimised to always produce the smallest possible
  230.       file using the LZSS and Adaptive Huffman Coding.
  231.  
  232.       When compression binary files and graphics file
  233.       (*.PIC, *.MAC), using BRANCH usually results in
  234.       smaller file than using PKZIP 1.01. Text files are
  235.       usually better handled by PKZIP.
  236.  
  237.  *    Pack File
  238.       First, tag the files you want to be compressed, then
  239.       select Pack-File form the File menu. Enter the name
  240.       of the archive file, eg. MYDATA.LZH. All tagged
  241.       files will be compressed into the file MYDATA.LZH.
  242.       This is the same as the 'a' option in Lharc.
  243.  
  244.  *    Unpack File
  245.       Use this option to expand the archive file to their
  246.       orginal files. Same as the 'e' option in Lharc.
  247.  
  248.  *    Viewing LZH file
  249.       This is same as the 'v' option in Lharc. First move
  250.       the cursor to the specific LZH file and press
  251.       <ENTER>, the archived file information will be
  252.       shown.
  253.  
  254.  *    Functions available from the Dir Menu.
  255.  
  256.       Backup Directory:
  257.             Explained elsewhere.
  258.  
  259.       Create Directory:
  260.             To create a new (sub)directory, use the cursor
  261.             keys to highlight the (sub)directory you want
  262.             the new (sub)directory to be linked to, activate
  263.             this command and type in the new
  264.             (sub)directory's name. Unlike the MKDIR/MD
  265.             command in DOS, you can entered any path name to
  266.             be created.
  267.                 Example:  "C:\AAA\BBB\CCC\DDD\EEE"
  268.                           "..\CCC\GGG\LLL"
  269.  
  270.       Erase Directory:
  271.             erases a directory only if it is empty.
  272.       Hide/Unhide Directory:
  273.             allows the user to hide or unhide a directory.
  274.             When a directory is hidden it doesn't show up
  275.             using the `DIR' command from DOS.
  276.  
  277.       Rename Directory:
  278.             Change the name of a directory.
  279.  
  280.       Relog Directory:
  281.             Relogs the directory at the cursor only.
  282.  
  283.       Functions available from File Menu. These functions
  284.       mainly relate to file operations.
  285.  
  286.       Copy:   Explained elsewhere.
  287.       Erase:  Deletes all tagged files.
  288.       Change Attributes:   Explained elsewhere.
  289.       View:   Explained elsewhere.
  290.       Rename: Explained elsewhere.
  291.       Run:    Explained elsewhere.
  292.       Xcopy:  Copies file, but keeps directory structure
  293.               as well. Can only be copied to a different
  294.               drive.
  295.       Text Editor:  execute an external editor the edit
  296.              the file at the cursor. use F8 (Configure) to
  297.              choose you own external editor.
  298.       Pack:   Explained elsewhere
  299.       Unpack: Explained elsewhere
  300.  
  301.       Sorting Files
  302.  
  303.       The files being displayed can be sorted in several
  304.       different ways.
  305.  
  306.       Extension:  sorts by extension.
  307.       Date/Time:  sorts by date and time.
  308.       Name:       sorts by filename.
  309.       Size:       sorts by size.
  310.       Un-sort:    restore to orginal order
  311.       Reverse:    re-sorts the file in reverse order.
  312.  
  313.       Tagging Files or Directories
  314.  
  315.       SPACE-BAR:
  316.            Tags the file or directory at the cursor bar and
  317.            advance the cursor to the next item.
  318.  
  319.       Global:  Tags all files in directory.
  320.       Clear:   Untags all tagged files.
  321.       Invert:  Tagged files become untagged and vise
  322.                  versa.
  323.  
  324.       Tag Selected:
  325.             Tags files with similar names or extensions.
  326.  
  327.             eg. using `*.EXE' will tag all files with
  328.                 extensiion `EXE'.
  329.  
  330.       Untag Selected:
  331.             Same as above but untages the matching files.
  332.  
  333.       Configure BRANCH
  334.  
  335.       There are several options that can be configure by the
  336.       user. Use the up/down cursor keys to move the "-->"
  337.       to the item you want to configure and press "ENTER".
  338.  
  339.       Change Colours
  340.       Since everyone has different preference for screen
  341.       colours, you can choose you own colour combinations.
  342.       use the 4 cursor keys to change to a different colour,
  343.       and the PgUp/PgDn keys to select colours for dirrerent
  344.       fields.
  345.  
  346.       Change Colour Palette
  347.       This is available in the presence of EGA/VGA display.
  348.       There's a choice of 16 colours out of a possible 64
  349.       colours. Use the Up/Down cursor to move to the
  350.       particular you wish to modify, then use the PgDn/PgUp
  351.       keys to change the palette colour. If you do modify
  352.       the colour palette, BRANCH will revert to the original
  353.       default palette when you run another program, shell to
  354.       DOS or exit from BRANCH.
  355.  
  356.       External Editors
  357.       Press "Enter" and type in the path name of you
  358.       favourite text editor.
  359.  
  360.       External Gif Viewer
  361.       Choose your GIF viewer to view GIF files from within
  362.       BRANCH.
  363.  
  364.       Screen Blanker
  365.       Use this option if you want BRANCH to black out the
  366.       screen when there's no keyboard activity for a
  367.       specified duration. Enter the number of seconds you
  368.       want to wait before the screen blanks out. A value of
  369.       "0" indicates no screen blanker. Note: if you set the
  370.       black colour to some other colour (using change
  371.       palette) then the screen will not be black when
  372.       blanked.
  373.  
  374.       Data Entries
  375.       Selet the amount of memory BRANCH will use to store
  376.       directory/file entries. Press Enter to type in a
  377.       value between 300 and 2700. The new value you
  378.       specified for the data entries will take effect the
  379.       next time you run BRANCH.  Note that you must allocate
  380.       at least more entries than the maxinum number of
  381.       directories in a drive plus the maxinum number of
  382.       files in one directories.
  383.  
  384.       When you've finished the modifications, press ESC.
  385.  
  386.       Technical Information
  387.  
  388.       This program is the result of weeks of hard work by
  389.       James Chao. The entire program is written in Borland's
  390.       Turbo Pascal Version 5.5 (with OOPS), consisting more
  391.       than 8000 lines of PASCAL code. The archiving routine
  392.       is written in 8086 assembley (about 1000 lines), and
  393.       compiled using Borland's Turbo Assembler version 1.0.
  394.  
  395.       The aim of of BRANCH is to make it easy to use,
  396.       therefore the entire program occupies only a single
  397.       file BRANCH.EXE. The same cannot be said for many
  398.       other MS-DOS programs which are spread over several
  399.       files.  This Help screen is always on hand when
  400.       pressing F1.
  401.  
  402.       Branch can only be run from a hard disk.  It uses an
  403.       overlay manager to reduce memory overhead.  When you
  404.       shell to DOS or run another program, BRANCH still
  405.       occupies some memory (depending on the number of data
  406.       entries you choose).  BRANCH is not a TSR program,
  407.  
  408.       Like many other Hard Disk Utilities, a limit exists on
  409.       the size of the data. A data entry can be either a
  410.       file entry or a directory entry. Branch only works if
  411.       the total number of directory on a drive plus the
  412.       number of files in you biggest directory (the one with
  413.       the most files) is less than the number of data
  414.       entries specified in the Configure option.
  415.  
  416.       As long as the above condition is fulfilled branch
  417.       will work, even if you have 10000000 files on your
  418.       disk. If you enter a directory, all the files entry
  419.       are read into memory. A LSU (least recently use)
  420.       algorithm is used to decide which files entry should
  421.       be left in memory if you have more than 600 files. If
  422.       you have more than 600 files in one of you directory,
  423.       then you have to start removeing them or move some of
  424.       them to another directory.
  425.  
  426.       Your Wish Lists
  427.  
  428.       Since Branch is a public domain program, please DO
  429.       sent in your wish list for additional features you
  430.       wanted in BRANCH. If you discovered any bugs or
  431.       problem, please sent a message to James Chao.
  432.       Your help and support will be very much appreciated.
  433.       The programmer can be contacted via:
  434.  
  435.                           James Chao
  436.                           P.O. Box 3201
  437.                           Parramatta
  438.                           NSW 2150
  439.                           Australia
  440.  
  441.                 << *** End of Help Screen *** >>
  442.