Return to shar.1 CVS log

Up to [local] / src / usr.bin / shar

Annotation of src/usr.bin/shar/shar.1, Revision 1.2

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