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 .\" $FreeBSD: src/usr.bin/shar/shar.1,v 1.7.2.2 2001/08/16 13:17:03 ru Exp $
  34 .\"
  35 .Dd June 6, 1993
  36 .Dt SHAR 1
  37 .Os
  38 .Sh NAME
  39 .Nm shar
  40 .Nd create a shell archive of files
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Ar
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 command writes a
  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 The
  57 .Nm
  58 command is normally used for distributing files by
  59 .Xr ftp  1
  60 or
  61 .Xr mail  1  .
  62 .Sh SEE ALSO
  63 .Xr compress 1 ,
  64 .Xr mail 1 ,
  65 .Xr tar 1 ,
  66 .Xr uuencode 1
  67 .Sh BUGS
  68 The
  69 .Nm
  70 command makes no provisions for special types of files or files containing
  71 magic characters.
  72 The
  73 .Nm
  74 command cannot handle files without a newline ('\\n')
  75 as the last character.
  76 .Pp
  77 It is easy to insert trojan horses into
  78 .Nm
  79 files.
  80 It is strongly recommended that all shell archive files be examined
  81 before running them through
  82 .Xr sh  1  .
  83 Archives produced using this implementation of
  84 .Nm
  85 may be easily examined with the command:
  86 .Bd -literal -offset indent
  87 egrep -v '^[X#]' shar.file
  88 .Ed
  89 .Sh EXAMPLES
  90 To create a shell archive of the program
  91 .Xr ls  1
  92 and mail it to Rick:
  93 .Bd -literal -offset indent
  94 cd ls
  95 shar `find . -print` \&|  mail -s "ls source" rick
  96 .Ed
  97 .Pp
  98 To recreate the program directory:
  99 .Bd -literal -offset indent
 100 mkdir ls
 101 cd ls
 102 \&...
 103 <delete header lines and examine mailed archive>
 104 \&...
 105 sh archive
 106 .Ed
 107 .Sh HISTORY
 108 The
 109 .Nm
 110 command appeared in
 111 .Bx 4.4 .