home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 18 REXX / 18-REXX.zip / hlin110.zip / NUMBER1.TXT < prev    next >
Text File  |  1994-04-14  |  19KB  |  420 lines
  1.                         
  2.                              Handy Little Interface
  3.                                     Number 1
  4.  
  5.                for use with IBM's LOADDSKF and SAVEDSKF utilities
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                                   Introduction
  13.                                   ============
  14.  
  15.  Handy Little Interface Number 1 is a Graphical User Interface for IBM's
  16.  LOADDSKF and SAVEDSKF utilities.  Handy Little Interface Number 1 was 
  17.  written using WATCOM's VX-REXX for OS/2.
  18.  
  19.  This interface was written as a learning project in an effort to learn 
  20.  the VX-REXX language.  The reason that the LoadDskF and SaveDskF 
  21.  utilities were chosen is because these utilities are not used often and 
  22.  it's easy to forget the parameters and their meanings.  Handy Little 
  23.  Interface Number 1 allows you to quickly set-up parameters and execute 
  24.  these utilities with a minimum of effort and to avoid syntax errors.
  25.  
  26.  
  27.  
  28.                                    Copyright
  29.                                    =========
  30.  
  31.  Handy Little Interface Number 1 is copyright 1994 by Services ORDILis 
  32.  Québec Enr.
  33.  
  34.  
  35.  
  36.                                    Disclaimer
  37.                                    ==========
  38.  
  39.  Services ORDILis Québec Enr. makes no warranty with respect to the 
  40.  adequacy of this documentation or the programs which it describes for 
  41.  any particular purpose or with respect to its adequacy to produce any 
  42.  particular result. In no event shall Services ORDILis Québec Enr. or 
  43.  the author of the program described herein be liable for special, 
  44.  direct, indirect or consequential damages, losses, costs, charges, 
  45.  claims, demands or claim for lost profits, fees or expenses of any 
  46.  nature or kind.
  47.  
  48.  The only thing that this program is guaranteed to do is take up disk space.
  49.  
  50.  
  51.  
  52.                                    Trademarks
  53.                                    ==========
  54.  
  55.  IBM and OS/2 are trademarks of the IBM Corporation. 
  56.  
  57.  WATCOM and VX∙REXX are trademarks of WATCOM International Corporation. 
  58.  
  59.  
  60.  
  61.                                 Package contents
  62.                                 ================
  63.  
  64.  This archive contains the following 7 files:
  65.  
  66.    NUMBER1.EXE  Handy Little Interface Mumber 1 executable. (Required)
  67.    NUMBER1.ICO  Icon file for the executable (Optional)
  68.    NUMBER1.BMP  Program name banner file. (Required)
  69.    NUMBER1.TXT  The program documentation. (Optional)
  70.    ORDILIS.BMP  ORDILis logo file. (Required)
  71.    QUICK.TXT    Quick setup information. (Optional)
  72.    VROBJ.DLL    VX-REXX run-time library.  Redistributed according to WATCOM's
  73.                 Redistribution Rights. (Required)
  74.  
  75.    Note:  Any other files added to this archive come from outside sources.
  76.  
  77.  
  78.  
  79.                                   Registration
  80.                                   ============
  81.  
  82.  Handy Little Interface Number 1 is FREE shareware.  If you like and use 
  83.  the product you are encouraged to tell others about it.  I would also 
  84.  appreciate it if you sent me a NetMail message telling me what you 
  85.  think of the program.
  86.  
  87.  
  88.  
  89.                              Contacting the author
  90.                              =====================
  91.  
  92.  The author is available on FidoNet as John Bousquet at 1:240/1.11
  93.  
  94.  Snail mail address is:         John Bousquet
  95.                                 201 Senneville
  96.                                 St-Raymond
  97.                                 Quebec, Canada
  98.                                 G0A 4G0
  99.  
  100.  
  101.  
  102.                               System requirements
  103.                               ===================
  104.  
  105.  OS/2 2.x  and the contents of this archive.
  106.  IBM's LoadDskF utility. (LoadDskF.exe)
  107.  IBM's SaveDskF utility. (SaveDskF.exe)
  108.  A mouse or other pointing device. (This interface offers very limited
  109.                                                      keyboard support)
  110.  
  111.  
  112.  
  113.                                   Installation
  114.                                   ============
  115.  
  116.  - Place the VROBJ.DLL file in a directory in your LIBPATH.
  117.  
  118.  - Place the remaining files from this archive in a sub-directory of your 
  119.    choice.
  120.  
  121.  - In the executable's settings book, ensure that the working directory is set 
  122.    to reflect the directory where the files were installed.
  123.  
  124.  - Open a OS/2 full-screen or windowed session or alternately use the drive 
  125.    icon to change drive:\directory to where the Number 1 files are located.
  126.  
  127.  - Execute the NUMBER1.EXE file.
  128.    
  129.    NOTE:  The first time that Number 1 is executed you will be asked to supply 
  130.           information about the location of the LoadDskF and SaveDskF 
  131.           utilities.  This information will be written to the NUMBER1.INI file 
  132.           which will be created in the directory containing the Number 1 files.  
  133.           Failure to supply the required information will abort the program.
  134.  
  135.  
  136.  
  137.                                   User's guide
  138.                                   ============
  139.  
  140. Operation
  141. =========
  142.  
  143.  - Execute the NUMBER1.EXE file.
  144.  
  145.  - Choose whether to create an image file of a floppy by pressing the [Create] 
  146.    button or to restore an image file to a floppy by pressing the [Restore] 
  147.    button.
  148.  
  149.  - Depending on which button was pressed, either the create options area or the 
  150.    restore options area will be available for input.
  151.  
  152.  - Choose the desired options by checking the options boxes or push buttons.
  153.  
  154.  - Press the [Execute] button.
  155.  
  156.  - To exit the interface, press the [Quit] button.
  157.  
  158.  - NOTE: Help is available within the program by clicking the right mouse 
  159.    button on an item.
  160.  
  161.  
  162. The interface
  163. =============
  164.  
  165.             ┌────────────────────────────────────────────────────────┬──┐
  166.             ├────────────────────────────────────────────────────────┴──┤
  167.             │ ┌─────┬────────────────┐                                  │
  168.             │ │     │   ORDILis      │    Handy  Little  Interface      │
  169.             │ │     │    LOGO        │            Number 1              │
  170.             │ └─────┴────────────────┘                                  │
  171.             │                                                           │
  172.             │ ┌─Image─────┐ ┌─Create options──┐ ┌─Restore options──────┐│
  173.             │ │           │ │ [] Compression  │ │ [] Format floppy     ││
  174.             │ │ [Create ] │ │ [] Pure image   │ │ [] Floppy conversion ││
  175.             │ │           │ │ [] Whole floppy │ │ [] Bypass prompt     ││
  176.             │ │ [Restore] │ │ [] Text file    │ │ [] Omit warning      ││
  177.             │ └───────────┘ │ [] Append msg   │ │                      ││
  178.             │               │                 │ │                      ││
  179.             │   [Execute]   │ [A][B] Source   │ │ [A][B] Target        ││
  180.             │               │ [File] Target   │ │ [File] Source        ││
  181.             │   [ Quit  ]   └─────────────────┘ └──────────────────────┘│
  182.             └───────────────────────────────────────────────────────────┘
  183.  
  184.  
  185. The Window
  186. ==========
  187.  
  188.  The title bar contains the name of the executable and a minimize button for 
  189.  your convenience.  The window may be moved but is of a fixed size measured in 
  190.  twips (20th's of a point).  The window contains the following areas of 
  191.  interest.
  192.  
  193.  
  194. The ORDILis logo
  195. ================
  196.  
  197.  ┌─────┬────────────────┐  Clicking on the logo using the left mouse 
  198.  │     │   ORDILis      │  button will bring up product information.
  199.  │     │    LOGO        │
  200.  └─────┴────────────────┘  Clicking on the logo using the right mouse
  201.                            button will bring up help.
  202.  
  203.  
  204. The Program banner
  205. ==================
  206.  
  207.  Clicking on the program banner using the left mouse button will bring up 
  208.  program information.
  209.  
  210.  Clicking on the program banner using the right mouse button will bring up 
  211.  help.
  212.  
  213.  
  214. The Image area
  215. ==============
  216.  
  217.  ┌─Image─────┐   This area is used to choose whether to create an image 
  218.  │           │   file of a floppy or to build a floppy from an image file. 
  219.  │ [Create ] │ 
  220.  │           │   Clicking on the [Create ] button will activate the create 
  221.  │ [Restore] │   options area.
  222.  └───────────┘   
  223.                  Clicking on the [Restore] button will activate the restore 
  224.                  options area.
  225.  
  226.                  The chosen button will change colour to red to reflect the 
  227.                  choice.
  228.  
  229.                  Clicking on either button using the right mouse button will 
  230.                  bring up help.
  231.  
  232.  
  233. The create options area
  234. =======================
  235.  
  236.  ┌─Create options──┐  Compression: Optionally compresses the files from the
  237.  │ [] Compression  │               floppy to produce a smaller image file.
  238.  │ [] Pure image   │               This is SaveDskF's /N option.  The default
  239.  │ [] Whole floppy │               is with compression.
  240.  │ [] Text file    │               
  241.  │ [] Append msg   │   Pure image: This option creates an exact image of the
  242.  │                 │               floppy.  When this option is selected all
  243.  │ [A][B] Source   │               other options are disabled.  Also the whole
  244.  │ [File] Target   │               floppy option is set and locked to retain
  245.  └─────────────────┘               compatibility with the LoadDskf utility.
  246.                                    This is SaveDskF's /D option.
  247.  
  248.                      Whole floppy: This option saves the whole diskette
  249.                                    regardless of the amount of data stored on
  250.                                    the floppy.  This is SaveDskF's /A option.
  251.  
  252.                         Text file: This option allows you to read text from a
  253.                                    file which will be included as a comment in 
  254.                                    the diskette image file. The total length of 
  255.                                    this message plus any message added via the 
  256.                                    Append msg option must not exceed 4096 
  257.                                    bytes. This is SaveDskF's /M option.
  258.  
  259.                        Append msg: This option allows you to enter a short
  260.                                    message which will be included as a comment 
  261.                                    in the diskette image file. This message 
  262.                                    will be added to the Text file message if 
  263.                                    this option was also chosen.  This is 
  264.                                    SaveDskF's /K option.
  265.                              NOTE: Care must be exercised when using this
  266.                                    option as the entire command length passed 
  267.                                    to SaveDskF is limited to 128 bytes.
  268.                                 
  269.        Source [A] and [B] buttons: These buttons are used to select the source             
  270.                                    drive to be used for creating the image 
  271.                                    file.  The default is the A: drive but can 
  272.                                    be changed by clicking the B: drive button.  
  273.                                    If the target image file has already been 
  274.                                    set then the [Execute] button will be 
  275.                                    enabled. The active source button will be 
  276.                                    red.
  277.                                 
  278.              Target [File] button: This button brings up a dialog box which
  279.                                    allows you to choose a 
  280.                                    drive:\path\filename.ext for the image file.
  281.                                    Once an image file has been set the file 
  282.                                    button will change to red and the [Execute]
  283.                                    button will be enabled.
  284.  
  285.  Clicking the left mouse button on a checkbox sets or removes the option.
  286.  Some checkboxes will bring up further dialog boxes when chosen.
  287.  
  288.  Clicking the left mouse button on a source drive button will set the option to 
  289.  that drive.
  290.  
  291.  Clicking the left mouse button on the target [File] button will bring up a 
  292.  standard file dialog box to choose a path and filename for the image file.  If 
  293.  the image file already exists you will be asked to confirm overwriting the 
  294.  file.
  295.  
  296.  Clicking on any object or text in this area using the right mouse button will 
  297.  bring up help on that item.
  298.                                 
  299.                                 
  300. The restore options area
  301. ========================
  302.                                 
  303.  ┌─Restore options──────┐                               
  304.  │ [] Format floppy     │    Format floppy:  This option is used to format                           
  305.  │ [] Floppy conversion │                    the floppy during the restore. 
  306.  │ [] Bypass prompt     │                    This is LoadDskF's /F option.             
  307.  │ [] Omit warning      │                               
  308.  │                      │ Floppy conversion: This option permits writing the                        
  309.  │                      │                    image file to a floppy of a 
  310.  │ [A][B] Target        │                    different format than the
  311.  │ [File] Source        │                    original.  The floppy must be
  312.  └──────────────────────┘                    at least of the same capacity as
  313.                                              or greater than the original.
  314.                                              This is LoadDskF's /C option.
  315.                                 
  316.                               Bypass prompt: This option bypasses the need to
  317.                                              press the "y" key in order to 
  318.                                              continue.  If this option is set, 
  319.                                              the window running the LoadDskF 
  320.                                              utility will be opened behind 
  321.                                              other open windows.  If this 
  322.                                              option is not checked, the window 
  323.                                              running the LoadDskF utility will 
  324.                                              be brought to the foreground for 
  325.                                              you to enter the required 
  326.                                              keystroke.  This is LoadDskF's /Y 
  327.                                              option.
  328.                                 
  329.                                Omit warning: This option bypasses the warning 
  330.                                              message that appears before the 
  331.                                              data transfer begins.  Setting 
  332.                                              this option sets and disables the
  333.                                              bypass prompt option.  This is 
  334.                                              LoadDskF's /A/Q option.
  335.                                 
  336.                  Target [A] and [B] buttons: These buttons are used to select 
  337.                                              the target drive to be used for 
  338.                                              creating the floppy.  The default 
  339.                                              is the A: drive but can be changed 
  340.                                              by clicking the B: drive button. 
  341.                                              If the source image file has 
  342.                                              already been set then the 
  343.                                              [Execute] button will be enabled. 
  344.                                              The active target button will be 
  345.                                              red.
  346.                                 
  347.                        Source [File] button: This button brings up a dialog box
  348.                                              which will allow you to choose a 
  349.                                              drive:\path\filename.ext for the 
  350.                                              image file.  Once an image file 
  351.                                              has been set the file button will 
  352.                                              change to red and the [Execute] 
  353.                                              button will be enabled.
  354.  
  355.  Clicking the left mouse button on a checkbox sets or removes the option.
  356.  
  357.  Clicking the left mouse button on a target drive button will set the option to 
  358.  that drive.
  359.  
  360.  Clicking the left mouse button on the source [File] button will bring up a 
  361.  standard file dialog box to choose a path and filename for the image file to 
  362.  use in the restoration process.
  363.  
  364.  Clicking on any object or text in this area using the right mouse button will 
  365.  bring up help on that item.
  366.                                 
  367.                                 
  368. The [Execute] button
  369. ====================
  370.  
  371.  Clicking the left mouse button on the [Execute] button when it is enabled will 
  372.  launch the task that was chosen.
  373.  
  374.  The [execute] button will only be enabled if the following are true:
  375.      
  376.      The [Create] button is red, and
  377.      The create options [A] or [B] button is red, and
  378.      The create options [File] button is red.                                
  379.                                 
  380.      - or -
  381.      
  382.      The [Restore] button is red, and
  383.      The restore options [A] or [B] button is red, and
  384.      The restore options [File] button is red.                          
  385.                                 
  386.  Clicking on the [Execute] button using the right mouse button will bring up 
  387.  the help for that item.                               
  388.                                 
  389.                                 
  390. The [Quit] button
  391. =================
  392.                                 
  393.  Clicking on the [Quit] button using the left mouse button will exit the 
  394.  interface.  
  395.  
  396.  The [Quit] button will change to a red [Wait...] button while Number 1 checks 
  397.  for any windows that were created by the interface.  Before exiting you will 
  398.  be asked to close down any windows created by Handy Little Interface Number 1.  
  399.  
  400.  Windows opened by Number 1 will be brought to the foreground for your 
  401.  attention.  
  402.  
  403.  Clicking on the [Quit] button once these windows are closed will exit the 
  404.  interface.
  405.                                 
  406.                                 
  407.                                 
  408.                                   BUG reports
  409.                                   ===========                                
  410.                                 
  411.  If you discover a bug in the program you are encouraged to contact the author 
  412.  by NetMail or snail mail describing the steps required to reproduce the fault.                               
  413.                                 
  414.                                 
  415.                                 
  416.                                     History
  417.                                     =======
  418.  
  419.  Version 1.0     First official release.
  420.