home *** CD-ROM | disk | FTP | other *** search
/ RISC DISC 1 / RISC_DISC_1.iso / pd_share / utilities / split / !Split / !Help < prev    next >
Encoding:
Text File  |  1994-09-29  |  15.8 KB  |  393 lines

  1.  
  2.                               ====================
  3.                               !Split  Version 2.11
  4.                               ====================
  5.  
  6.  ****************************** Copyright Notice ******************************
  7.  *                                                                            *
  8.  *   This application is copyright Adam Hamilton.                             *
  9.  *   Permission to use, copy, and distribute !Split, for non-commercial       *
  10.  *   purposes, is hereby granted, provided:-                                  *
  11.  *                                                                            *
  12.  *     • No charge is made other than to cover the cost of the medium.        *
  13.  *                                                                            *
  14.  *     • All files and documents are included in the distribution unaltered.  *
  15.  *                                                                            *
  16.  *   You may upload this software to a Bulletin Board, or include it in       *
  17.  *   your Public Domain library. If you do this, please try and let me        *
  18.  *   know, so I can keep you up to date with any future changes.              *
  19.  *   The authors permission must be obtained before this application is       *
  20.  *   included on any magazine disk.                                           *
  21.  *                                                                            *
  22.  *   You may not sell this software, or use it otherwise for personal gain.   *
  23.  *                                                                            *
  24.  *   This program is supplied 'as is' with no guarantee of its suitability    *
  25.  *   for any purpose. I will not be held responsible for any damage arising   *
  26.  *   from the use or misuse of this software.                                 *
  27.  *                                                                            *
  28.  *   I reserve the right to change these terms and conditions at any time.    *
  29.  *                                                                            *
  30.  ******************************************************************************
  31.  
  32.  
  33. Contacting The Author
  34. ~~~~~~~~~~~~~~~~~~~~~
  35.  
  36.    Bug reports, comments and any donations may be sent to me, the author,
  37.    at this address :-
  38.  
  39.              Adam Hamilton,
  40.              23 Northmeadow Road,
  41.              Cricklade,
  42.              Swindon,
  43.              Wiltshire,  SN6 6LT,
  44.              England.
  45.  
  46.    I may also be contacted by E-Mail:    aph@swindon.gpsemi.com
  47.  
  48.  
  49. ================================================================================
  50.  
  51. 1  Introduction
  52.  
  53.    !Split was written to ease the transportation of large files from one
  54.    computer to another. No attempt to compress the file is made, as it is
  55.    assumed this has already been done. !Split will split a file into a number
  56.    of smaller files, and will join them again when required.
  57.  
  58.  
  59.  
  60. 2  How To Use !Split
  61.  
  62.    !Split can be started either by running the application directly or via
  63.    a double click on a split file (see section 2.3, 'Joining Files').
  64.  
  65.  
  66.  2.1  The iconbar menu
  67.  
  68.       Pressing the menu button on the iconbar icon will display a menu.
  69.  
  70.       Info              This displays information about the program.
  71.  
  72.       Faster            If selected, the multi-tasking window will not be
  73.                         updated with bytes read and written, making the
  74.                         operation faster. A tick will be displayed when this
  75.                         option is selected.
  76.  
  77.       Single Task       This option will toggle between single and
  78.                         multi-tasking. A tick will be displayed when this option
  79.                         is selected.
  80.  
  81.       Quit              This will quit the program.
  82.  
  83.  
  84.       The default action of Faster and Single Task may be changed (see section
  85.       3, 'Customizing').
  86.  
  87.  
  88.  2.2  Splitting Files
  89.  
  90.       The split window can be displayed either by clicking on the iconbar icon
  91.       with select, or by dragging a file to the iconbar icon (not of filetype
  92.       'Split'). Figure 1 shows an example of the split window. Please note, you
  93.       may open and close filer windows, or change floppy disks between saving.
  94.  
  95.  
  96.                  ---------------------------------------------
  97.                 |             -----------------------------   |
  98.                 |    Source  |s::IDEDisc5.$.Music.RaveAlert|  |
  99.                 |             -----------------------------   |
  100.                 |             ----------      -               |
  101.                 |  Filesize  |      1420| K  | |              |
  102.                 |             ----------      -               |
  103.                 |             ----------      -               |
  104.                 |  Filename  | RaveAler |    |€| Single save  |
  105.                 |             ----------      -               |
  106.                 |        -------            -------           |
  107.                 |       | Close |          | Split |          |
  108.                 |        -------            -------           |
  109.                  ---------------------------------------------
  110.  
  111.                            Figure 1: Split window
  112.  
  113.  
  114.   2.2.1  Source
  115.  
  116.          Enter the filename for the file you want to split, or simply drag
  117.          the file to the split window. If you drag, the Filename field will
  118.          automatically get filled in, although you can still change it if you
  119.          wish.
  120.  
  121.  
  122.   2.2.2  Filename
  123.  
  124.          This is the 'base' filename to be used for each part the file is split
  125.          into. Using the example above, the base name is RaveAler so the parts
  126.          will be named RaveAler01, RaveAler02, ... etc.
  127.  
  128.  
  129.   2.2.3  Filesize
  130.  
  131.          This is the maximum file size in K (1024 bytes), that you want each
  132.          part to be saved as. You may either type the size into the text icon,
  133.          or press the select or menu mouse buttons on the menu icon opposite.
  134.          You may then choose from one of the sizes in the menu. The default
  135.          size and the contents of the menu can be customized (see section 3,
  136.          'Customizing').
  137.  
  138.  
  139.   2.2.4  Single save
  140.  
  141.          If this option is set, !Split will automatically save all parts to the
  142.          same directory, only one drag is needed. This option may be switched
  143.          on or off during saving. The default setting for this option may be
  144.          customized (see section 3, 'Customizing').
  145.  
  146.  
  147.   2.2.5  Close
  148.  
  149.          Pressing this button will close the split window. If splitting has
  150.          started, closing the split window will not affect this process.
  151.  
  152.  
  153.   2.2.6  Split
  154.  
  155.          Pressing Split will open the save as window (if all the parameters have
  156.          been set correctly), prompting you to drag the iconbar icon to a
  157.          directory window. If the Single Task option has not been selected from
  158.          the iconbar menu, then a transfer window will be displayed, and the
  159.          splitting process will begin. (see section 2.4, 'The Transfer Window').
  160.  
  161.  
  162.  2.3  Joining Files
  163.  
  164.       The join window can be opened either by clicking on the iconbar icon with
  165.       adjust, double clicking on, or dragging to the iconbar icon, a file of
  166.       type 'Split'. If you opened the window with the adjust mouse button, you
  167.       must double click or drag the first file to the join window. If you
  168.       maximize the join window you will see some short hints to help you along.
  169.       Figure 2 shows an example of the join window.
  170.  
  171.  
  172.            -----------------------------------------------------------
  173.           |   Save as               |   Info                          |
  174.           |          -----          |                                 |
  175.           |         |     |         |  Part 1 of 2.                   |
  176.           |         |     |         |  Drag file to directory window. |
  177.           |          -----          |                                 |
  178.           |  --------    --------   |  Using buffer size of 192K      |
  179.           | | Cancel |  |  Save  |  |                                 |
  180.           |  --------    --------   |                                 |
  181.            -----------------------------------------------------------
  182.  
  183.                             Figure 1: Join window
  184.  
  185.  
  186.       Once !Split has the first part, you need to tell it where to save the
  187.       joined file. To do this, simply drag the file icon to the directory where
  188.       you want it saved, or type the path into the text icon and press Save.
  189.       Pressing Save without a full path in the text icon, will save the file in
  190.       the current directory. When each part is joined, you need to give !Split
  191.       the next one. To do this, either double click on the file (filetyped as
  192.       'Split'), or drag it to the join window or the iconbar icon. If single
  193.       tasking is not enabled, the transfer window will be displayed (see section
  194.       2.4, 'The Transfer Window').
  195.  
  196.       If Cancel is pressed, joining is aborted and the window closes.
  197.  
  198.  
  199.  2.4  The Transfer Window
  200.  
  201.       The transfer window is displayed when splitting or joining is started
  202.       and multi-tasking is enabled. Figure 3 shows an example of the transfer
  203.       window.
  204.  
  205.  
  206.                  -------------------------------------------
  207.                 |   -------------------------------------   |
  208.                 |  |               Reading               |  |
  209.                 |  |sc5.$.!C.Source.Split.test.RaveAler01|  |
  210.                 |   -------------------------------------   |
  211.                 |               589824 bytes read           |
  212.                 |               458752 bytes written        |
  213.                 |  -------   --------   --------   -------  |
  214.                 | | Abort | | Faster | | S-Task | | Pause | |
  215.                 |  -------   --------   --------   -------  |
  216.                  -------------------------------------------
  217.  
  218.                           Figure 1: Transfer window
  219.  
  220.  
  221.       The transfer window shows what the program is doing and on what file, it
  222.       also shows the number of bytes read and written. The function of the
  223.       buttons are outlined below:-
  224.  
  225.       Abort             This will abort the operation, and close the window.
  226.  
  227.       Faster/Slower     This will disable/enable the display of information in
  228.                         the window, resulting in slightly faster operation. This
  229.                         lasts for the duration of the current file operation.
  230.  
  231.       S-Task            This will put the program into single task mode for the
  232.                         duration of this file operation only.
  233.  
  234.       Pause/Continue    This will pause/resume the transfer operation.
  235.  
  236.  
  237.       Please note, once in single task mode, control is removed from the
  238.       transfer window.
  239.  
  240.  
  241.  
  242. 3  Customizing
  243.  
  244.    !Split may be customized is several ways.
  245.  
  246.  
  247.  3.1  Changing the buffer size
  248.  
  249.       First you need to edit the !Run file. To do this, open the application
  250.       directory by holding down the Shift key and double clicking on the !Split
  251.       icon. Once inside, load the !Run file into your favorite text editor.
  252.  
  253.       To change the maximum buffer size, increase or decrease the value of the
  254.       -max option on the WimpSlot command. For example:-
  255.  
  256.       WimpSlot -min 96k -max 640k
  257.  
  258.       Please do not change the -min size.
  259.  
  260.  
  261.  3.2  Iconbar menu
  262.  
  263.       The default status of the Faster and Single Task options in the iconbar
  264.       menu may be set. To do this, load the !Run file into a text editor (as
  265.       above), add or remove the following commands in the line beginning with
  266.       Run <Split$Dir>.!RunImage
  267.  
  268.       -faster           This will default the Faster option to on.
  269.  
  270.       -singletask       This will default the Single Task option to on.
  271.  
  272.  
  273.       For example, if I want !Split to start up with Faster option selected, I
  274.       would have the following line:-
  275.  
  276.       Run <Split$Dir>.!RunImage -faster %*0
  277.  
  278.  
  279.       Please note, as only one of these options may be selected at once,
  280.       -singletask would take priority.
  281.  
  282.  
  283.  3.3  Single save
  284.  
  285.       The default status of the Single save button in the split window may be
  286.       set. Edit the !Run file as above and add or remove -singlesave. For
  287.       example, to have single save on, your Run command may now look like this:-
  288.  
  289.       Run <Split$Dir>.!RunImage -faster -singlesave %*0
  290.  
  291.  
  292.  3.4  Filesize
  293.  
  294.       To set the default filesize, edit the !Run file as above and add the
  295.       following option to the Run command:-
  296.  
  297.       -filesize n       Where n is the filesize in K (1024 bytes).
  298.  
  299.  
  300.       For example, your Run command may now look like this:-
  301.  
  302.       Run <Split$Dir>.!RunImage -faster -singlesave -filesize 710 %*0
  303.  
  304.  
  305.       The size is now suitable for saving to double density DOS formatted floppy
  306.       disks.
  307.  
  308.  
  309.  3.5  Filesize menu
  310.  
  311.       The filesize menu may also be customized. To do this, open the Resources
  312.       directory, and load the SizeMenu file into your text editor. The format is
  313.       simple, just supply a list of numbers (one per line please). The next time
  314.       you start !Split, it should read in your new menu.
  315.  
  316.  
  317.  
  318. 4  History
  319.  
  320.    Versions 1.xx are command line versions, which are supported along side the
  321.    desktop versions (2.00 and greater).
  322.  
  323.    • Version 1.00-1.08  These were the original command line versions compiled
  324.                         on several different computers.
  325.  
  326.    • Version 1.10       This version has a new file format, a header is put at
  327.                         the beginning of each part, and is used to join files in
  328.                         the correct order. This version is compatible with the
  329.                         desktop version (2.00 and greater).
  330.  
  331.    • Version 1.11       Slightly increased memory allocation for filenames, and
  332.                         added a small check needed for DEC Ultrix compilers.
  333.  
  334.    • Version 1.12       Added -interactive option to allow direct reading and
  335.                         writing of floppy disks. This option enables different
  336.                         paths to be given for each part, removing the need, for
  337.                         example, to load all the parts onto the hard disk before
  338.                         joining.
  339.  
  340.    • Version 1.12c      Supports official Acorn filetype.
  341.  
  342.    • Version 2.00       First desktop version.
  343.  
  344.    • Version 2.01       Added ability to open join window with the Adjust
  345.                         button, and to drag files to the window. This made it
  346.                         easier to start the joining procedure if the files
  347.                         aren't filetyped as 'Split'. Fixed bug with ArcFS image
  348.                         file system doesn't complain about archives any more.
  349.  
  350.    • Version 2.02       Added filesize menu, fixed a few small bugs.
  351.  
  352.    • Version 2.10       Big jump from 2.02 to 2.10 because I decided to
  353.                         completely re-write the program from scratch without the
  354.                         use of RISC_OSLib functions. This has made the program
  355.                         easier to write, control, modify, and has made the code
  356.                         smaller and it also runs faster.
  357.  
  358.    • Version 2.11       Added multi-tasking option. Fixed a few small bugs.
  359.  
  360.    • Version 2.11c      Fixed menu item height. As of this version, !Split uses
  361.                         an official Acorn filetype.
  362.  
  363.  
  364.  
  365. 5  Files supplied
  366.  
  367.    The following files are supplied inside the !Split application directory.
  368.  
  369.    !Boot
  370.    !Help                  This file.
  371.    HelpPS                 PostScript version of this file.
  372.    !Run
  373.    !RunImage              Main program.
  374.    !Sprites, !Sprites22
  375.    Resources (directory)  Contains ...
  376.      SizeMenu             Definition of the filesize menu (see section 3,
  377.                           'Customizing').
  378.      Toggle3D             Toggles the state of the 3D bit in CMOS RAM.
  379.      ToggleDRAG           Toggles the state of solid dragging bit in CMOS RAM.
  380.      Template2D           2D window templates.
  381.      Template3D           3D window templates, RiscOS 3 or greater.
  382.  
  383.    The program will automatically select the correct templates file to use.
  384.  
  385.  
  386.  
  387. 6  Acknowledgments
  388.  
  389.    I would like to thank Andrew Sellors for his suggestions and help in testing
  390.    this application.
  391.  
  392. ================================================================================
  393.