freebsd-dev/usr.bin/lam/lam.1

.\" Copyright (c) 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" 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
.\" SUCH DAMAGE.
.\"
.\"	@(#)lam.1	8.1 (Berkeley) 6/6/93
.\" $FreeBSD$
.\"
.Dd August 12, 2004
.Dt LAM 1
.Os
.Sh NAME
.Nm lam
.Nd laminate files
.Sh SYNOPSIS
.Nm
.Op Fl f Ar min . Ns Ar max
.Op Fl s Ar sepstring
.Op Fl t Ar c
.Ar
.Nm
.Op Fl p Ar min . Ns Ar max
.Op Fl s Ar sepstring
.Op Fl t Ar c
.Ar
.Sh DESCRIPTION
The
.Nm
utility copies the named files side by side onto the standard output.
The
.Em n-th
input lines from the input
.Ar files
are considered fragments of the single long
.Em n-th
output line into which they are assembled.
The name `\fB\-\fP' means the standard input, and may be repeated.
.Pp
Normally, each option affects only the
.Ar file
after it.
If the option letter is capitalized it affects all subsequent files
until it appears again uncapitalized.
The options are described below:
.Bl -tag -width indent
.It Fl f Ar min . Ns Ar max
Print line fragments according to the format string
.Ar min . Ns Ar max ,
where
.Ar min
is the minimum field width and
.Ar max
the maximum field width.
If
.Ar min
begins with a zero, zeros will be added to make up the field width,
and if it begins with a `\-', the fragment will be left-adjusted
within the field.
.It Fl p Ar min . Ns Ar max
Like
.Fl f ,
but pad this file's field when end-of-file is reached
and other files are still active.
.It Fl s Ar sepstring
Print
.Ar sepstring
before printing line fragments from the next file.
This option may appear after the last file.
.It Fl t Ar c
The input line terminator is
.Ar c
instead of a newline.
The newline normally appended to each output line is omitted.
.El
.Pp
To print files simultaneously for easy viewing use
.Xr pr 1 .
.Sh EXAMPLES
The command
.Bd -literal
lam file1 file2 file3 file4
.Ed
.Pp
joins 4 files together along each line.
To merge the lines from four different files use
.Bd -literal
lam file1 \-S "\\
" file2 file3 file4
.Ed
.Pp
Every 2 lines of a file may be joined on one line with
.Bd -literal
lam \- \- < file
.Ed
.Pp
and a form letter with substitutions keyed by `@' can be done with
.Bd -literal
lam \-t @ letter changes
.Ed
.Sh SEE ALSO
.Xr join 1 ,
.Xr paste 1 ,
.Xr pr 1 ,
.Xr printf 3
.Sh STANDARDS
Some of the functionality of
.Nm
is standardized as the
.Xr paste 1
utility by
.St -p1003.2 .
.Sh HISTORY
The
.Nm
utility first appeared in
.Bx 4.2 .
.Sh BUGS
The
.Nm
utility does not recognize multibyte characters.
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\" Copyright (c) 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" 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`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)lam.1 8.1 (Berkeley) 6/6/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:08:13 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`.\"`
Document incorrect handling of multibyte characters. 2004-08-12 11:34:34 +00:00			`.Dd August 12, 2004`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Dt LAM 1`
			`.Os`
			`.Sh NAME`
			`.Nm lam`
			`.Nd laminate files`
			`.Sh SYNOPSIS`
			`.Nm`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`.Op Fl f Ar min . Ns Ar max`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Op Fl s Ar sepstring`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`.Op Fl t Ar c`
