home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_disks / 200-299 / ff287.lzh / JPDirUtil / JPDirUtil.doc < prev    next >
Text File  |  1989-12-06  |  10KB  |  312 lines
  1. *****************************************************************************
  2.  
  3.                                JPDirUtil v1.11
  4.  
  5.                     (c) Copyright 1989 by Jonathan Potter                    
  6.  
  7. *****************************************************************************
  8.  
  9.  
  10.                                  INTRODUCTION
  11.                                  ------------
  12.  
  13.     JPDirUtil lets you access the more frequently used CLI commands from an
  14. Intuition environment.
  15.     To choose file(s) or directory to operate upon, click on the name in
  16. the file window. You may scroll up and down the file window using the
  17. slider gadget. The three string gadgets are
  18.  
  19.     S - Source directory. To choose files from a new directory,
  20.            you may enter that directory's name here. DO NOT enter
  21.            any filenames here.
  22.     D - Destination directory. This contains the complete pathname
  23.            of the destination. DO NOT enter any filenames here either.
  24.     E - Execute string. This string is passed to any file you RUN.
  25.         This also contains the destination filename for CLONE, RENAME, etc.
  26.  
  27.  
  28.                                    GADGETS
  29.                                    -------
  30.  
  31. ** Note : Any operation involving more than one file may be aborted
  32.           when in process by pressing the right mouse button.
  33. ** Note : "destination" below refers to the destination directory as
  34.           that entered in the D gadget, and the destination filename
  35.           as that entered in the E gadget.
  36. ** Note : If "Are you sure?" checking is enabled, you are asked for
  37.           confirmation before most operations are carried out.
  38.  
  39.  
  40.     DF0:, DF1:, DF2:, DF3:, DH0:, DH1:, RAM:, RAD:, VD0:, VDK:, SYS:, C:
  41.  
  42.     These gadgets provide an easy way to set the source directory to one
  43.     of the more commonly used devices. Any device names not appearing here
  44.     will have to be entered by hand in the S gadget.
  45.     Clicking on the D string gadget and then one of these enters the
  46.     device name as the destination directory.
  47.  
  48.     SWAP
  49.  
  50.     This gadget swaps the source and destination directories around.
  51.  
  52.     ALL
  53.  
  54.     This gadget either selects or unselects every file in the list.
  55.  
  56.     PARENT
  57.  
  58.     This gadget moves the source directory back to the parent of the current
  59.     source directory.
  60.  
  61.     ROOT
  62.  
  63.     This gadget moves the source directory back to the root of the current
  64.     source directory.
  65.  
  66.     SBYTE
  67.  
  68.     Shows the number of bytes available, free and used on the source device.
  69.  
  70.     DBYTE
  71.  
  72.     Shows the number of bytes available, free and used on the destination
  73.     device.
  74.  
  75.     BYTE
  76.  
  77.     Displays the sum of the lengths of all the selected files, in bytes.
  78.  
  79.     BLOCK
  80.  
  81.     Displays the sum of the lengths of all the selected files, in blocks.
  82.  
  83.     GETDIR
  84.  
  85.     This gadget allows you to enter the currently selected directory in
  86.     the list.
  87.  
  88.     MAKEDIR
  89.  
  90.     Allows you to create a directory. When selected, a string requester
  91.     will open. To cancel the operation, press return to a blank string,
  92.     or enter the name of the directory to wish to create.
  93.  
  94.     DELETE
  95.  
  96.     Attempts to delete the selected file(s) and directory.
  97.  
  98.     RUN
  99.  
  100.     Attempts to run the FIRST selected file in the list. Parameters may
  101.     be passed by entering them in the E gadget.
  102.  
  103.     RENAME
  104.  
  105.     Attempts to rename the FIRST selected file as the name entered in the E
  106.     string gadget. The destination directory is the same as the source, ie
  107.     the string in the D gadget is ignored.
  108.  
  109.     MOVE
  110.  
  111.     Attempts to move all selected files into the destination directory in
  112.     the D string gadget. MOVE will not move from one disk to another. The
  113.     string in the E gadget is ignored.
  114.  
  115.     CLONE
  116.  
  117.     Attempts to clone the FIRST selected file, renaming the clone as the
  118.     name entered in the E string gadget. The destination directory is the
  119.     same as the source, ie the string in the D gadget is ignored.
  120.  
  121.     COPY
  122.  
  123.     Attempts to copy all selected file(s) to the destination directory.
  124.     You cannot copy whole directories. The string in the E gadget is
  125.     ignored.
  126.  
  127.     TYPE
  128.  
  129.     This gadget allows you to view the selected files in the list as
  130.     standard ASCII.
  131.  
  132.     HTYPE
  133.  
  134.     This gadget allows you to view the selected files in the list as
  135.     hex dumps.
  136.  
  137.     PRINT
  138.  
  139.     The same as TYPE, except that the file will be sent to PRT: (printer)
  140.     as well as the screen.
  141.  
  142.     HPRINT
  143.  
  144.     The same as HTYPE, except that the file will be sent to PRT: (printer)
  145.     as well as the screen.
  146.  
  147.     SHOW
  148.  
  149.     Attempt to show all selected files as IFF pictures. Will display all
  150.     types of IFF pictures. To close the picture once it is displayed, click
  151.     the left mouse button. To close and abort any further picture showing,
  152.     click the right mouse button.
  153.  
  154.     EDIT
  155.  
  156.     Attempt to edit the FIRST selected file with a text editor. The name
  157.     of the text editor defaults to "c:editor" but you may change this in
  158.     the SetUp file (see below).
  159.  
  160.     ICON
  161.  
  162.     Allows you to attach an icon to ALL selected entries. When selected,
  163.     a requester appears prompting you for the type of icon, either
  164.     DRAWER (for a directory), TOOL (for an executable program), or
  165.     PROJECT (for a text file, picture, etc..). Choose the type of icon,
  166.     or CANCEL to cancel.
  167.  
  168.     NEWCLI
  169.  
  170.     Open a new interactive CLI window on the Workbench screen.
  171.  
  172.     COMMENT
  173.  
  174.     Attach a comment to the FIRST selected entry. When selected, a string
  175.     requester appears. To cancel, press return on a blank string, or enter
  176.     the comment desired.
  177.  
  178.     PROTECT
  179.  
  180.     This gadget allows you to set the protection bits on the selected
  181.     file(s) and directory. When selected, a string requester appears.
  182.     Enter the desired protection bits, and press return. The bits allowed
  183.     are "sparwed".
  184.  
  185.     SEECOMM
  186.  
  187.     Allows you to see the comment attached to the FIRST selected entry.
  188.  
  189.     SEEPROT
  190.  
  191.     Allows you to see the protection bits of the FIRST selected entry.
  192.  
  193.     CUSTOM GADGETS
  194.  
  195.     The last 16 gadgets are available for customisation. See the SETUP section
  196.     below for information on how to do this.
  197.     When a customised gadget is chosen, the command sent is built from the
  198.     gadget text, the string (if any) in the execute buffer, and the names of
  199.     any selected files, in that order.
  200.     For example, if the gadget text was "ZOO a", and you wished to zoo
  201.     together some files, you would select the files you wish to zoo (by
  202.     clicking on their names), enter the name of the .zoo file in the execute
  203.     buffer, and choose "ZOO a".
  204.  
  205.  
  206.                                    ICONIFY
  207.                                    -------
  208.  
  209.     You may iconify JPDirUtil to a small window on the Workbench screen,
  210. and then recall it when you desire. This window can also be a title-bar clock
  211. (see below).
  212. To iconify JPDirUtil, click on the ICON gadget in the title bar of the
  213. JPDirUtil screen. To start JPDirUtil up in the iconified mode, enter from
  214. the CLI
  215.  
  216.              [RUN] JPDirUtil -i
  217.  
  218.  
  219.                                     SETUP
  220.                                     -----
  221.  
  222.     JPDirUtil allows you to configure the SetUp of the program in a small way.
  223. To do this, the file "JPDirUtil.SetUp" must be present in either the current
  224. directory or the S: directory. The SetUp file looks like this :
  225.  
  226. Command                                       Default
  227. -------                                       -------
  228.  
  229. SORT = <bool>                                 1
  230. EDITOR = <string>                             c:Editor
  231. CLOCK = <bool>                                1
  232. SDIR = <string>                               RAM:
  233. DDIR = <string>                               SYS:
  234. EXEC = <string>
  235. COL0 = <hex>                                  00E
  236. COL1 = <hex>                                  FFF
  237. COL2 = <hex>                                  002
  238. COL3 = <hex>                                  F00
  239. ICONX = <dec>                                 100
  240. ICONY = <dec>                                 0
  241. CHECK = <bool>                                0
  242. GADGET <dec> = <string>
  243.  
  244. All of these items are optional, and may appear in any order. Case is not
  245. important, but the " = " must be as it is above.
  246. All <bool> values are either 1 or 0. 1 is on and 0 is off.
  247. <string> values may not contain any spaces.
  248. <hex> refers to a hexadecimal number, with no leading 0x or $, etc..
  249. <dec> refers to a decimal number.
  250.  
  251.     SORT   allows you to turn sorting of directories on or off.
  252.     EDITOR allows you to select the name of the editor you wish to use with
  253.            the EDIT gadget.
  254.     CLOCK  allows you to select whether the iconified window is a title
  255.            bar clock or not.
  256.     SDIR   allows you to select the initial Source directory.
  257.     DDIR   allows you to select the initial Destination directory.
  258.     EXEC   allows you to select the initial Execute string.
  259.     COL0 \
  260.     COL1 \
  261.     COL2 \
  262.     COL3   allows you to select the colour in that colour register.
  263.     ICONX  allows you to select the X position of the iconified window.
  264.     ICONY  allows you to select the Y position of the iconified window.
  265.     CHECK  allows you to turn the "Are you sure?" requester on or off.
  266.     GADGET allows you to specify the text for a custom gadget; <dec> is a value
  267.            from one to sixteen, and <string> is the gadget text.
  268.            The <string> value in this instance MAY contain spaces, but may not
  269.            be more than 80 characters long.
  270.  
  271. An example SetUp file is:
  272.  
  273.  
  274. SORT = 1
  275. EDITOR = c:CygnusEd
  276. CLOCK = 0
  277. SDIR = RAM:
  278. DDIR = SYS:
  279. COL0 = f00
  280. COL1 = 0f0
  281. COL2 = 00f
  282. COL3 = 000
  283. ICONX = 0
  284. ICONY = 0
  285. CHECK = 1
  286. GADGET 1 = ARC a
  287. GADGET 2 = ZOO a
  288. GADGET 3 = ARC x
  289. GADGET 4 = ZOO x
  290.  
  291.  
  292.                                    THE END
  293.                                    -------
  294.  
  295.     JPDirUtil is freely redistributable, but it is NOT public domain. The
  296. author retains all rights. It may NOT be sold for profit, or included on
  297. any commercial product without prior permission from the author.
  298.     I hope JPDirUtil becomes a useful addition to your software library.
  299.  
  300.     Send any bug reports, praise, criticism, **Job Offers**, and spare cash
  301. to:
  302.  
  303.  
  304.                              Jonathan Potter
  305.                              P.O. Box 289
  306.                              Goodwood, 5034
  307.                              South Australia
  308.                              Australia
  309.  
  310.                      phone : (08) 2932788
  311.  
  312.