home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d1xx / d103 / intuidos.lha / IntuiDOS / Docm < prev    next >
Text File  |  1987-10-22  |  17KB  |  416 lines
  1.  
  2.  IntuiDOS, User Guide
  3.  --------------------
  4.  
  5.  Table of Contents:
  6.  
  7.      1.  Product Status
  8.      2.  Program Objectives
  9.      3.  Getting Started Quickly
  10.      4.  Windows
  11.      5.  Current Name
  12.      6.  Scrolling
  13.      7.  Memory Buffer
  14.      8.  The Multi-disk Directory
  15.      9.  DOS Commands and Editing Gadget
  16.      10. Menus
  17.      11. DOS Command Profile
  18.      12. Logical Devices and Files
  19.      13. Miscellaneous Notes
  20.  
  21.  
  22. -------------------------------------------------------------------------
  23.  1.  Product Status
  24.  
  25.      This program, IntuiDOS, is placed in the AMIGA Public Domain Library
  26.      to be used by anyone for private purposes. It may not be used in
  27.      commercial situations of any kind and not within a company or similar
  28.      institution. For such use the author must be contacted.
  29.  
  30.      There is no charge for the program, though the author would not reject
  31.      a token of recognition if the program is found useful.
  32.  
  33.      As far as time (and skill) allows, the author will support the program,
  34.      especially in removing errors. To obtain such support an error
  35.      description, an addressed label, a diskette (or corresponding amount
  36.      in money) and the equivalence of two U.S. dollars for air mailing
  37.      should be sent to the author:
  38.  
  39.           Lennart Sandin
  40.           Tulegatan 46
  41.           S-11353 Stockholm
  42.           Sweden
  43.  
  44.      The program is written in Assembler using a large, private, macro
  45.      library. It is developed and tested on OS 1.1 and briefly used on
  46.      OS 1.2. The full test matrix is not rerun on OS 1.2.
  47.  
  48.  
  49. -------------------------------------------------------------------------
  50.  2.  Program Objectives
  51.  
  52.      There are two main objectives for this program:
  53.  
  54.      -  Giving an improved overview and control over and handling of
  55.         all diskettes in the 'CLI-area', i.e. all types of work where
  56.         the Workbench is not appropriate, such as PD software, Program
  57.         Development and large text libraries. The vehicle for this is a
  58.         multi-disk scrollable 'directory'.
  59.      
  60.      -  Issuing DOS commands by using Intuition techniques and by pointing
  61.         to disks, directories and members (tools/projects) in the
  62.         directory introduced above.
  63.  
  64.  
  65. -------------------------------------------------------------------------
  66.  3.  Getting Started Quickly
  67.  
  68.      To quickly get a feeling for the program do the following
  69.      (assuming a two drives system):
  70.  
  71.      -  Workbench diskette in DF0:
  72.  
  73.      -  The PD diskette containing IntuiDOS directory in DF1:
  74.  
  75.      -  Open the CLI window and expand it to full size.
  76.  
  77.      -  Enter:
  78.                 Execute DF1:IntuiDOS/Qstart xxxxx
  79.  
  80.         where 'xxxxx' is a disk name or a full name of a directory
  81.         with at least 20K free space.
  82.  
  83.      -  Select DF0: from the 'Maint' menu of IntuiDOS.
  84.  
  85.      -  Select DF1: from the 'Maint' menu of IntuiDOS.
  86.  
  87.      -  Optionally repeat DF1: with other diskettes.
  88.  
  89.      -  Click on a disk name and select Dirs from the 'Display' menu.
  90.  
  91.      -  Click on a directory name and select Members from the 'Display' menu.
  92.  
  93.      -  Start 'playing' around.
  94.  
  95.  
  96.      (The procedure Qstart Assigns required logical device names. If the
  97.      IntuiDOS session is ended with Save from the 'Project' menu the
  98.      memory buffer is saved in the disk/directory pointed to by 'xxxxx'.)
  99.  
  100.  
  101. -------------------------------------------------------------------------
  102.  4.  Windows
  103.  
  104.      IntuiDOS uses one window of its own in cooperation with the CLI
  105.      window(s). The window is sized and positioned to fit nicely on top
  106.      of a fully expanded CLI window. The window allows some vertical sizing
  107.      and supports the additional lines on a PAL monitor. It cannot draw the
  108.      full benefit of an interlaced screen.
  109.  
  110.      The IntuiDOS window is used for scrolling of the buffer contents (the
  111.      multi-disk directory), see 'Scrolling' below, and to select names for
  112.      substitution into DOS commands. Issued DOS commands are printed in
  113.      the CLI window, where of course also the result of the commands appear.
  114.  
  115.      A second CLI window is opened when the History option from the 'Display'
  116.      menu is selected. It is designed to sit between the IntuiDOS window
  117.      and the original CLI window.
  118.  
  119.      A strict sequence of back-pushing works nicely on this window scheme.
  120.  
  121.  
  122. -------------------------------------------------------------------------
  123.  5.  Current Name
  124.  
  125.      A 'Current Name' is selected by clicking on it. It is then highlighted
  126.      by being printed in a different color. When a Member (project/tool) is
  127.      selected, there is also by default an implicit Directory and Disk
  128.      selected. The 'Current Name' remains established even when it is
  129.      scrolled off the screen.
  130.  
  131.      IntuiDOS uses fully qualified names and is not dependent on the setting
  132.      of CD (DOS' Current Directory). 
  133.  
  134.  
  135. -------------------------------------------------------------------------
  136.  6.  Scrolling
  137.  
  138.      Scrolling status is obtained by selecting 'Scrolling On' from the
  139.      Display menu. More conviniently, it can also be toggled on and off
  140.      by clicking in the area above and around the screen Heading Line.
  141.      (In latter case the checkmark in the Display menu does not follow.)
  142.  
  143.      A 'scrolling grid' is printed overlaying text. By pointing on the
  144.      upper half of the screen upwards scrolling takes place (towards the
  145.      top). By pointing on the bottom half the opposite takes place.
  146.      By pointing in the leftmost column scrolling is done to next disk.
  147.      The middle column scrolls to the next directory and the rightmost
  148.      scrolls 10 members at a time.
  149.  
  150.      The options 'Disks', 'Dirs' and 'Members' controls the level of details
  151.      available in the window and helps significantly in locating certain
  152.      material. When using these selections the 'Current Name' is positioned
  153.      at the top of the screen, except for disks (that always are positioned
  154.      at first disk in the memory buffer).
  155.  
  156.  
  157. -------------------------------------------------------------------------
  158.  7.  Memory Buffer
  159.  
  160.      IntuiDOS uses a memory buffer to keep the scrollable multi-disk
  161.      directory. The size of this buffer is the length of the last saved
  162.      buffer + 10K, but minimum 30K. 10K buffer is sufficient for adding
  163.      4-8 disks, depending on their contents.
  164.  
  165.      To add directory information to the buffer select DF0:, DF1: or
  166.      Ram: (or IuDosD:) from the 'Maint' menu. If the disk name exists
  167.      in the buffer already, the old content is first wiped out (takes some
  168.      seconds). The new information is added at the bottom. To remove a
  169.      disk from the buffer, position its name at the top of the screen, then
  170.      select Remove from the 'Maint' menu.
  171.  
  172.      If a 'Buffer Exhausted' -message is encountered, just end IntuiDOS by
  173.      saving the buffer (Save option from 'Project' menu) and restart
  174.      IntuiDOS. This will give you 10K additional memory. Then obtain the
  175.      directory (Maint menu) for the disk that failed.
  176.  
  177.  
  178. -------------------------------------------------------------------------
  179.  8.  The Multi-disk Directory
  180.  
  181.      The memory buffer keeps, for every disk(ette), all names obtained by
  182.      a full directory scan including all subdirectories. The 'root' directory
  183.      is given the same name as the disk. A directory is distinct from its
  184.      sub-directories.
  185.  
  186.      When obtaining names IntuiDOS drops all starting with a period (.) and
  187.      all ending with '.info'. (See command 'AskIcon' in the sample DOS
  188.      commands.)
  189.  
  190.      IntuiDOS cannot work -- in the substitution process -- with names that
  191.      require quotes in DOS commands (e.g. names containing spaces). Relabel
  192.      or Rename those first. The multi-disk directory can accomodate those,
  193.      though.
  194.  
  195.      Changes to the actual disk are not reflected in IntuiDOS directory.
  196.      The DOS Command Profile contains an Action code that can specify
  197.      that the Current Name should be 'marked' (it is printed in Italic) to
  198.      remind you of some action taken. At any point in time a new fresh
  199.      copy can be obtained by selecting the device in the 'Maint' menu. This
  200.      can also be specified to take place automatically by means of the Action
  201.      code in the DOS Command Profile (see CopyDir in the sample commands).
  202.  
  203.  
  204. -------------------------------------------------------------------------
  205.  9.  DOS Commands and Editing Gadget
  206.  
  207.      DOS commands are selected from three menus. This allows at least
  208.      50 predefined DOS commands. You design these commands in the IntuiDOS
  209.      DOS Command Profile (file IuDosProf), including the option name you
  210.      want to appear in the three menus. The profile shipped with the program
  211.      is for education/demonstration purposes only. The layout of this
  212.      Profile is described below under heading 'DOS Command Profile'.
  213.  
  214.      If these commands contain a 'Promting Text' an editing (string) gadget
  215.      will be opened, in which you can enter (or change default) text. Click
  216.      in the input-box to activate the gadget and end with 'Return'. The
  217.      Undo feature is supported. To withdraw, click on the cancel-box at
  218.      the right end of the input-gadget.
  219.  
  220.      If the option Inspection is selected from the 'Display' menu, the
  221.      editing gadget will appear once more with the text 'Verify / Modify'
  222.      and the fully built DOS command available in the input field. Proceed
  223.      as above to issue or to cancel.
  224.  
  225.  
  226. -------------------------------------------------------------------------
  227.  10. Menus
  228.  
  229.      Menu / Item / Description
  230.      -------------------------
  231.  
  232.      Project
  233.           Save
  234.               Saves the memory buffer (the multi-disk directory) in file
  235.               IuDosBuff in directory assigned to IuDosB:.
  236.           Quit
  237.               Ends without saving, but ask for 'Save' if buffer has been
  238.               changed during the session. (Same as using the Window
  239.               Closing Gadget.)
  240.  
  241.      Maint
  242.           -df0:
  243.               Obtains directory information from disk(ette) in drive df0.
  244.           -df1:
  245.               Same for drive df1.
  246.           -Ram:
  247.               Same for the Ram device.
  248.           -IuDosD
  249.               Same for the device assigned to IuDosD:.
  250.           Remove
  251.               Removes the disk currently positioned at the screen top line
  252.               from the memory buffer.
  253.  
  254.      Display
  255.           Scrolling On
  256.               Selects Scrolling status (same as clicking on the Screen
  257.               Heading line).
  258.           Scrolling Off
  259.               Resets Scrolling status and reverts to normal 'Name selecting'
  260.               status. (Same as clicking on the Screen Heading line.)
  261.           Disks
  262.               Displays only disk names (positioned at first disk in memory
  263.               buffer.
  264.           Dirs
  265.               Displays only disk and directory names (positioned at
  266.               'Current Name'.
  267.           Members
  268.               Displays all details (positioned at 'Current Name').
  269.           History On
  270.               Opens a CLI window that keeps track of issued DOS commands.
  271.           History Off
  272.               Removes the History window.
  273.           Inspection On
  274.               Gives an editing gadget containing the fully built DOS
  275.               command before it is issued.
  276.           Inspection Off
  277.               Turns off the editing gadget for inspection purposes.
  278.           ClearCLI
  279.               Clears the CLI window.
  280.  
  281.  
  282. -------------------------------------------------------------------------
  283.  11. DOS Command Profile
  284.  
  285.      DOS Command Skeletons are to be provided in the file IuDosProf
  286.      in the directory assigned to IuDosP:. A sample file is provided with
  287.      the program. Make sure you understand the layout before editing your
  288.      own profile.
  289.  
  290.      The commands are divided in three groups, corresponding to the three
  291.      Menu slots in IntuiDOS. The two-byte lines separating the groups
  292.      contains the digit 1 resp. 2 and ends with an <eol>-character (hex 0A).
  293.      (The first group -- group 0 -- is not explicitly identified.)
  294.  
  295.      The layout of the DOS Command Skeleton is as follows:
  296.  
  297.             Item , [Prompt] , [Default] , [Action] , DOS command  <eol>
  298.  
  299.      There are four (4) mandatory commas before the DOS command starts.
  300.      Prompt, Default and Action must thus not contain commas, but the
  301.      DOS command can. The <eol> is hex 0A.
  302.  
  303.      Item:    The Item text appearing in the Command Menu. May contain
  304.               blank(s). Max 10 bytes.
  305.  
  306.      Prompt:  A prompting text of not more than 55 positions (after
  307.               substitution). If the 'prompt' is specified an Editing
  308.               Gadget is opened.
  309.  
  310.      Default: Deafult data available in the Editing Gadget. May not exceed 
  311.               400 bytes (after substitution). Is ignored if no 'prompt'
  312.               is specified.
  313.  
  314.      Action:  Up to three positional Action codes, telling IntuiDOS some
  315.               actions to do when processing the command.
  316.  
  317.               pos 1:  IntuiDOS Window action
  318.               pos 2:  Buffer 'maintenance' after command
  319.               pos 3:  CLI window action
  320.  
  321.  
  322.               pos 1:  IntuiDOS Window action
  323.  
  324.                  blank    No window back-push
  325.                  0-9      Window back-push and number of seconds
  326.                           staying after command ends.
  327.                  X        Window back-push and manual front-push.
  328.  
  329.               pos 2:  Buffer 'maintenance' after command
  330.  
  331.                  blank    No action
  332.                  *        Current Name to be marked in the memory buffer
  333.                           (printed in Italics).
  334.                  M        Full maintenance on the disk containing Current
  335.                           Name (same as a selection from the 'Maint' menu).
  336.  
  337.               pos 3:  CLI window action
  338.  
  339.                  non-
  340.                  blank    Clear CLI window before processing the command.
  341.  
  342.      DOS 
  343.      command: The DOS command to be issued. May not exceed 400 bytes
  344.               (after substitution).
  345.  
  346.  
  347.      Substitution:
  348.  
  349.      IntuiDOS supports the following substitution in a straightforward way.
  350.      (To obtain more elaborate substitution use Execute of 'batch' files;
  351.      Change the T:-directory to Ram: to smooth things up.)
  352.  
  353.      %n   The full name according to Current Name selected.
  354.  
  355.      %v   The selected Disk name.
  356.           (v=volume, to avoid conflict with Directory)
  357.  
  358.      %d   The selected Directory name.   
  359.  
  360.      %m   The selected Member name.
  361.  
  362.      %p   The entire string (asis) from the Editing Gadget.
  363.  
  364.      %c   Hex 0A (eol). Used in the Run command to separate
  365.           appended commands.
  366.  
  367.      If %d, %m or %p is null due to not selected name (or not available
  368.      Editing Gadget) nothing is substituted, though the code is removed.
  369.      So is a '/' following a %d. Letters are in lower case.
  370.  
  371.      Warning. There is no safety-net in the program regarding the editing
  372.      of the DOS Command Profile. All rules must be obeyed. Problems
  373.      encountered from violation of these rules are not concidered
  374.      program errors.
  375.  
  376.  
  377. -------------------------------------------------------------------------
  378.  12. Logical Devices and Files
  379.  
  380.      IntuiDOS uses the following logical devices and file names:
  381.  
  382.            Device     File Name        Contents
  383.  
  384.            IuDosB:    IuDosBuff        Memory buffer
  385.            IuDosP:    IuDosProf        DOS Command Profile
  386.  
  387.      IuDosB: and IuDosP: must be 'assigned' to a directory. By switching
  388.      directory several different set-ups can be kept.
  389.  
  390.      The logical device name IuDosD: is selectable from the 'Maint' menu,
  391.      and used to indicate another device than DF0:, DF1: or Ram:.
  392.  
  393.  
  394. -------------------------------------------------------------------------
  395.  13. Miscellaneous Notes
  396.  
  397.      A memory buffer of not more than about 20K (8-10 disks) works best.
  398.      Overhead then starts taking its toll. Logical grouping of diskettes
  399.      is a good dicipline. (The program has been tested with 50K buffer,
  400.      achieved by several saves and restarts.)
  401.  
  402.      The DOS commands are only 'single-dimmensioned', i.e. either you point
  403.      to a 'project'-member and the command includes the program (tool) or
  404.      you point to a program (tool) that the commands starts up. A simple
  405.      editor works better in the IntuiDOS environment than a fancy one
  406.      with its own Directory function. (Pity ED does not use mouse at least.)
  407.  
  408.      Most Workbench programs can be brought up in the CLI environment
  409.      (usefull when exploring PD software). But PLEASE, don't use IntuiDOS
  410.      as a Workbench competitor. Workbench with icons is the way our Amiga
  411.      should be approach from the 'outer world'. IntuiDOS is for the work
  412.      behind the stage.
  413.  
  414.  
  415. -------------------------------------------------------------------------
  416.