| blob | 3a328fad477413e5af84c19659ca8c5a14031cc1 |
1 .\"
2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 .\" permission to reproduce portions of its copyrighted documentation.
4 .\" Original documentation from The Open Group can be obtained online at
5 .\" http://www.opengroup.org/bookstore/.
6 .\"
7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 .\" Group, have given us permission to reprint portions of their
9 .\" documentation.
10 .\"
11 .\" In the following statement, the phrase ``this text'' refers to portions
12 .\" of the system documentation.
13 .\"
14 .\" Portions of this text are reprinted and reproduced in electronic form
15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 .\" Standard for Information Technology -- Portable Operating System
17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 .\" between these versions and the original IEEE and The Open Group
21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 .\" document. The original Standard can be obtained online at
23 .\" http://www.opengroup.org/unix/online.html.
24 .\"
25 .\" This notice shall appear on any product containing this material.
26 .\"
27 .\" The contents of this file are subject to the terms of the
28 .\" Common Development and Distribution License (the "License").
29 .\" You may not use this file except in compliance with the License.
30 .\"
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Copyright 1989 AT&T
44 .\" Copyright (c) 1995, Sun Microsystems, Inc. All Rights Reserved.
45 .\" Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
46 .\"
47 .TH NL 1 "Mar 28, 1995"
48 .SH NAME
49 nl \- line numbering filter
50 .SH SYNOPSIS
51 .LP
52 .nf
53 \fB/usr/bin/nl\fR [\fB-p\fR] [\fB-b\fR [\fItype\fR]] [\fB-d\fR [\fIdelim\fR]] [\fB-f\fR [\fItype\fR]]
54 [\fB-h\fR [\fItype\fR]] [\fB-i\fR [\fIincr\fR]] [\fB-l\fR [\fInum\fR]] [\fB-n\fR [\fIformat\fR]]
55 [\fB-s\fR [\fIsep\fR]] [\fB-w\fR [\fIwidth\fR]] [\fB-v\fR [\fIstartnum\fR]] [\fIfile\fR]
56 .fi
58 .LP
59 .nf
60 \fB/usr/xpg4/bin/nl\fR [\fB-p\fR] [\fB-b\fR \fItype\fR] [\fB-d\fR \fIdelim\fR] [\fB-f\fR \fItype\fR]
61 [\fB-h\fR \fItype\fR] [\fB-i\fR \fIincr\fR] [\fB-l\fR \fInum\fR] [\fB-n\fR \fIformat\fR] [\fB-s\fR \fIsep\fR]
62 [\fB-w\fR \fIwidth\fR] [\fB-v\fR \fIstartnum\fR] [\fIfile\fR]
63 .fi
65 .SH DESCRIPTION
66 .sp
67 .LP
68 The \fBnl\fR utility reads lines from the named \fIfile\fR, or the standard
69 input if no \fIfile\fR is named, and reproduces the lines on the standard
70 output. Lines are numbered on the left in accordance with the command options
71 in effect.
72 .sp
73 .LP
74 \fBnl\fR views the text it reads in terms of logical pages. Line numbering is
75 reset at the start of each logical page. A logical page consists of a header, a
76 body, and a footer section. Empty sections are valid. Different line numbering
77 options are independently available for header, body, and footer. For example,
78 \fB-bt\fR (the default) numbers non-blank lines in the body section and does
79 not number any lines in the header and footer sections.
80 .sp
81 .LP
82 The start of logical page sections are signaled by input lines containing
83 nothing but the following delimiter character(s):
84 .sp
86 .sp
87 .TS
88 box;
89 c | c
90 l | l .
91 Line contents Start Of
92 _
93 \e:\e:\e: header
94 _
95 \e:\e: body
96 _
97 \e: footer
98 .TE
100 .sp
101 .LP
102 Unless optioned otherwise, \fBnl\fR assumes the text being read is in a single
103 logical page body.
104 .SH OPTIONS
105 .sp
106 .LP
107 Command options may appear in any order and may be intermingled with an
108 optional file name. Only one file may be named. The specified default is used
109 when the option is not entered on the command line. \fB/usr/xpg4/bin/nl\fR
110 options require option arguments. A \fBSPACE\fR character \fBmay\fR separate
111 options from option arguments. \fB/usr/bin/nl\fR options \fBmay\fR have option
112 arguments. If option-arguments of \fB/usr/bin/nl\fR options are not specified,
113 these options result in the default. The supported options are:
114 .sp
115 .ne 2
116 .na
117 \fB\fB-b\fR\fItype\fR\fR
118 .ad
119 .RS 14n
120 Specifies which logical page body lines are to be numbered. Recognized
121 \fItype\fRs and their meanings are:
122 .sp
123 .ne 2
124 .na
125 \fB\fBa\fR\fR
126 .ad
127 .RS 8n
128 number all lines
129 .RE
131 .sp
132 .ne 2
133 .na
134 \fB\fBt\fR\fR
135 .ad
136 .RS 8n
137 number all non-empty lines.
138 .RE
140 .sp
141 .ne 2
142 .na
143 \fB\fBn\fR\fR
144 .ad
145 .RS 8n
146 no line numbering
147 .RE
149 .sp
150 .ne 2
151 .na
152 \fB\fBp\fIexp\fR\fR\fR
153 .ad
154 .RS 8n
155 number only lines that contain the regular expression specified in \fIexp\fR.
156 See NOTES below.
157 .RE
159 Default \fItype\fR for logical page body is \fBt\fR (text lines numbered).
160 .RE
162 .sp
163 .ne 2
164 .na
165 \fB\fB-f\fR\fItype\fR\fR
166 .ad
167 .RS 14n
168 Same as \fB-b\fR\fItype\fR except for footer. Default \fItype\fR for logical
169 page footer is \fBn\fR (no lines numbered).
170 .RE
172 .sp
173 .ne 2
174 .na
175 \fB\fB-d\fR\fIdelim\fR\fR
176 .ad
177 .RS 14n
178 The two delimiter characters specifying the start of a logical page section may
179 be changed from the default characters (\e\|:\|) to two user-specified
180 characters. If only one character is entered, the second character remains the
181 default character (:). No space should appear between the \fB-d\fR and the
182 delimiter characters. To enter a backslash, use two backslashes.
183 .RE
185 .sp
186 .ne 2
187 .na
188 \fB\fB-h\fR\fItype\fR\fR
189 .ad
190 .RS 14n
191 Same as \fB-b\fR\fItype\fR except for header. Default \fItype\fR for logical
192 page header is \fBn\fR (no lines numbered).
193 .RE
195 .sp
196 .ne 2
197 .na
198 \fB\fB-i\fR\fIincr\fR\fR
199 .ad
200 .RS 14n
201 \fIincr\fR is the increment value used to number logical page lines. Default
202 \fIincr\fR is \fB1\fR.
203 .RE
205 .sp
206 .ne 2
207 .na
208 \fB\fB-l\fR\fInum\fR\fR
209 .ad
210 .RS 14n
211 \fInum\fR is the number of blank lines to be considered as one. For example,
212 \fB\(mil2\fR results in only the second adjacent blank being numbered (if the
213 appropriate \fB-ha\fR, \fB-ba\fR, and/or \fB-fa\fR option is set). Default
214 \fInum\fR is \fB1\fR.
215 .RE
217 .sp
218 .ne 2
219 .na
220 \fB\fB-n\fR\fIformat\fR\fR
221 .ad
222 .RS 14n
223 \fIformat\fR is the line numbering format. Recognized values are:
224 .sp
225 .ne 2
226 .na
227 \fB\fBln\fR\fR
228 .ad
229 .RS 6n
230 left justified, leading zeroes suppressed
231 .RE
233 .sp
234 .ne 2
235 .na
236 \fB\fBrn\fR\fR
237 .ad
238 .RS 6n
239 right justified, leading zeroes suppressed
240 .RE
242 .sp
243 .ne 2
244 .na
245 \fB\fBrz\fR\fR
246 .ad
247 .RS 6n
248 right justified, leading zeroes kept
249 .RE
251 Default \fIformat\fR is \fBrn\fR (right justified).
252 .RE
254 .sp
255 .ne 2
256 .na
257 \fB\fB-p\fR\fR
258 .ad
259 .RS 14n
260 Do not restart numbering at logical page delimiters.
261 .RE
263 .sp
264 .ne 2
265 .na
266 \fB\fB-s\fR\fIsep\fR\fR
267 .ad
268 .RS 14n
269 \fIsep\fR is the character(s) used in separating the line number and the
270 corresponding text line. Default \fIsep\fR is a \fBTAB\fR.
271 .RE
273 .sp
274 .ne 2
275 .na
276 \fB\fB-v\fR\fIstartnum\fR\fR
277 .ad
278 .RS 14n
279 \fIstartnum\fR is the initial value used to number logical page lines. Default
280 \fIstartnum\fR is \fB1\fR.
281 .RE
283 .sp
284 .ne 2
285 .na
286 \fB\fB-w\fR\fIwidth\fR\fR
287 .ad
288 .RS 14n
289 \fIwidth\fR is the number of characters to be used for the line number. Default
290 \fIwidth\fR is \fB6\fR.
291 .RE
293 .SH OPERANDS
294 .sp
295 .LP
296 The following operand is supported:
297 .sp
298 .ne 2
299 .na
300 \fB\fIfile\fR\fR
301 .ad
302 .RS 8n
303 A path name of a text file to be line-numbered.
304 .RE
306 .SH EXAMPLES
307 .LP
308 \fBExample 1 \fRAn example of the nl command
309 .sp
310 .LP
311 The command:
313 .sp
314 .in +2
315 .nf
316 example% \fBnl -v10 -i10 -d!+ filename1\fR
317 .fi
318 .in -2
319 .sp
321 .sp
322 .LP
323 will cause the first line of the page body to be numbered \fB10\fR, the second
324 line of the page body to be numbered \fB20\fR, the third \fB30\fR, and so
325 forth. The logical page delimiters are !+.
327 .SH ENVIRONMENT VARIABLES
328 .sp
329 .LP
330 See \fBenviron\fR(5) for descriptions of the following environment variables
331 that affect the execution of \fBnl\fR: \fBLANG\fR, \fBLC_ALL\fR,
332 \fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
333 .SH EXIT STATUS
334 .sp
335 .LP
336 The following exit values are returned:
337 .sp
338 .ne 2
339 .na
340 \fB\fB0\fR\fR
341 .ad
342 .RS 6n
343 Successful completion.
344 .RE
346 .sp
347 .ne 2
348 .na
349 \fB\fB>0\fR\fR
350 .ad
351 .RS 6n
352 An error occurred.
353 .RE
355 .SH FILES
356 .sp
357 .ne 2
358 .na
359 \fB\fB/usr/lib/locale/\fIlocale\fR/LC_COLLATE/CollTable\fR\fR
360 .ad
361 .sp .6
362 .RS 4n
363 Collation table generated by \fBlocaledef\fR
364 .RE
366 .sp
367 .ne 2
368 .na
369 \fB\fB/usr/lib/locale/\fIlocale\fR/LC_COLLATE/coll.so\fR\fR
370 .ad
371 .sp .6
372 .RS 4n
373 Shared object containing string transformation library routines
374 .RE
376 .SH ATTRIBUTES
377 .sp
378 .LP
379 See \fBattributes\fR(5) for descriptions of the following attributes:
380 .SS "/usr/xpg4/bin/nl"
381 .sp
383 .sp
384 .TS
385 box;
386 c | c
387 l | l .
388 ATTRIBUTE TYPE ATTRIBUTE VALUE
389 _
390 Interface Stability Standard
391 .TE
393 .SH SEE ALSO
394 .sp
395 .LP
396 \fBpr\fR(1), \fBattributes\fR(5), \fBenviron\fR(5), \fBregex\fR(5),
397 \fBregexp\fR(5), \fBstandards\fR(5)
398 .SH NOTES
399 .sp
400 .LP
401 Internationalized Regular Expressions are used in the POSIX and "C" locales. In
402 other locales, Internationalized Regular Expressions are used if the following
403 two conditions are met:
404 .RS +4
405 .TP
406 .ie t \(bu
407 .el o
408 \fB/usr/lib/locale/\fIlocale\fR/LC_COLLATE/CollTable\fR is present.
409 .RE
410 .RS +4
411 .TP
412 .ie t \(bu
413 .el o
414 \fB/usr/lib/locale/\fIlocale\fR/LC_COLLATE/coll.so\fR is not present.
415 .RE
416 .sp
417 .LP
418 Otherwise, Simple Regular Expressions are used.
419 .sp
420 .LP
421 Internationalized Regular Expressions are explained on \fBregex\fR(5). Simple
422 Regular Expressions are explained on \fBregexp\fR(5).