Initial import from FreeBSD RELENG_4:
[games.git] / usr.bin / lam / lam.1
1 .\" Copyright (c) 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. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)lam.1       8.1 (Berkeley) 6/6/93
33 .\" $FreeBSD: src/usr.bin/lam/lam.1,v 1.4.2.6 2002/06/21 15:27:34 charnier Exp $
34 .\"
35 .Dd September 20, 2001
36 .Dt LAM 1
37 .Os
38 .Sh NAME
39 .Nm lam
40 .Nd laminate files
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl f Ar min . Ns Ar max
44 .Op Fl s Ar sepstring
45 .Op Fl t Ar c
46 .Ar
47 .Nm
48 .Op Fl p Ar min . Ns Ar max
49 .Op Fl s Ar sepstring
50 .Op Fl t Ar c
51 .Ar
52 .Sh DESCRIPTION
53 The
54 .Nm
55 utility copies the named files side by side onto the standard output.
56 The
57 .Em n-th
58 input lines from the input
59 .Ar files
60 are considered fragments of the single long
61 .Em n-th
62 output line into which they are assembled.
63 The name `\fB\-\fP' means the standard input, and may be repeated.
64 .Pp
65 Normally, each option affects only the
66 .Ar file
67 after it.
68 If the option letter is capitalized it affects all subsequent files
69 until it appears again uncapitalized.
70 The options are described below:
71 .Bl -tag -width indent
72 .It Fl f Ar min . Ns Ar max
73 Print line fragments according to the format string
74 .Ar min . Ns Ar max ,
75 where
76 .Ar min
77 is the minimum field width and
78 .Ar max
79 the maximum field width.
80 If
81 .Ar min
82 begins with a zero, zeros will be added to make up the field width,
83 and if it begins with a `\-', the fragment will be left-adjusted
84 within the field.
85 .It Fl p Ar min . Ns Ar max
86 Like
87 .Fl f ,
88 but pad this file's field when end-of-file is reached
89 and other files are still active.
90 .It Fl s Ar sepstring
91 Print
92 .Ar sepstring
93 before printing line fragments from the next file.
94 This option may appear after the last file.
95 .It Fl t Ar c
96 The input line terminator is
97 .Ar c
98 instead of a newline.
99 The newline normally appended to each output line is omitted.
100 .El
101 .Pp
102 To print files simultaneously for easy viewing use
103 .Xr pr 1 .
104 .Sh EXAMPLES
105 The command
106 .Bd -literal
107 lam file1 file2 file3 file4
108 .Ed
109 .Pp
110 joins 4 files together along each line.
111 To merge the lines from four different files use
112 .Bd -literal
113 lam file1 \-S "\\
114 " file2 file3 file4
115 .Ed
116 .Pp
117 Every 2 lines of a file may be joined on one line with
118 .Bd -literal
119 lam \- \- < file
120 .Ed
121 .Pp
122 and a form letter with substitutions keyed by `@' can be done with
123 .Bd -literal
124 lam \-t @ letter changes
125 .Ed
126 .Sh SEE ALSO
127 .Xr join 1 ,
128 .Xr paste 1 ,
129 .Xr pr 1 ,
130 .Xr printf 3
131 .Sh STANDARDS
132 Some of the functionality of
133 .Nm
134 is standardized as the
135 .Xr paste 1
136 utility by
137 .St -p1003.2 .