home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / cli / mjoin.lha / mjoin.doc < prev    next >
Encoding:
Text File  |  1995-01-31  |  5.0 KB  |  134 lines
  1.  
  2.                                    MJoin V1.1
  3.                             © 1995 by Harald Löffler
  4.  
  5.      PREFACE 
  6.  
  7.      The programs and files in this distribution are freely distributable, 
  8.      but are also Copyright © Harald Löffler. They may be freely distributed
  9.      as long as no more than a nominal fee is charged to cover time and
  10.      copying costs. No commercial usage is permitted without written permission
  11.      from the author. Everything in this distribution must be kept together, in
  12.      original unmodified form. The only thing I ask for is to send me a mail and
  13.      tell me, what you think about MJoin.
  14.      The above is generally known as mailware.  
  15.  
  16.  
  17.  
  18.      1. Introduction 
  19.      --------------- 
  20.  
  21.      For all those that frequently have to join files with a similar basename,
  22.      probably splitted by MSplit (or some other stuff like bsplit, split etc.:-[),
  23.      I´ve written this little tool. It can do this job in a very easy way.
  24.                                Hope ya like it ;-)
  25.  
  26.  
  27.  
  28.      2. Installation
  29.      ---------------
  30.  
  31.      Just copy MJoin to your C: directory and the doc to your favourite DOC-dir.
  32.      That´s all.
  33.  
  34.  
  35.      
  36.      3. How to use it
  37.      ----------------
  38.  
  39.      The easiest way is this one:    MJoin basename.foo*
  40.      
  41.      This will join all files beginning with basename.foo followed by a number.
  42.      Using MJoin this way will join all files from number 0 on until the following
  43.      file doesn´t exist anymore, e.g. You have basename.foo0, basename.foo1 and
  44.      basename.foo3, only the first two files will be joined.
  45.      In other purposes you have to use the various parameters.
  46.  
  47.  
  48.  
  49.      4. The parameters
  50.      -----------------
  51.      
  52.      The general form is:
  53.      
  54.      MJoin <basename> [FROM start] [UPTO end] [AS newname]
  55.                       [NOFRAC|NULL|QUIET|FORCE|ADD]
  56.  
  57.      In V1.1 (now) you have to place the wildcard-sysmbol * at the position the 
  58.      numbers have to appear in the filenames.
  59.      E.g. if files like abc1def, abc2def, .. should be joined, the basename should
  60.      be like this: abc*def
  61.  
  62.      FROM means the first number to search for, analogous means UPTO the last
  63.      number to join. If you use the UPTO Parameter MJoin will go on until this number
  64.      is reached, even if some files do not exist. If you want MJoin to stop in that
  65.      case you have to use NOFRAC. This causes MJoin to stop at the first non existing
  66.      file in the row.
  67.      
  68.      With AS you can specify a name for the file that will be created, if not the
  69.      basename (without the number of course) will be used. If the AsName allready
  70.      exists a warning will be displayed and you can use FORCE to overwrite it.
  71.  
  72.      ADD allows you to append an existing file.
  73.  
  74.      The QUIET option forces MJoin to stop all printouts unless there is something
  75.      wrong with the parameters.
  76.  
  77.      The NULL option is something special. If you use bsplit, you get files in the
  78.      following form: 00 01 02 03 ... 10 11 ... and so on. This files do not have a
  79.      real basename. Thus if you choose the NULL-Parameter you can join them by using
  80.      the * as basename. But you have to specify an AsName for them.
  81.  
  82.  
  83.  
  84.      5. DISCLAIMER
  85.      -------------
  86.      
  87.      This program is released as is. No warranty on any damage or misfunction.
  88.      Use it or kick it.
  89.      
  90.      
  91.      
  92.      6. Author, bugs, to do´s, etc.
  93.      -----------------------------
  94.  
  95.      First of all I want to say that I´m very sorry about uploading the wrong
  96.      doc with the last version.
  97.  
  98.      Stuff I want to do in future: Tell me what you want!
  99.  
  100.      I´ve included the source, so you can easily port it to any platform, that
  101.      supports ANSI-C. The only thing you have to do is delete the following lines
  102.  
  103.        #include <exec/types.h>            /* BOOL etc. Type-Definitions     */
  104.        #include <dos/dos.h>               /* Definition of RETURN_FAIL etc. */
  105.  
  106.      and add this ones
  107.  
  108.        #define BOOL int
  109.        #define TRUE (0 == 0)
  110.        #define FALSE (0 == 1)
  111.        #define RETURN_OK                 0
  112.        #define RETURN_WARN               5
  113.        #define RETURN_ERROR             10
  114.        #define RETURN_FAIL              20
  115.  
  116.      Maybe you have to replace the Umlaut in my name (sorry, but AMIGAs have no
  117.      problems with this ;-)
  118.  
  119.  
  120.      If you have found some of this ugly bugs :( , want to make some suggestions :)
  121.      or tell me :-) something else, write to:
  122.  
  123. ----------------------------------------------------------------------------------
  124. |      _/    _/     _/    |  Harald Loeffler                         |     __o   |    
  125. |     _/    _/     _/     |  Schenkenbergstrasse 12                  |   _`\<;   | If possible,
  126. |    _/_/_/_/     _/      |  73733 Esslingen                         |  (*)/(*)  |  please use
  127. |   _/    _/     _/       |  Tel: (07 11) 32 41 93                   |  MT-BIKE  |   e-mail!
  128. |  _/    _/     _/_/_/_/  |  E-Mail: harry@studbox.uni-stuttgart.de  | forever ! |
  129. ----------------------------------------------------------------------------------
  130.  
  131.              You think MS-WINDOWS ist the longest bug overall?
  132.  
  133.           There will always be an update, so wait for WINDOWS 95!
  134.