contrib/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 April 17, 2008
  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 .Op Fl br
  44 .Op Fl o Ar archive-file
  45 .Ar
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 command writes a
  50 .Xr sh 1
  51 shell script which will recreate the file hierarchy specified by the command
  52 line operands.
  53 .Pp
  54 The
  55 .Nm
  56 command is normally used for distributing files by
  57 .Xr ftp 1
  58 or
  59 .Xr mail 1 .
  60 .Pp
  61 The following options are available:
  62 .Bl -tag -width indent
  63 .It Fl b
  64 Use an alternative binary format.
  65 Content of files will be uuencoded.
  66 This option should be used to archive binary files correctly.
  67 In this mode also file permissions will be stored to the archive.
  68 uudecode(1) is needed to extract archives created with this option.
  69 .It Fl o Ar archive-file
  70 Redirect output to
  71 .Ar archive-file .
  72 .It Fl r
  73 If
  74 .Ar file
  75 given on command line is a directory the entire subtree will be archived.
  76 Symbolic links given on command line are followed.
  77 Other symbolic links will be archived as such.
  78 .El
  79 .Sh EXAMPLES
  80 To create a shell archive of the program
  81 .Xr ls 1
  82 and mail it to Rick:
  83 .Bd -literal -offset indent
  84 cd ls
  85 shar -r . \&| mail -s "ls source" rick
  86 .Ed
  87 .Pp
  88 To recreate the program directory:
  89 .Bd -literal -offset indent
  90 mkdir ls
  91 cd ls
  92 \&...
  93 <delete header lines and examine mailed archive>
  94 \&...
  95 sh archive
  96 .Ed
  97 .Sh SEE ALSO
  98 .Xr compress 1 ,
  99 .Xr mail 1 ,
 100 .Xr tar 1 ,
 101 .Xr uuencode 1 ,
 102 .Xr uuencode 5
 103 .Sh HISTORY
 104 The
 105 .Nm
 106 command appeared in
 107 .Bx 4.4 .
 108 This is a re-implementation based on the libarchive(3) library.
 109 .Sh BUGS
 110 The
 111 .Nm
 112 command makes no provisions for hard links.
 113 .Pp
 114 Files containing magic characters or files without a newline ('\\n') as the
 115 last character are not handled correctly with the default format.
 116 Use the
 117 .Fl b
 118 option for binary files.
 119 .Pp
 120 It is easy to insert trojan horses into
 121 .Nm
 122 files.
 123 It is strongly recommended that all shell archive files be examined
 124 before running them through
 125 .Xr sh 1 .
 126 Archives produced using this implementation of
 127 .Nm
 128 may be easily examined with the command:
 129 .Bd -literal -offset indent
 130 egrep -v '^[X#]' shar.file
 131 .Ed