home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD2.bin / bbs / gnu / sharutils-4.1-src.lha / sharutils-4.1 / sharutils.info (.txt) < prev    next >
GNU Info File  |  1994-11-06  |  20KB  |  398 lines
  1. This is Info file sharutils.info, produced by Makeinfo-1.55 from the
  2. input file sharutils.texi.
  3. START-INFO-DIR-ENTRY
  4. * Shar utilities: (sharutils).
  5.                                 GNU set of shar utilities.
  6. * shar invocation: (sharutils) shar invocation.
  7.                                 Produce a shell archive out of many files.
  8. * unshar invocation: (sharutils) unshar invocation.
  9.                                 Recontruct files out of a shell archive.
  10. END-INFO-DIR-ENTRY
  11.    This file documents the GNU set of shar utilities.
  12.    Copyright (C) 1994 Free Software Foundation, Inc.
  13.    Permission is granted to make and distribute verbatim copies of this
  14. manual provided the copyright notice and this permission notice are
  15. preserved on all copies.
  16.    Permission is granted to copy and distribute modified versions of
  17. this manual under the conditions for verbatim copying, provided that
  18. the entire resulting derived work is distributed under the terms of a
  19. permission notice identical to this one.
  20.    Permission is granted to copy and distribute translations of this
  21. manual into another language, under the above conditions for modified
  22. versions, except that this permission notice may be stated in a
  23. translation approved by the Foundation.
  24. File: sharutils.info,  Node: Top,  Next: Introduction,  Prev: (dir),  Up: (dir)
  25. GNU `shar' utilities
  26. ********************
  27.    GNU `shar' makes so-called shell archives out of many files,
  28. preparing them for transmission by electronic mail services.  GNU
  29. `unshar' helps unpacking shell archives after reception.  This is
  30. release 4.1.
  31. * Menu:
  32. * Introduction::                Introduction to both programs
  33. * shar invocation::             Invoking the `shar' program
  34. * unshar invocation::           Invoking the `unshar' program
  35. * Miscellaneous::               Miscellaneous considerations
  36.  -- The Detailed Node Listing --
  37. Creating shell archives
  38. * Selecting::                   Selecting files
  39. * Splitting::                   Splitting output
  40. * Headers::                     Controlling the shar headers
  41. * Stocking::                    Selecting how files are stocked
  42. * Transmission::                Protecting against transmission
  43. * Kinds::                       Producing different kinds of shar
  44. File: sharutils.info,  Node: Introduction,  Next: shar invocation,  Prev: Top,  Up: Top
  45. Introduction to both programs
  46. *****************************
  47.    GNU `shar' makes so-called shell archives out of many files,
  48. preparing them for transmission by electronic mail services.  A "shell
  49. archive" is a collection of files that can be unpacked by `/bin/sh'.  A
  50. wide range of features provide extensive flexibility in manufacturing
  51. shars and in specifying shar *smartness*.  *Note shar invocation::.
  52.    GNU `unshar' scans mail messages looking for the start of a shell
  53. archive.  This removes the mail headers and any lines of
  54. correspondence.  The body of the archive is then unpacked by a copy of
  55. the shell.  It can process multiple files at once.  It may also process
  56. files containing concatenated shell archives.  *Note unshar
  57. invocation::.
  58.    GNU `shar' has a long history.  All along this long road, numerous
  59. users contributed various improvements.  The file `THANKS', from the
  60. GNU `shar' distribution, contain all names still having valid email
  61. addresses, as far as we know.
  62.    Please help me getting the history straight, for the following
  63. information is approximative.  James Gosling wrote the public domain
  64. `shar 1.x'.  William Davidsen rewrote it as `shar 2.x'.  Warren Tucker
  65. brought modifications and called it `shar 3.x'.  Richard Gumpertz
  66. maintained it until 1990.  Franc,ois Pinard, from the public domain
  67. `shar 3.49', made `GNU shar 4.x', in 1994.  Some modules and other code
  68. sections were freely borrowed from other GNU distributions, bringing
  69. this `shar' under the terms of the GNU General Public License.
  70.    Your feedback helps us to make a better and more portable product.
  71. Mail suggestions and bug reports (including documentation errors) for
  72. these programs to `bug-gnu-utils@prep.ai.mit.edu'.
  73. File: sharutils.info,  Node: shar invocation,  Next: unshar invocation,  Prev: Introduction,  Up: Top
  74. Invoking the `shar' program
  75. ***************************
  76.    The format of the `shar' command is one of:
  77.      shar [ OPTION ] ... FILE ...
  78.      shar -S [ OPTION ] ...
  79.    In the first form, the file list is given as command arguments.  In
  80. the second form, the file list is read from standard input.  The
  81. resulting archive is sent to standard output unless the `-o' option is
  82. given.
  83.    Options can be given in any order.  Some options depend on each
  84. other: the `-o' option is required if the `-l' or `-L' option is used.
  85. The `-n' option is required if the `-a' option is used.  Also see `-V'
  86. below.
  87.    Some options are special purpose:
  88. `--help'
  89.      Print a help summary on standard output, then immediately exits.
  90. `--version'
  91.      Print the version number of the program on standard output, then
  92.      immediately exits.
  93. `--quiet'
  94.      Verbose *off* at `shar' time.  Messages are usually issued on
  95.      standard error to let the user follow the progress, while making
  96.      the archives.  This option inhibits these messages.
  97. * Menu:
  98. * Selecting::                   Selecting files
  99. * Splitting::                   Splitting output
  100. * Headers::                     Controlling the shar headers
  101. * Stocking::                    Selecting how files are stocked
  102. * Transmission::                Protecting against transmission
  103. * Kinds::                       Producing different kinds of shar
  104. File: sharutils.info,  Node: Selecting,  Next: Splitting,  Prev: shar invocation,  Up: shar invocation
  105. Selecting files
  106. ===============
  107. `--intermix-type'
  108.      Allow positional parameter options.  The options `-M', `-B', `-T',
  109.      `-z' and `-Z' may be embedded, and files to the right of the
  110.      option will be processed in the specified mode.  Without the `-p'
  111.      option, embedded options would be interpreted as filenames.  *Note
  112.      Stocking:: for more information on these options.
  113. `--stdin-file-list'
  114.      Read list of files to be packed from the standard input rather
  115.      than from the command line.  Input must be one filename per line.
  116.      This switch is especially useful when the command line will not
  117.      hold the list of files to be packed.  For example:
  118.           find . -type f -print | shar -S -o /tmp/big.shar
  119.      If `-p' is specified on the command line, then the options `-M',
  120.      `-B', `-T', `-z' and `-Z' may be included in the standard input
  121.      (on a line separate from filenames).  The maximum number of lines
  122.      of standard input, file names and options, may not exceed 1024.
  123. File: sharutils.info,  Node: Splitting,  Next: Headers,  Prev: Selecting,  Up: shar invocation
  124. Splitting output
  125. ================
  126. `-o PREFIX'
  127. `--output-prefix=PREFIX'
  128.      Save the archive to files `PREFIX.01' through `PREFIX.NNN' instead
  129.      of standard output.  This option *must* be used when the `-l' or
  130.      the `-L' switches are used.
  131. `-l SIZE'
  132. `--whole-size-limit=SIZE'
  133.      Limit the output file size to SIZE times 1024 bytes but don't
  134.      split input files.  This allows the recipient of the shell archives
  135.      to unpack them in any order.
  136. `-L SIZE'
  137. `--split-size-limit=SIZE'
  138.      Limit output file size to SIZE times 1024 bytes and split files if
  139.      necessary.  The archives created with this option must be unpacked
  140.      in the correct order.  If the recipient of the shell archives
  141.      wants to put all of them in a single folder, she shall save them
  142.      in the correct order for `unshar', used with option `-e', to
  143.      unpack them all at once.  *Note unshar invocation::.
  144.      For people used to saving all the shell archives into a single mail
  145.      folder, care must be taken to save them in the appropriate order.
  146.      For those having the appropriate tools (like Masanobu Umeda's
  147.      `rmailsort' package for GNU Emacs), shell archives can be saved in
  148.      any order, then sorted by increasing date (or send time) before
  149.      massive unpacking.
  150. File: sharutils.info,  Node: Headers,  Next: Stocking,  Prev: Splitting,  Up: shar invocation
  151. Controlling the shar headers
  152. ============================
  153. `-n NAME'
  154. `--archive-name=NAME'
  155.      Na