[apple/shell_cmds.git] / seq / seq.1

.\"	$NetBSD: seq.1,v 1.6 2008/11/26 15:03:47 ginsbach Exp $
.\"
.\" Copyright (c) 2005 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Brian Ginsbach.
.\"
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
.\"
.\" $FreeBSD: src/usr.bin/seq/seq.1,v 1.1 2010/02/19 23:54:12 delphij Exp $
.\"
.Dd February 19, 2010
.Dt SEQ 1
.Os
.Sh NAME
.Nm seq
.Nd print sequences of numbers
.Sh SYNOPSIS
.Nm
.Op Fl w
.Op Fl f Ar format
.Op Fl s Ar string
.Op Fl t Ar string
.Op Ar first Op Ar incr
.Ar last
.Sh DESCRIPTION
The
.Nm
utility prints a sequence of numbers, one per line
.Pq default ,
from
.Ar first
.Pq default 1 ,
to near
.Ar last
as possible, in increments of
.Ar incr
.Pq default 1 .
When
.Ar first
is larger than
.Ar last
the default
.Ar incr
is -1.
.Pp
All numbers are interpreted as floating point.
.Pp
Normally integer values are printed as decimal integers.
.Pp
The
.Nm
utility accepts the following options:
.Bl -tag -width Ar
.It Fl f Ar format
Use a
.Xr printf 3
style
.Ar format
to print each number.
Only the
.Cm E ,
.Cm e ,
.Cm f ,
.Cm G ,
.Cm g ,
and
.Cm %
conversion characters are valid, along with any optional
flags and an optional numeric minimum field width or precision.
The
.Ar format
can contain character escape sequences in backslash notation as
defined in
.St -ansiC .
The default is
.Cm %g .
.It Fl s Ar string
Use
.Ar string
to separate numbers.
The
.Ar string
can contain character escape sequences in backslash notation as
defined in
.St -ansiC .
The default is
.Cm \en .
.It Fl t Ar string
Use
.Ar string
to terminate sequence of numbers.
The
.Ar string
can contain character escape sequences in backslash notation as
defined in
.St -ansiC .
This option is useful when the default separator
does not contain a
.Cm \en .
.It Fl w
Equalize the widths of all numbers by padding with zeros as necessary.
This option has no effect with the
.Fl f
option.
If any sequence numbers will be printed in exponential notation,
the default conversion is changed to
.Cm %e .
.El
.Pp
The
.Nm
utility exits 0 on success and non-zero if an error occurs.
.Sh EXAMPLES
.Bd -literal -offset indent
# seq 1 3
1
2
3

# seq 3 1
3
2
1

# seq -w 0 .05 .1
0.00
0.05
0.10
.Ed
.Sh SEE ALSO
.Xr jot 1 ,
.Xr printf 1 ,
.Xr printf 3
.Sh HISTORY
The
.Nm
command first appeared in
.Tn "Plan 9 from Bell Labs" .
A
.Nm
command appeared in
.Nx 3.0 ,
and ported to
.Fx 9.0 .
This command was based on the command of the same name in
.Tn "Plan 9 from Bell Labs"
and the
.Tn GNU
core utilities.
The
.Tn GNU
.Nm
command first appeared in the 1.13 shell utilities release.
.Sh BUGS
The
.Fl w
option does not handle the transition from pure floating point
to exponent representation very well.
The
.Nm
command is not bug for bug compatible with the
.Tn "Plan 9 from Bell Labs"
or
.Tn GNU
versions of
.Nm .
Commit	Line	Data
f14763b6 A	1	.\" $NetBSD: seq.1,v 1.6 2008/11/26 15:03:47 ginsbach Exp $
	2	.\"
	3	.\" Copyright (c) 2005 The NetBSD Foundation, Inc.
	4	.\" All rights reserved.
	5	.\"
	6	.\" This code is derived from software contributed to The NetBSD Foundation
	7	.\" by Brian Ginsbach.
	8	.\"
	9	.\" Redistribution and use in source and binary forms, with or without
	10	.\" modification, are permitted provided that the following conditions
	11	.\" are met:
	12	.\" 1. Redistributions of source code must retain the above copyright
	13	.\" notice, this list of conditions and the following disclaimer.
	14	.\" 2. Redistributions in binary form must reproduce the above copyright
	15	.\" notice, this list of conditions and the following disclaimer in the
	16	.\" documentation and/or other materials provided with the distribution.
	17	.\"
	18	.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
	19	.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
	20	.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	21	.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
	22	.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	23	.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	24	.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	25	.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	26	.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	27	.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	28	.\" POSSIBILITY OF SUCH DAMAGE.
	29	.\"
	30	.\" $FreeBSD: src/usr.bin/seq/seq.1,v 1.1 2010/02/19 23:54:12 delphij Exp $
	31	.\"
	32	.Dd February 19, 2010
	33	.Dt SEQ 1
	34	.Os
	35	.Sh NAME
	36	.Nm seq
	37	.Nd print sequences of numbers
	38	.Sh SYNOPSIS
	39	.Nm
	40	.Op Fl w
	41	.Op Fl f Ar format
	42	.Op Fl s Ar string
	43	.Op Fl t Ar string
	44	.Op Ar first Op Ar incr
	45	.Ar last
	46	.Sh DESCRIPTION
	47	The
	48	.Nm
	49	utility prints a sequence of numbers, one per line
	50	.Pq default ,
	51	from
	52	.Ar first
	53	.Pq default 1 ,
	54	to near
	55	.Ar last
	56	as possible, in increments of
	57	.Ar incr
	58	.Pq default 1 .
	59	When
	60	.Ar first
	61	is larger than
	62	.Ar last
	63	the default
	64	.Ar incr
