xref: /dragonfly/usr.bin/shar/shar.1 (revision dc71b7ab)
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.\" $FreeBSD: src/usr.bin/shar/shar.1,v 1.7.2.2 2001/08/16 13:17:03 ru Exp $
30.\" $DragonFly: src/usr.bin/shar/shar.1,v 1.3 2006/02/17 19:39:10 swildner Exp $
31.\"
32.Dd June 6, 1993
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
42The
43.Nm
44command writes a
45.Xr sh 1
46shell script to the standard output which will recreate the file
47hierarchy specified by the command line operands.
48Directories will be recreated and must be specified before the
49files they contain (the
50.Xr find 1
51utility does this correctly).
52.Pp
53The
54.Nm
55command is normally used for distributing files by
56.Xr ftp  1
57or
58.Xr mail  1  .
59.Sh EXAMPLES
60To create a shell archive of the program
61.Xr ls  1
62and mail it to Rick:
63.Bd -literal -offset indent
64cd ls
65shar `find . -print` \&|  mail -s "ls source" rick
66.Ed
67.Pp
68To recreate the program directory:
69.Bd -literal -offset indent
70mkdir ls
71cd ls
72\&...
73<delete header lines and examine mailed archive>
74\&...
75sh archive
76.Ed
77.Sh SEE ALSO
78.Xr compress 1 ,
79.Xr mail 1 ,
80.Xr tar 1 ,
81.Xr uuencode 1
82.Sh HISTORY
83The
84.Nm
85command appeared in
86.Bx 4.4 .
87.Sh BUGS
88The
89.Nm
90command makes no provisions for special types of files or files containing
91magic characters.
92The
93.Nm
94command cannot handle files without a newline ('\\n')
95as the last character.
96.Pp
97It is easy to insert trojan horses into
98.Nm
99files.
100It is strongly recommended that all shell archive files be examined
101before running them through
102.Xr sh  1  .
103Archives produced using this implementation of
104.Nm
105may be easily examined with the command:
106.Bd -literal -offset indent
107egrep -v '^[X#]' shar.file
108.Ed
109