home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / SHAR324X.ZIP / SHAR.MAN < prev   
Text File  |  1990-05-21  |  7KB  |  181 lines
  1. NAME
  2.      shar - create shell archives
  3.  
  4. SYNOPSIS
  5.      shar [ options ] [ file1 ... ]
  6.      shar -S [ options ]
  7.  
  8. DESCRIPTION
  9.      Shar 3.23 (or later) creates "shell archives" (or shar
  10.      files) which are in text format and can be mailed. These
  11.      files may be unpacked later by executing them with /bin/sh.
  12.      The resulting archive is sent to standard out unless the -o
  13.      option is given.  A wide range of features provide extensive
  14.      flexibility in manufacuring shars and in specifying shar
  15.      "smartness." Archives may be "vanilla" or comprehensive.
  16.  
  17.      OPTIONS
  18.  
  19.      Options can be given in any order. Some options depend on
  20.      each other:
  21.           The -o option is required if the -l or -L option is used.
  22.           The -n option is required if the -a option is used.
  23.           The -x and -L option are incompatible.
  24.           See -V below.
  25.  
  26.      -V   Produce "vanilla" shars which rely only upon the
  27.           existence of sed and echo in the unsharing environment.
  28.           In addition, "if test" must also be supported if the -X
  29.           option is used.  The -V silently disables options
  30.           offensive to the "network cop" (or "brown shirt"), but
  31.           does warn you if it is specified with -b, -C, -p or -M
  32.           (any of which does or might require uudecode or
  33.           compress in the unsharing environment).
  34.  
  35.      -v   Verbose OFF. Disables the inclusion of comments to be
  36.           output when the archive is unpacked.
  37.  
  38.      -w   Do NOT check with 'wc -c' after unpack. The default is
  39.           to check.
  40.  
  41.      -n name
  42.           Name of archive to be included in the header of the
  43.           shar files.  See the -a switch.
  44.  
  45.      -a   Allows automatic generation of headers:
  46.                Submitted-by: who@where
  47.                Archive-name: <name>/part##
  48.           The <name> must be given with the -n switch.  If name
  49.           includes a '/' "/part" isn't used. Thus:
  50.                -n xyzzy                      produces:
  51.                                              xyzzy/part01
  52.                                              xyzzy/part02
  53.  
  54.                -n xyzzy/patch                produces:
  55.                                              xyzzy/patch01
  56.                                              xyzzy/patch02
  57.  
  58.                -n xyzzy/patch01.             produces:
  59.                                              xyzzy/patch01.01
  60.                                              xyzzy/patch01.02
  61.  
  62.           The who@where can be explicitly stated with the -s
  63.           switch if the default isn't apropriate.  Who@where is
  64.           essentially built as `whoami`@`uname`.
  65.  
  66.      where@u-3p -s who@where
  67.           Override automatically determined submitter name.
  68.  
  69.      -x   Don't overwrite existing files. The unpack will check
  70.           for an existing file before unpacking a given file from
  71.           the archive.
  72.  
  73.      -X   Interactively overwrite existing files (DO NOT USE FOR
  74.           SHARS SUBMITTED TO THE NET).
  75.  
  76.      -b   Treat all files as binary, use uuencode prior to pack-
  77.           ing. This increases the size of the archive. The reci-
  78.           pient must have uudecode in order to unpack.  (USE OF
  79.           UUENCODE IS NOT APPRECIATED BY MANY ON THE NET).
  80.  
  81.      -t   Treat all files as text (default).
  82.  
  83.      -C   Compress and uuencode all files prior to packing. The
  84.           recipient must have uudecode and uncompress in order to
  85.           unpack (USE OF UUENCODE AND COMPRESS IS NOT APPRECIATED
  86.           BY MANY ON THE NET).
  87.  
  88.      -p   Allow positional parameter options. The options "-b"
  89.           and "-t" and "-C" may be embedded, and files to the
  90.           right of the option will be processed in the specified
  91.           mode.
  92.  
  93.      -M   Mixed mode. Determine if the files are text or binary
  94.           and archive correctly.  Files found to be binary are
  95.           uudecoded prior to packing (USE OF UUENCODE IS NOT
  96.           APPRECIATED BY MANY ON THE NET).
  97.  
  98.      -P   Use temporary files instead of pipes in the shar file.
  99.  
  100.      -c   Start the shar with a cut line. A line saying 'Cut
  101.           here' is placed at the start of each output file.
  102.  
  103.      -f   Restore by filename only, rather than path. This option
  104.           causes only file names to be used, which is useful when
  105.           building a shar from several directories, or another
  106.           directory.
  107.  
  108.      -d XXX
  109.           Use XXX to delimit the files in the shar instead of
  110.           SHAR_EOF.  This is for those who want to personalize
  111.           their shar files.
  112.  
  113.      -o XXX
  114.           Save the archive to files XXX.01 thru XXX.nn instead of
  115.           standard out.  Must be used when the -l or the -L
  116.           switches are used
  117.  
  118.      -l XX
  119.           Limit the output file size to XXk bytes but don't split
  120.           input files.
  121.  
  122.      -L XX
  123.           Limit output file size to XXk bytes and split files if
  124.           necessary. The archives created with this option must
  125.           be unpacked in correct order.
  126.  
  127.      -S   Read list of files to be packed from the standard input
  128.           rather than from the command line.  Input must be in a
  129.           form similar to that generated by the find command, one
  130.           filename per line.  This switch is especially useful
  131.           when the command line will not hold the list of files
  132.           to be packed. For example:
  133.  
  134.           find . -type f -print | sort | shar -S -C -L50 -o /tmp/big
  135.  
  136.           If -p is specified on the command line, then the
  137.           options "-b" and "-t" and "-C" may be included in the
  138.           standard input (on a line separate from filenames).
  139.           The maximum number of lines of standard input, file
  140.           names and options, may not exceed 1024.
  141.  
  142. EXAMPLES
  143.      shar *.c > cprog.shar                # all C prog sources
  144.      shar -v *.[ch] > cprog.shar          # non-verbose, .c and .h files
  145.      shar -b -l28 -oarc.sh *.arc          # all binary .arc files, into
  146.                                           # files arc.sh.01 thru arc.sh.NN
  147.      shar -f /lcl/src/u*.c > u.sh         # use only the filenames
  148.  
  149. WARNINGS
  150.      Use of the -b, -M or -C may slow the archive process consid-
  151.      erably, depending on the number of files.
  152.  
  153.      Use of -X produces shars which WILL cause problems with many
  154.      unshar procedures.  Use this feature only for archives to be
  155.      passed among agreeable parties.  Certainly, -X is NOT for
  156.      shell archives which are to be submitted to Usenet.  Usage
  157.      of -b or -C in net shars will cause you to be flamed off the
  158.      earth.
  159.  
  160. SEE ALSO
  161.      unshar(1)
  162.  
  163. DIAGNOSTICS
  164.      Error messages for illegal or incompatible options, for
  165.      non-regular, missing or inaccessible files or for (unlikely)
  166.      memory allocation failure.
  167.  
  168. AUTHORS
  169.      shar3 is a derived work based on the efforts of:
  170.      decvax!microsof!uw-beave!jim (James Gosling at CMU)
  171.      Michael A. Thompson, Dalhousie University, Halifax, N.S., Canada
  172.      davidsen@sixhub (Bill Davidsen)
  173.      rhg@CPS.COM (Richard H. Gumpertz)
  174.      colas@avahi.inria.fr (Colas Nahaboo)
  175.      dennis%nanovx@gatech.edu (Dennis Boylan)
  176.      wht%n4hgf@gatech.edu (Warren Tucker)
  177.      (other anonymous persons)
  178.  
  179.      man pages:
  180.      jhd@irfu.se (Jan Dj{rv)
  181.