shar/shar.1

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