1.\"	$NetBSD: shar.1,v 1.14 2023/01/25 19:52:14 rillig Exp $
 2.\" [[[[ SLIGHTLY MODIFIED BY SHRUB :) ]]]]
 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 May 27, 2026
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
43writes an
44.Xr sh 1
45shell script to the standard output which will recreate the file
46hierarchy specified by the command line operands.
47Parent directories for file operands are created as needed.
48File and directory permissions are restored.
49.Pp
50.Nm
51is normally used for distributing files by
52.Xr ftp 1
53or
54.Xr mail 1 .
55.Sh EXAMPLES
56To create a shell archive of the program
57.Xr ls 1
58and mail it to Rick:
59.Bd -literal -offset indent
60cd ls
61shar `find . -print` \&|  mail -s "ls source" rick
62.Ed
63.Pp
64To recreate the program directory:
65.Bd -literal -offset indent
66mkdir ls
67cd ls
68\&...
69<delete header lines and examine mailed archive>
70\&...
71sh archive
72.Ed
73.Sh SEE ALSO
74.Xr compress 1 ,
75.Xr mail 1 ,
76.Xr tar 1 ,
77.Xr uuencode 1
78.Sh HISTORY
79The
80.Nm
81command appeared in
82.Bx 4.4 .
83.Sh BUGS
84.Nm
85makes no provisions for special types of files.
86It is not intended for binary files containing NUL bytes.
87.Sh SECURITY CONSIDERATIONS
88It is easy to insert trojan horses into
89.Nm
90files.
91It is strongly recommended that all shell archive files be examined
92before running them through
93.Xr sh 1 .