mdoc(7) police: use the default ``file ...'' feature of the .Ar macro. 2001-02-13 09:56:35 +00:00			`.Ar`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 19:21:22 +00:00			`.Nm`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`.Op Fl p Ar min . Ns Ar max`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Op Fl s Ar sepstring`
Remove whitespace at EOL. 2001-07-15 08:06:20 +00:00			`.Op Fl t Ar c`
mdoc(7) police: use the default ``file ...'' feature of the .Ar macro. 2001-02-13 09:56:35 +00:00			`.Ar`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Sh DESCRIPTION`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The`
			`.Nm`
			`utility copies the named files side by side onto the standard output.`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`The`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Em n-th`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`input lines from the input`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Ar files`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`are considered fragments of the single long`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Em n-th`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`output line into which they are assembled.`
			The name `\fB\-\fP' means the standard input, and may be repeated.
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Pp`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`Normally, each option affects only the`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Ar file`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`after it.`
			`If the option letter is capitalized it affects all subsequent files`
			`until it appears again uncapitalized.`
Use `The .Nm utility' 2002-04-20 12:18:28 +00:00			`The options are described below:`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Bl -tag -width indent`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`.It Fl f Ar min . Ns Ar max`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`Print line fragments according to the format string`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`.Ar min . Ns Ar max ,`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`where`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Ar min`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`is the minimum field width and`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Ar max`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`the maximum field width.`
			`If`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Ar min`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`begins with a zero, zeros will be added to make up the field width,`
			and if it begins with a `\-', the fragment will be left-adjusted
			`within the field.`
mdoc(7) police: split punctuation characters + misc fixes. 2001-02-01 16:38:02 +00:00			`.It Fl p Ar min . Ns Ar max`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`Like`
			`.Fl f ,`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`but pad this file's field when end-of-file is reached`
			`and other files are still active.`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.It Fl s Ar sepstring`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`Print`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Ar sepstring`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`before printing line fragments from the next file.`
			`This option may appear after the last file.`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.It Fl t Ar c`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`The input line terminator is`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Ar c`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`instead of a newline.`
			`The newline normally appended to each output line is omitted.`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.El`
			`.Pp`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`To print files simultaneously for easy viewing use`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Xr pr 1 .`
			`.Sh EXAMPLES`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`The command`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Bd -literal`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`lam file1 file2 file3 file4`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Ed`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`.Pp`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`joins 4 files together along each line.`
			`To merge the lines from four different files use`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Bd -literal`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`lam file1 \-S "\\`
			`" file2 file3 file4`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Ed`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`.Pp`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`Every 2 lines of a file may be joined on one line with`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Bd -literal`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`lam \- \- < file`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Ed`
Prepare for mdoc(7)NG. 2000-12-19 16:00:12 +00:00			`.Pp`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			and a form letter with substitutions keyed by `@' can be done with
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Bd -literal`
BSD 4.4 Lite Usr.bin Sources 1994-05-27 12:33:43 +00:00			`lam \-t @ letter changes`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Ed`
			`.Sh SEE ALSO`
			`.Xr join 1 ,`
Cross-reference between lam(1) and paste(1). Add a STANDARDS section to lam(1) indicating that paste(1) is a standard way to do some of the same things. MFC after: 1 week 2001-09-21 02:51:07 +00:00			`.Xr paste 1 ,`
Use err(3) instead of local redefintion. Add usage() as a separate function. Rewrote man page in mdoc format. 1997-07-18 06:43:15 +00:00			`.Xr pr 1 ,`
			`.Xr printf 3`
Cross-reference between lam(1) and paste(1). Add a STANDARDS section to lam(1) indicating that paste(1) is a standard way to do some of the same things. MFC after: 1 week 2001-09-21 02:51:07 +00:00			`.Sh STANDARDS`
			`Some of the functionality of`
			`.Nm`
			`is standardized as the`
			`.Xr paste 1`
			`utility by`
			`.St -p1003.2 .`
Document that jot(1), rs(1), and lam(1) first appeared in 4.2BSD. MFC after: 1 month 2006-10-20 04:31:01 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`utility first appeared in`
			`.Bx 4.2 .`
Document incorrect handling of multibyte characters. 2004-08-12 11:34:34 +00:00			`.Sh BUGS`
			`The`
			`.Nm`
			`utility does not recognize multibyte characters.`