xref: /freebsd/usr.bin/shar/shar.1 (revision cbb3ec25236ba72f91cbdf23f8b78b9d1af0cedf)
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.\"
30.Dd January 31, 2019
31.Dt SHAR 1
32.Os
33.Sh NAME
34.Nm shar
35.Nd create a shell archive of files
36.Sh SYNOPSIS
37.Nm
38.Ar
39.Sh DESCRIPTION
40The
41.Nm
42command writes a
43.Xr sh 1
44shell script to the standard output which will recreate the file
45hierarchy specified by the command line operands.
46Directories will be recreated and must be specified before the
47files they contain (the
48.Xr find 1
49utility does this correctly).
50.Pp
51The
52.Nm
53command is normally used for distributing files by
54.Xr ftp 1
55or
56.Xr mail 1 .
57.Sh EXAMPLES
58To create a shell archive of the program
59.Xr ls 1
60and mail it to Rick:
61.Bd -literal -offset indent
62cd ls
63shar `find . -print` \&| mail -s "ls source" rick
64.Ed
65.Pp
66To recreate the program directory:
67.Bd -literal -offset indent
68mkdir ls
69cd ls
70\&...
71<delete header lines and examine mailed archive>
72\&...
73sh 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
81The
82.Nm
83command appeared in
84.Bx 4.4 .
85.Sh BUGS
86The
87.Nm
88command makes no provisions for special types of files or files containing
89magic characters.
90The
91.Nm
92command cannot handle files without a newline ('\\n')
93as the last character.
94.Pp
95It is easy to insert trojan horses into
96.Nm
97files.
98It is strongly recommended that all shell archive files be examined
99before running them through
100.Xr sh 1 .
101Archives produced using this implementation of
102.Nm
103may be easily examined with the command:
104.Bd -literal -offset indent
105egrep -av '^[X#]' shar.file
106.Ed
107