usr.bin/shar/shar.1

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