Differential D32943 Diff 105089 usr.bin/uuencode/bintrans.1

Changeset View

Standalone View

usr.bin/uuencode/bintrans.1

This file was moved from usr.bin/uuencode/uuencode.1.

	Show All 19 Lines
	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL			.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS			.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)			.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT			.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY			.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF			.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	.\" SUCH DAMAGE.			.\" SUCH DAMAGE.
	.\"			.\"
	.\" @(#)uuencode.1 8.1 (Berkeley) 6/6/93			.\" From: @(#)uuencode.1 8.1 (Berkeley) 6/6/93
	.\" $FreeBSD$			.\" $FreeBSD$
	.\"			.\"
	.Dd January 27, 2002			.Dd April 18, 2022
	.Dt UUENCODE 1			.Dt BINTRANS 1
	.Os			.Os
	.Sh NAME			.Sh NAME
				.Nm bintrans ,
	.Nm uuencode ,			.Nm uuencode ,
	.Nm uudecode ,			.Nm uudecode ,
	.Nm b64encode ,			.Nm b64encode ,
	.Nm b64decode			.Nm b64decode
	.Nd encode/decode a binary file			.Nd encode/decode a binary file
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.Nm			.Nm
				.Op algorithm
				.Op ...
				.Nm uuencode
	.Op Fl m			.Op Fl m
	.Op Fl r			.Op Fl r
	.Op Fl o Ar output_file			.Op Fl o Ar output_file
	.Op Ar file			.Op Ar file
	.Ar name			.Ar name
	.Nm uudecode			.Nm uudecode
	.Op Fl cimprs			.Op Fl cimprs
	.Op Ar			.Op Ar
	Show All 9 Lines
	.Op Fl cimprs			.Op Fl cimprs
	.Op Ar			.Op Ar
	.Nm b64decode			.Nm b64decode
	.Op Fl i			.Op Fl i
	.Fl o Ar output_file			.Fl o Ar output_file
	.Op Ar file			.Op Ar file
	.Sh DESCRIPTION			.Sh DESCRIPTION
	The			The
	.Nm			.Nm uuencode
	and			and
	.Nm uudecode			.Nm uudecode
	utilities are used to transmit binary files over transmission mediums			utilities are used to transmit binary files over transmission mediums
	that do not support other than simple			that do not support other than simple
	.Tn ASCII			.Tn ASCII
	data.			data.
	The			The
	.Nm b64encode			.Nm b64encode
	utility is synonymous with			utility is synonymous with
	.Nm			.Nm uuencode
	with the			with the
	.Fl m			.Fl m
	flag specified.			flag specified.
	The			The
	.Nm b64decode			.Nm b64decode
	utility is synonymous with			utility is synonymous with
	.Nm uudecode			.Nm uudecode
	with the			with the
	.Fl m			.Fl m
	flag specified.			flag specified.
	.Pp			.Pp
	The			The
	.Nm			.Nm uuencode
	utility reads			utility reads
	.Ar file			.Ar file
	(or by default the standard input) and writes an encoded version			(or by default the standard input) and writes an encoded version
	to the standard output, or			to the standard output, or
	.Ar output_file			.Ar output_file
	if one has been specified.			if one has been specified.
	The encoding uses only printing			The encoding uses only printing
	.Tn ASCII			.Tn ASCII
	Show All 15 Lines
	.Ar output_file			.Ar output_file
	and will have the mode of the original file except that setuid			and will have the mode of the original file except that setuid
	and execute bits are not retained.			and execute bits are not retained.
	The			The
	.Nm uudecode			.Nm uudecode
	utility ignores any leading and trailing lines.			utility ignores any leading and trailing lines.
	.Pp			.Pp
	The following options are available for			The following options are available for
	.Nm :			.Nm uuencode :
	.Bl -tag -width ident			.Bl -tag -width ident
	.It Fl m			.It Fl m
	Use the Base64 method of encoding, rather than the traditional			Use the Base64 method of encoding, rather than the traditional
	.Nm			.Nm uuencode
	algorithm.			algorithm.
	.It Fl r			.It Fl r
	Produce raw output by excluding the initial and final framing lines.			Produce raw output by excluding the initial and final framing lines.
	.It Fl o Ar output_file			.It Fl o Ar output_file
	Output to			Output to
	.Ar output_file			.Ar output_file
	instead of standard output.			instead of standard output.
	.El			.El
	.Pp			.Pp
	The following options are available for			The following options are available for
	.Nm uudecode :			.Nm uudecode :
	.Bl -tag -width ident			.Bl -tag -width ident
	.It Fl c			.It Fl c
	Decode more than one uuencoded file from			Decode more than one uuencoded file from
	.Ar file			.Ar file
	if possible.			if possible.
	.It Fl i			.It Fl i
	Do not overwrite files.			Do not overwrite files.
	.It Fl m			.It Fl m
	When used with the			When used with the
	.Fl r			.Fl r
	flag, decode Base64 input instead of traditional			flag, decode Base64 input instead of traditional
	.Nm			.Nm uuencode
	input.			input.
	Without			Without
	.Fl r			.Fl r
	it has no effect.			it has no effect.
	.It Fl o Ar output_file			.It Fl o Ar output_file
	Output to			Output to
	.Ar output_file			.Ar output_file
	instead of any pathname contained in the input data.			instead of any pathname contained in the input data.
	.It Fl p			.It Fl p
	Decode			Decode
	.Ar file			.Ar file
	and write output to standard output.			and write output to standard output.
	.It Fl r			.It Fl r
	Decode raw (or broken) input, which is missing the initial and			Decode raw (or broken) input, which is missing the initial and
	possibly the final framing lines.			possibly the final framing lines.
	The input is assumed to be in the traditional			The input is assumed to be in the traditional
	.Nm			.Nm uuencode
	encoding, but if the			encoding, but if the
	.Fl m			.Fl m
	flag is used, or if the utility is invoked as			flag is used, or if the utility is invoked as
	.Nm b64decode ,			.Nm b64decode ,
	then the input is assumed to be in Base64 format.			then the input is assumed to be in Base64 format.
	.It Fl s			.It Fl s
	Do not strip output pathname to base filename.			Do not strip output pathname to base filename.
	By default			By default
	.Nm uudecode			.Nm uudecode
	deletes any prefix ending with the last slash '/' for security			deletes any prefix ending with the last slash '/' for security
	reasons.			reasons.
	.El			.El
				.Pp
				.Nm
				is a generic utility that can run
				any of the aforementioned encoders and decoders.
	.Sh EXAMPLES			.Sh EXAMPLES
	The following example packages up a source tree, compresses it,			The following example packages up a source tree, compresses it,
	uuencodes it and mails it to a user on another system.			uuencodes it and mails it to a user on another system.
	When			When
	.Nm uudecode			.Nm uudecode
	is run on the target system, the file ``src_tree.tar.Z'' will be			is run on the target system, the file ``src_tree.tar.Z'' will be
	created which may then be uncompressed and extracted into the original			created which may then be uncompressed and extracted into the original
	tree.			tree.
	Show All 21 Lines
	.Xr compress 1 ,			.Xr compress 1 ,
	.Xr mail 1 ,			.Xr mail 1 ,
	.Xr uucp 1 Pq Pa ports/net/freebsd-uucp ,			.Xr uucp 1 Pq Pa ports/net/freebsd-uucp ,
	.Xr uuencode 5			.Xr uuencode 5
	.Sh HISTORY			.Sh HISTORY
	The			The
	.Nm uudecode			.Nm uudecode
	and			and
	.Nm			.Nm uuencode
	utilities appeared in			utilities appeared in
	.Bx 4.0 .			.Bx 4.0 .
	.Sh BUGS			.Sh BUGS
	Files encoded using the traditional algorithm are expanded by 35% (3			Files encoded using the traditional algorithm are expanded by 35% (3
	bytes become 4 plus control information).			bytes become 4 plus control information).