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