home *** CD-ROM | disk | FTP | other *** search
/ Resource Library: Multimedia / Resource Library: Multimedia.iso / archvrs / amiga / lha-sfx / lhasfx.man < prev    next >
Encoding:
Text File  |  1992-03-21  |  9.1 KB  |  362 lines
  1.  
  2.  
  3.      
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                             LhASFX User's Guide
  15.  
  16.                   Evaluation Version 1.2 - March 21, 1992
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.              ###      ###       #####    #####   ##### ##    ##
  33.               ##       ##      ###  ##  ###  ## ###     ##  ##
  34.               ##       ##      ##   ##  ##      ##      ##  ##
  35.               ##       #####   #######   #####  ####     ####
  36.               ##       ##  ##  ##   ##      ### ##      ##  ##
  37.               ##   ##  ##  ##  ##   ##  ##   ## ##      ##  ##
  38.              #######  ###  ### ##   ###  #####  ##     ##    ##
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.                           Written by Stefan Boberg
  57.                    Copyright (c) 1991,92 by Stefan Boberg
  58.  
  59.  
  60.      
  61.  
  62.  
  63.      V1.2                   LhASFX User's Guide                  Page 1
  64.  
  65.  
  66.  
  67.  
  68.      0 - LhA      
  69.  
  70.         LhASFX is  part  of the LhA family of programs.  The same rules
  71.      applies  to  this  program as LhA - read the `politics' section of
  72.      the  manual for more information.  When you register yourself as a
  73.      user  of  LhA,  you  automatically register as a user of LhASFX as
  74.      well, and will receive updates at the same time as LhA updates.  
  75.  
  76.      1 - Introduction      
  77.  
  78.         LhASFX sole  purpose  in  life  is  to  create SFX-archives.  A
  79.      SFX-archive  is  a  normal  LhA  archive with a special executable
  80.      SFX-header  prepended to it, which makes it possible to list, test
  81.      and  extract  files  from  the  archive  by means of executing it.
  82.      Those  of  you who have used LHA or ARJ on MSDOS machines probably
  83.      know  what  it  is.  It was written primarily to provide me with a
  84.      good  way  of  distributing  my LhA package on BBS'es, FidoNet and
  85.      other  computer networks. I think it is rather silly to distribute
  86.      an  archiver  in an archive-file, since you then will need another
  87.      archiver,  which  may also be archived and so on..  I've even seen
  88.      examples  where the archiver was distributed in an archive created
  89.      by itself! :) 
  90.  
  91.         There are  other  similar  programs  for the Amiga, but none as
  92.      fast,  flexible  and  efficient as LhASFX.  The other programs use
  93.      compression  methods  that  have  a much smaller compression ratio
  94.      than  that  of  LhASFX,  and  use  their  own archive file format.
  95.      LhASFX  uses  the  standard  LhArc/LhA  archive format, and LhASFX
  96.      archives  can  easily  be converted to standard LhArc/LhA archives
  97.      with  a  simple  command  ('UnSFX',  part  of the LhA package), or
  98.      manipulated with the LhA archiving program directly.  
  99.  
  100.         Another advantage  LhASFX  has  compared  to other archivers is
  101.      that  LhASFX  handles  archives  of  any  size in only 48K of RAM.
  102.      While  other programs load the entire archive into memory at once,
  103.      LhASFX loads the data when it needs it.  
  104.  
  105.      2 - System requirements     
  106.  
  107.         The LhASFX  program  will run on any Amiga system with at least
  108.      512KB RAM and one diskdrive.  
  109.  
  110.         The SFX-Module  only  uses  about 48K memory when decompressing
  111.      or   listing   archives,   regardless   of   archive   size.   The
  112.      decompression  routines  of the SFX-module are less optimized than
  113.      those  of  the real archiver LhA, because I consider size as being
  114.      more  important  than  speed  in  this  case  (it  still  is fast,
  115.      anyway!).  
  116.  
  117.      3 - How to use it   
  118.  
  119.  
  120.      
  121.  
  122.  
  123.      V1.2                   LhASFX User's Guide                  Page 2
  124.  
  125.  
  126.  
  127.         Using the  LhASFX program to create SFX archives is simple, the
  128.      command line syntax is as follows: 
  129.  
  130.      LhASFX <Archive> [<destfile>] 
  131.  
  132.  
  133.         Where <Archive>  is  the  name  of  the  archive  you  wish  to
  134.      convert,  with  or  without  the  `.lha' or `.lzh' extension.  The
  135.      optional  <destfile>  is  the  name  of the file you would like to
  136.      hold  the  SFX  archive.   If  no  <destfile> is specified, LhASFX
  137.      takes  the basename of <Archive> (i.e.  strips any extensions) and
  138.      appends  a  `.run'  suffix  to  it  to  indicate  that  it  is  an
  139.      executable  SFX  file.   If  you  specify a <destfile> without the
  140.      `.run'  extension  LhASFX  will  put one there.  DO NOT DISTRIBUTE
  141.      LhASFX ARCHIVES WITH ANY OTHER SUFFIX THAN `.RUN' PLEASE!! 
  142.  
  143.  
  144.      3.1 `.displayme' files      
  145.  
  146.  
  147.         Displayme files  are  files  with  names ending in `.displayme'
  148.      (case  significant).  These  files  will be printed to STDOUT when
  149.      the  archive  is  run (unpacked). In addition, the SFX module will
  150.      ask  the  user if he/she wants to go on. If the user's response to
  151.      the  question  is  negative,  the  SFX  module will skip all files
  152.      until  the  next  .displayme  file.  Otherwise all files up to the
  153.      next  .displayme file will be extracted. If the user responds with
  154.      an  `s'  (for  `Skip  rest')  no more files in the archive will be
  155.      extracted.  If the user responds with `a' all remaining files will
  156.      be  extracted.  This  feature  is  useful for allowing the user to
  157.      select  what  parts  of  an  archive he/she wishes to extract (for
  158.      example  you  could  separate  sources, binaries and ARexx scripts
  159.      from each other this way).  
  160.  
  161.         An example: 
  162.  
  163.         Say that  you  have 6 files, 2 source files, 2 binaries and two
  164.      script  files  which  you  want  the user to be able to optionally
  165.      extract. To do this you will have to: 
  166.  
  167.         1) Create  3  .displayme files, for example `source.displayme',
  168.      `bin.displayme',  `scripts.displayme'.  In the displayme files you
  169.      write  a  brief  description  of what the files contain and at the
  170.      end a question phrase such as `extract sources?'.  
  171.  
  172.         2) Add  the  first displayme file to the archive with `LhA -2 a
  173.      arc source.displayme'.  
  174.  
  175.         3) Then  add  the  two  source  files  with  `LhA -2 a arc PM.c
  176.      Lh.c'.  
  177.  
  178.  
  179.  
  180.      
  181.  
  182.  
  183.      V1.2                   LhASFX User's Guide                  Page 3
  184.  
  185.  
  186.         4) Repeat  step  2  and  3  above  for  each  part  (`bin'  and
  187.      `scripts' in this case) 
  188.  
  189.         5) Create a SFX archive with `LhASFX arc'.  
  190.  
  191.         6) All done! 
  192.  
  193.  
  194.         Note that  you  have  to  add the `.displayme' files separately
  195.      since  LhA  adds  the  files  in  alphabetic order, and not in the
  196.      order specified on the command line.  
  197.  
  198.  
  199.      4 - Limitations of the SFX module  
  200.  
  201.         The SFX  module  only  handles  the -lh5- and -lh4- compression
  202.      modes,  and  of course stored files (-lh0-).  It does *NOT* handle
  203.      the   old   -lh1-  compression  mode.   If  you  want  to  make  a
  204.      SFX-archive  of  an  archive  which  uses  the  -lh1- compression,
  205.      simply  use the LhA `c' command to convert to `-lh5-' compression,
  206.      or  repack the normal way (unpack somewhere and then pack it again
  207.      with the -2 switch).  
  208.  
  209.         The SFX module does NOT handle multiple-volume archives.  
  210.  
  211.         This is  the  evaluation  version  of  LhASFX,  and it does not
  212.      contain  all features that the `real' version registered LhA users
  213.      get.   The  `real' LhASFX contains some more switches, and the SFX
  214.      module is smaller.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.      
  241.  
  242.  
  243.      V1.2                   LhASFX User's Guide                  Page 4
  244.  
  245.  
  246.      5 Politics       
  247.  
  248.         For disclaimers,  licensing  information  etc., please refer to
  249.      the user's manual for the LhA archiver.  
  250.  
  251.      5.1 Using LhASFX for distribution    
  252.  
  253.         ShareWare and  FreeWare  authors  are  free  to  use LhASFX for
  254.      distributing  their  creations  if the conditions listed below are
  255.      met.  Registration  is  not required, but appreciated (you can get
  256.      special  versions).  Commercial  usage  is  not  allowed, unless a
  257.      written  agreement  is  made  with  the  author  of LhASFX (Stefan
  258.      Boberg) first.  
  259.  
  260.  
  261.         Usage conditions: 
  262.  
  263.  
  264.         If LhASFX  is  used  to prepare distribution on magnetic media,
  265.      the   entire   LhASFX  original  unmodified  distribution  archive
  266.      contents  must  be  included on at least one of the disks/whatever
  267.      in  a  subdirectory  named  `LhASFX'.   The  relevant  files  are:
  268.      `LhASFX'   -   main  program,  `LhASFX.man'  -  this  manual,  and
  269.      `Update.txt' - Program modification history.  
  270.  
  271.  
  272.         The LhASFX  program  used  to  create the SFX archives must not
  273.      have been modified.  
  274.  
  275.  
  276.         The LhASFX-created  SFX  archives  must  have  names  ending in
  277.      `.RUN'  and  must  not  have  been modified after LhASFX generated
  278.      them.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.      
  301.  
  302.  
  303.      
  304.  
  305.  
  306.                              Table Of Contents
  307.  
  308.                                 LhASFX V1.2
  309.  
  310.      0 - LhA     ................................................    1
  311.      1 - Introduction     .......................................    1
  312.      2 - System requirements    .................................    1
  313.      3 - How to use it  .........................................    1
  314.         3.1 `.displayme' files     ..............................    2
  315.      4 - Limitations of the SFX module ..........................    3
  316.      5 Politics      ............................................    4
  317.         5.1 Using LhASFX for distribution   .....................    4
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.                                    - I -
  361.  
  362.