usr.bin/shar/shar.1

   1 .\" Copyright (c) 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)shar.1      8.1 (Berkeley) 6/6/93
  33 .\"
  34 .Dd June 6, 1993
  35 .Dt SHAR 1
  36 .Os BSD 4.4
  37 .Sh NAME
  38 .Nm shar
  39 .Nd create a shell archive of files
  40 .Sh SYNOPSIS
  41 .Nm shar Ar
  42 .Sh DESCRIPTION
  43 .Nm Shar
  44 writes an
  45 .Xr sh 1
  46 shell script to the standard output which will recreate the file
  47 hierarchy specified by the command line operands.
  48 Directories will be recreated and must be specified before the
  49 files they contain (the
  50 .Xr find 1
  51 utility does this correctly).
  52 .Pp
  53 .Nm Shar
  54 is normally used for distributing files by
  55 .Xr ftp  1
  56 or
  57 .Xr mail  1  .
  58 .Sh SEE ALSO
  59 .Xr compress 1 ,
  60 .Xr mail 1 ,
  61 .Xr uuencode 1 ,
  62 .Xr tar 1
  63 .Sh BUGS
  64 .Nm Shar
  65 makes no provisions for special types of files or files containing
  66 magic characters.
  67 .Pp
  68 It is easy to insert trojan horses into
  69 .Nm shar
  70 files.
  71 It is strongly recommended that all shell archive files be examined
  72 before running them through
  73 .Xr sh  1  .
  74 Archives produced using this implementation of
  75 .Nm shar
  76 may be easily examined with the command:
  77 .Bd -literal -offset indent
  78 egrep -v '^[X#]' shar.file
  79 .Ed
  80 .Sh EXAMPLES
  81 To create a shell archive of the program
  82 .Xr ls  1
  83 and mail it to Rick:
  84 .Bd -literal -offset indent
  85 cd ls
  86 shar `find . -print` \&|  mail -s "ls source" rick
  87 .Ed
  88 .Pp
  89 To recreate the program directory:
  90 .Bd -literal -offset indent
  91 mkdir ls
  92 cd ls
  93 ...
  94 <delete header lines and examine mailed archive>
  95 ...
  96 sh archive
  97 .Ed
  98 .Sh HISTORY
  99 The
 100 .Nm
 101 command appears in
 102 .Bx 4.4 .