65	is -1.
66	.Pp
67	All numbers are interpreted as floating point.
68	.Pp
69	Normally integer values are printed as decimal integers.
70	.Pp
71	The
72	.Nm
73	utility accepts the following options:
74	.Bl -tag -width Ar
75	.It Fl f Ar format
76	Use a
77	.Xr printf 3
78	style
79	.Ar format
80	to print each number.
81	Only the
82	.Cm E ,
83	.Cm e ,
84	.Cm f ,
85	.Cm G ,
86	.Cm g ,
87	and
88	.Cm %
89	conversion characters are valid, along with any optional
90	flags and an optional numeric minimum field width or precision.
91	The
92	.Ar format
93	can contain character escape sequences in backslash notation as
94	defined in
95	.St -ansiC .
96	The default is
97	.Cm %g .
98	.It Fl s Ar string
99	Use
100	.Ar string
101	to separate numbers.
102	The
103	.Ar string
104	can contain character escape sequences in backslash notation as
105	defined in
106	.St -ansiC .
107	The default is
108	.Cm \en .
109	.It Fl t Ar string
110	Use
111	.Ar string
112	to terminate sequence of numbers.
113	The
114	.Ar string
115	can contain character escape sequences in backslash notation as
116	defined in
117	.St -ansiC .
118	This option is useful when the default separator
119	does not contain a
120	.Cm \en .
121	.It Fl w
122	Equalize the widths of all numbers by padding with zeros as necessary.
123	This option has no effect with the
124	.Fl f
125	option.
126	If any sequence numbers will be printed in exponential notation,
127	the default conversion is changed to
128	.Cm %e .
129	.El
130	.Pp
131	The
132	.Nm
133	utility exits 0 on success and non-zero if an error occurs.
134	.Sh EXAMPLES
135	.Bd -literal -offset indent
136	# seq 1 3
137	1
138	2
139	3
140
141	# seq 3 1
142	3
143	2
144	1
145
146	# seq -w 0 .05 .1
147	0.00
148	0.05
149	0.10
150	.Ed
151	.Sh SEE ALSO
152	.Xr jot 1 ,
153	.Xr printf 1 ,
154	.Xr printf 3
155	.Sh HISTORY
156	The
157	.Nm
158	command first appeared in
159	.Tn "Plan 9 from Bell Labs" .
160	A
161	.Nm
162	command appeared in
163	.Nx 3.0 ,
164	and ported to
165	.Fx 9.0 .
166	This command was based on the command of the same name in
167	.Tn "Plan 9 from Bell Labs"
168	and the
169	.Tn GNU
170	core utilities.
171	The
172	.Tn GNU
173	.Nm
174	command first appeared in the 1.13 shell utilities release.
175	.Sh BUGS
176	The
177	.Fl w
178	option does not handle the transition from pure floating point
179	to exponent representation very well.
180	The
181	.Nm
182	command is not bug for bug compatible with the
183	.Tn "Plan 9 from Bell Labs"
184	or
185	.Tn GNU
186	versions of
187	.Nm .