xref: /freebsd/usr.bin/shar/shar.1 (revision e0c4386e)
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 31, 2019
29.Dt SHAR 1
30.Os
31.Sh NAME
32.Nm shar
33.Nd create a shell archive of files
34.Sh SYNOPSIS
35.Nm
36.Ar
37.Sh DESCRIPTION
38The
39.Nm
40command writes a
41.Xr sh 1
42shell script to the standard output which will recreate the file
43hierarchy specified by the command line operands.
44Directories will be recreated and must be specified before the
45files they contain (the
46.Xr find 1
47utility does this correctly).
48.Pp
49The
50.Nm
51command is 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
84The
85.Nm
86command makes no provisions for special types of files or files containing
87magic characters.
88The
89.Nm
90command cannot handle files without a newline ('\\n')
91as the last character.
92.Pp
93It is easy to insert trojan horses into
94.Nm
95files.
96It is strongly recommended that all shell archive files be examined
97before running them through
98.Xr sh 1 .
99Archives produced using this implementation of
100.Nm
101may be easily examined with the command:
102.Bd -literal -offset indent
103egrep -av '^[X#]' shar.file
104.Ed
105