home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 54 / af054sub.adf / DTree.lha / DTree / DTree.doc < prev    next >
Text File  |  1993-08-26  |  6KB  |  155 lines
  1.  
  2.              =======================================
  3.              DTree v1.00 -- Directory Tree Displayer
  4.                             Documentation
  5.                           - July 8, 1993 -
  6.              =======================================
  7.  
  8.  
  9.         Copyright (c) 1993 by Sam Yee.  All Rights Reserved.
  10.  
  11.  
  12. ======================================================================
  13. COPYRIGHT
  14. =========
  15.  
  16. The  program,  DTree and its documentation are written and copyrighted
  17. by  Sam  Yee.  DTree may be distributed freely providing the following
  18. restrictions are satisfied:
  19.  
  20. o Distributors may not charge more than the cost of a diskette used in
  21.   the distribution of this program.
  22.  
  23. o Distributors may only distribute the unmodified copy of the original
  24.   program, along with its documentation, and copyright notices intact.
  25.  
  26. o Commercial  distribution  is  only  possible with written permission
  27.   from the author.
  28.  
  29. The  font  "IBM" is not copyrighted by me.  I found it somewhere, as a
  30. freely  distributable file, and it doesn't say who created it.  I hope
  31. the owner, whoever he or she is, don't mind for the inclusion of it in
  32. this  archive.   I  would  like  to  thank  the  creator  for  his/her
  33. contribution.
  34.  
  35.  
  36. ======================================================================
  37. DISCLAIMER
  38. ==========
  39.  
  40. This   program  and  its  documentation  are  provided  "as  is".   No
  41. warranties  are  made  with  respect  to  the  accuracy,  reliability,
  42. performance  or  operation  of this software and information.  You are
  43. using this program at your own risk.  The author is not liable for any
  44. damages that may have been caused by using this software.
  45.  
  46.  
  47. ======================================================================
  48. INTRODUCTION
  49. ============
  50.  
  51. If  you  have  used IBM(r) PCs, you have probably used the DOS command
  52. "tree".   And,  you thought to yourself, I want something like this on
  53. my  Amiga.  I was in the same situation.  I've searched everywhere and
  54. couldn't  find  something that works like the one in DOS.  The closest
  55. directory tree program I've found is one which opens a screen and then
  56. displays  the  trees.   This  is  no  good  for  me, as it doesn't use
  57. standard  input  and output.  Standard i/o makes many things possible,
  58. like  piping, i/o redirecion, etc.  So, I wrote an almost functionally
  59. equivalent  version  for  the Amiga.  For the lack of a better name, I
  60. call  it "DTree", D for Directory, and well you know the rest.  Unlike
  61. tree  from  DOS, DTree allows ANSI color and the ability to change the
  62. characters  that  are  used to formulate the connection of directories
  63. and files to its parent.
  64.  
  65.  
  66. ======================================================================
  67. REQUIREMENTS
  68. ============
  69.  
  70. This  program  runs  on  any Amiga(tm) with version 2.04 of the OS, or
  71. higher.
  72.  
  73.  
  74. ======================================================================
  75. INSTALLATION
  76. ============
  77.  
  78. You should copy DTree into C:  or wherever your commands are.  To make
  79. the  branch  connection from child directories and files to its parent
  80. more  neatly,  copy the included IBM(r) font (ie., "copy ibm#?  fonts:
  81. all  clone")  into  your  fonts:   directory.   Use SYS:Prefs/Font and
  82. change  the "System Default Text" font.  C:SetFont also works too.  By
  83. default, DTree will use standard ASCII characters.
  84.  
  85.  
  86. ======================================================================
  87. USAGE
  88. =====
  89.  
  90. DTree  must  be  run  from  the  Shell  or  CLI.   If  you run it from
  91. Workbench,  The  system  might  crash!  DTree uses a standard AmigaDOS
  92. command          template.           The          template          is
  93. "DIR/M,FILES/S,IBMFONT/S,JOINCHARS/K,COLOR/S".  "DTree ?" will display
  94. the  template,  and  then you'll be able to enter the arguments at the
  95. prompt.  Each argument are described as:
  96.  
  97. DIR/M
  98.     This optional keyword allows you to display the directory trees of
  99.     many directories.  By default, the current directory is used.
  100.  
  101.     Example: "DTree DIR SYS: WORK:" or "DTree SYS: WORK:"
  102.  
  103.  
  104. FILES/S
  105.     If this keyword is present, the files, as well as the directories,
  106.     will  be  displayed.    In  a  directory,  all  subdirectories are
  107.     displayed first, followed by the files, in sorted order.
  108.  
  109.     Example: "DTree FILES SYS:"
  110.  
  111. IBMFONT/S
  112.     If  this  keyword  is  present,  the  branch  connections  will be
  113.     displayed  with IBM extend characters.   This is by default turned
  114.     off.   If  the JOINCHAR keyword are present also, IBMFONT is taken
  115.     instead.
  116.  
  117.     Example: "DTree IBMFONT UTILS:"
  118.  
  119. JOINCHARS/K
  120.     This  keword  specifies  which  characters  are  used  for  branch
  121.     connections.    Branch  connections are made possible by a display
  122.     mask,  consisting  of  four  characters.  You may specify an ASCII
  123.     string  or  an  integer for the display mask.  The display mask is
  124.     defined  as  <dash><T90><L><VBAR>.   The  ASCII  display  mask  is
  125.     defaulted  to  "-+\|".   To  specify the mask as an integer, first
  126.     convert  each character into hexadecimal and then augment each one
  127.     of them in the correct order.  e.g., -+\| is hexadecimal 2d2b5c7c,
  128.     or   decimal   757816444.   The  display  mask,  when  IBMFONT  is
  129.     specified,  is  made  of extended characters valued at hexadecimal
  130.     c4c3c0b3.
  131.  
  132.     Examples: "DTree JOINCHAR 757816444",
  133.               "DTree JOINCHAR !@#%"
  134.  
  135. COLOR/S
  136.     When  this  keyword  is  present,  output  is  in  ANSI  color.  I
  137.     recommend you to use color.  The output looks much better!
  138.  
  139.     Example: "DTree COLOR SYS:"
  140.  
  141.  
  142. ======================================================================
  143. CONTACT
  144. =======
  145.  
  146. Questions, ideas, comments, bug reports, etc. should go to:
  147.  
  148. Home Address: Sam Yee
  149.               4595 Nanaimo St.
  150.               Vancouver, B.C.
  151.               Canada  V5N 5J5
  152.  
  153.     Internet: samy@sfu.ca
  154.      FidoNet: 1:153/765 (Terra Firma BBS 1-604-434-3665)
  155.