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