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