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$
  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 EXAMPLES
  63 To create a shell archive of the program
  64 .Xr ls 1
  65 and mail it to Rick:
  66 .Bd -literal -offset indent
  67 cd ls
  68 shar `find . -print` \&| mail -s "ls source" rick
  69 .Ed
  70 .Pp
  71 To recreate the program directory:
  72 .Bd -literal -offset indent
  73 mkdir ls
  74 cd ls
  75 \&...
  76 <delete header lines and examine mailed archive>
  77 \&...
  78 sh archive
  79 .Ed
  80 .Sh SEE ALSO
  81 .Xr compress 1 ,
  82 .Xr mail 1 ,
  83 .Xr tar 1 ,
  84 .Xr uuencode 1
  85 .Sh HISTORY
  86 The
  87 .Nm
  88 command appeared in
  89 .Bx 4.4 .
  90 .Sh BUGS
  91 The
  92 .Nm
  93 command makes no provisions for special types of files or files containing
  94 magic characters.
  95 The
  96 .Nm
  97 command cannot handle files without a newline ('\\n')
  98 as the last character.
  99 .Pp
 100 It is easy to insert trojan horses into
 101 .Nm
 102 files.
 103 It is strongly recommended that all shell archive files be examined
 104 before running them through
 105 .Xr sh 1 .
 106 Archives produced using this implementation of
 107 .Nm
 108 may be easily examined with the command:
 109 .Bd -literal -offset indent
 110 egrep -v '^[X#]' shar.file
 111 .Ed