Correct BSD License clause numbering from 1-2-4 to 1-2-3.
[dragonfly.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. 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 .\"     @(#)lam.1       8.1 (Berkeley) 6/6/93
29 .\" $FreeBSD: src/usr.bin/lam/lam.1,v 1.4.2.6 2002/06/21 15:27:34 charnier Exp $
30 .\" $DragonFly: src/usr.bin/lam/lam.1,v 1.2 2003/06/17 04:29:27 dillon Exp $
31 .\"
32 .Dd September 20, 2001
33 .Dt LAM 1
34 .Os
35 .Sh NAME
36 .Nm lam
37 .Nd laminate files
38 .Sh SYNOPSIS
39 .Nm
40 .Op Fl f Ar min . Ns Ar max
41 .Op Fl s Ar sepstring
42 .Op Fl t Ar c
43 .Ar
44 .Nm
45 .Op Fl p Ar min . Ns Ar max
46 .Op Fl s Ar sepstring
47 .Op Fl t Ar c
48 .Ar
49 .Sh DESCRIPTION
50 The
51 .Nm
52 utility copies the named files side by side onto the standard output.
53 The
54 .Em n-th
55 input lines from the input
56 .Ar files
57 are considered fragments of the single long
58 .Em n-th
59 output line into which they are assembled.
60 The name `\fB\-\fP' means the standard input, and may be repeated.
61 .Pp
62 Normally, each option affects only the
63 .Ar file
64 after it.
65 If the option letter is capitalized it affects all subsequent files
66 until it appears again uncapitalized.
67 The options are described below:
68 .Bl -tag -width indent
69 .It Fl f Ar min . Ns Ar max
70 Print line fragments according to the format string
71 .Ar min . Ns Ar max ,
72 where
73 .Ar min
74 is the minimum field width and
75 .Ar max
76 the maximum field width.
77 If
78 .Ar min
79 begins with a zero, zeros will be added to make up the field width,
80 and if it begins with a `\-', the fragment will be left-adjusted
81 within the field.
82 .It Fl p Ar min . Ns Ar max
83 Like
84 .Fl f ,
85 but pad this file's field when end-of-file is reached
86 and other files are still active.
87 .It Fl s Ar sepstring
88 Print
89 .Ar sepstring
90 before printing line fragments from the next file.
91 This option may appear after the last file.
92 .It Fl t Ar c
93 The input line terminator is
94 .Ar c
95 instead of a newline.
96 The newline normally appended to each output line is omitted.
97 .El
98 .Pp
99 To print files simultaneously for easy viewing use
100 .Xr pr 1 .
101 .Sh EXAMPLES
102 The command
103 .Bd -literal
104 lam file1 file2 file3 file4
105 .Ed
106 .Pp
107 joins 4 files together along each line.
108 To merge the lines from four different files use
109 .Bd -literal
110 lam file1 \-S "\\
111 " file2 file3 file4
112 .Ed
113 .Pp
114 Every 2 lines of a file may be joined on one line with
115 .Bd -literal
116 lam \- \- < file
117 .Ed
118 .Pp
119 and a form letter with substitutions keyed by `@' can be done with
120 .Bd -literal
121 lam \-t @ letter changes
122 .Ed
123 .Sh SEE ALSO
124 .Xr join 1 ,
125 .Xr paste 1 ,
126 .Xr pr 1 ,
127 .Xr printf 3
128 .Sh STANDARDS
129 Some of the functionality of
130 .Nm
131 is standardized as the
132 .Xr paste 1
133 utility by
134 .St -p1003.2 .