Sync usage with man page.
[netbsd-mini2440.git] / usr.bin / lam / lam.1
blob1fc40e73c482e93f464ed78a36d9232a6a603e1e
1 .\"     $NetBSD: lam.1,v 1.5 2003/08/07 11:14:16 agc Exp $
2 .\"
3 .\" Copyright (c) 1993
4 .\"     The Regents of the University of California.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\"    may be used to endorse or promote products derived from this software
16 .\"    without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\"     @(#)lam.1       8.1 (Berkeley) 6/6/93
31 .\"
32 .Dd December 1, 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.max
41 .Op Fl p Ar min.max
42 .Op Fl s Ar sepstring
43 .Op Fl t Ar c
44 .Ar file ...
45 .Sh DESCRIPTION
46 .Nm
47 copies the named files side by side onto the standard output.
48 The
49 .Em n Ns -th
50 input lines from the input
51 .Ar files
52 are considered fragments of the single long
53 .Em n Ns -th
54 output line into which they are assembled.
55 The name
56 .Dq \&-
57 means the standard input, and may be repeated.
58 .Pp
59 Normally, each option affects only the
60 .Ar file
61 after it.
62 If the option letter is capitalized it affects all subsequent files
63 until it appears again uncapitalized.
64 The options are described below.
65 .Pp
66 .Bl -tag -width "-s sepstring" -compact
67 .It Fl f Ar min.max
68 Print line fragments according to the format string
69 .Ar min.max ,
70 where
71 .Ar min
72 is the minimum field width and
73 .Ar max
74 the maximum field width.
76 .Ar min
77 begins with a zero, zeros will be added to make up the field width,
78 and if it begins with a
79 .Sq \&- ,
80 the fragment will be left-adjusted
81 within the field.
82 .It Fl p Ar min.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 -offset indent
104 lam file1 file2 file3 file4
107 joins 4 files together along each line.
108 To merge the lines from four different files use
109 .Bd -literal -offset indent
110 lam file1 \-S "\\
111 " file2 file3 file4
114 Every 2 lines of a file may be joined on one line with
115 .Bd -literal -offset indent
116 lam \- \- \*[Lt] file
119 and a form letter with substitutions keyed by
120 .Sq \&@
121 can be done with
122 .Bd -literal -offset indent
123 lam \-t @ letter changes
125 .Sh SEE ALSO
126 .Xr join 1 ,
127 .Xr pr 1 ,
128 .Xr printf 3