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