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 1, 2025 29.Dt SHAR 1 30.Os 31.Sh NAME 32.Nm shar 33.Nd create a shell archive of files 34.Sh DEPRECATION NOTICE 35.Nm 36is obsolete and may not be present in 37.Fx 15 38and later. 39Because shell archives are simultaneously data and code and are typically 40interpreted by 41.Xr sh 1 , 42they can easily be trojan-horsed and pose a significant security risk to users. 43The 44.Xr tar 1 45utility can still produce shar encodings of files if needed. 46The 47.Pa sysutils/freebsd-shar 48port has been created to maintain this version of 49.Nm 50past its deprecation in base. 51.Sh SYNOPSIS 52.Nm 53.Ar 54.Sh DESCRIPTION 55The 56.Nm 57command writes a 58.Xr sh 1 59shell script to the standard output which will recreate the file 60hierarchy specified by the command line operands. 61Directories will be recreated and must be specified before the 62files they contain (the 63.Xr find 1 64utility does this correctly). 65.Pp 66The 67.Nm 68command is normally used for distributing files by 69.Xr ftp 1 70or 71.Xr mail 1 . 72.Sh EXAMPLES 73To create a shell archive of the program 74.Xr ls 1 75and mail it to Rick: 76.Bd -literal -offset indent 77cd ls 78shar `find . -print` \&| mail -s "ls source" rick 79.Ed 80.Pp 81To recreate the program directory: 82.Bd -literal -offset indent 83mkdir ls 84cd ls 85\&... 86<delete header lines and examine mailed archive> 87\&... 88sh archive 89.Ed 90.Sh SEE ALSO 91.Xr compress 1 , 92.Xr mail 1 , 93.Xr tar 1 , 94.Xr uuencode 1 95.Sh HISTORY 96The 97.Nm 98command appeared in 99.Bx 4.4 . 100.Sh BUGS 101The 102.Nm 103command makes no provisions for special types of files or files containing 104magic characters. 105The 106.Nm 107command cannot handle files without a newline ('\\n') 108as the last character. 109.Pp 110It is easy to insert trojan horses into 111.Nm 112files. 113It is strongly recommended that all shell archive files be examined 114before running them through 115.Xr sh 1 . 116Archives produced using this implementation of 117.Nm 118may be easily examined with the command: 119.Bd -literal -offset indent 120egrep -av '^[X#]' shar.file 121.Ed 122