]> git.saurik.com Git - apple/shell_cmds.git/blob - jot/jot.1
shell_cmds-162.tar.gz
[apple/shell_cmds.git] / jot / jot.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 .\" @(#)jot.1 8.1 (Berkeley) 6/6/93
33 .\" $FreeBSD: src/usr.bin/jot/jot.1,v 1.24 2010/02/20 00:16:44 delphij Exp $
34 .\"
35 .Dd February 19, 2010
36 .Dt JOT 1
37 .Os
38 .Sh NAME
39 .Nm jot
40 .Nd print sequential or random data
41 .Sh SYNOPSIS
42 .Nm
43 .Op Fl cnr
44 .Op Fl b Ar word
45 .Op Fl w Ar word
46 .Op Fl s Ar string
47 .Op Fl p Ar precision
48 .Op Ar reps Op Ar begin Op Ar end Op Ar s
49 .Sh DESCRIPTION
50 The
51 .Nm
52 utility is used to print out increasing, decreasing, random,
53 or redundant data, usually numbers, one per line.
54 .Pp
55 The following options are available:
56 .Bl -tag -width indent
57 .It Fl r
58 Generate random data instead of the default sequential data.
59 .It Fl b Ar word
60 Just print
61 .Ar word
62 repetitively.
63 .It Fl w Ar word
64 Print
65 .Ar word
66 with the generated data appended to it.
67 Octal, hexadecimal, exponential,
68 .Tn ASCII ,
69 zero padded,
70 and right-adjusted representations
71 are possible by using the appropriate
72 .Xr printf 3
73 conversion specification inside
74 .Ar word ,
75 in which case the data are inserted rather than appended.
76 .It Fl c
77 This is an abbreviation for
78 .Fl w Ar %c .
79 .It Fl s Ar string
80 Print data separated by
81 .Ar string .
82 Normally, newlines separate data.
83 .It Fl n
84 Do not print the final newline normally appended to the output.
85 .It Fl p Ar precision
86 Print only as many digits or characters of the data
87 as indicated by the integer
88 .Ar precision .
89 In the absence of
90 .Fl p ,
91 the precision is the greater of the precisions of
92 .Ar begin
93 and
94 .Ar end .
95 The
96 .Fl p
97 option is overridden by whatever appears in a
98 .Xr printf 3
99 conversion following
100 .Fl w .
101 .El
102 .Pp
103 The last four arguments indicate, respectively,
104 the number of data, the lower bound, the upper bound,
105 and the step size or, for random data, the seed.
106 While at least one of them must appear,
107 any of the other three may be omitted, and
108 will be considered as such if given as
109 .Fl ""
110 or as an empty string.
111 Any three of these arguments determines the fourth.
112 If four are specified and the given and computed values of
113 .Ar reps
114 conflict, the lower value is used.
115 If fewer than three are specified, defaults are assigned
116 left to right, except for
117 .Ar s ,
118 which assumes a default of 1 or -1 if both
119 .Ar begin
120 and
121 .Ar end
122 are given.
123 .Pp
124 Defaults for the four arguments are, respectively,
125 100, 1, 100, and 1, except that when random data are requested,
126 the seed,
127 .Ar s ,
128 is picked randomly.
129 The
130 .Ar reps
131 argument is expected to be an unsigned integer,
132 and if given as zero is taken to be infinite.
133 The
134 .Ar begin
135 and
136 .Ar end
137 arguments may be given as real numbers or as characters
138 representing the corresponding value in
139 .Tn ASCII .
140 The last argument must be a real number.
141 .Pp
142 Random numbers are obtained through
143 .Xr arc4random 3
144 when no seed is specified,
145 and through
146 .Xr random 3
147 when a seed is given.
148 When
149 .Nm
150 is asked to generate random integers or characters with begin
151 and end values in the range of the random number generator function
152 and no format is specified with one of the
153 .Fl w ,
154 .Fl b ,
155 or
156 .Fl p
157 options,
158 .Nm
159 will arrange for all the values in the range to appear in the output
160 with an equal probability.
161 In all other cases be careful to ensure that the output format's
162 rounding or truncation will not skew the distribution of output
163 values in an unintended way.
164 .Pp
165 The name
166 .Nm
167 derives in part from
168 .Nm iota ,
169 a function in APL.
170 .Sh EXIT STATUS
171 .Ex -std
172 .Sh EXAMPLES
173 The command
174 .Dl jot - 1 10
175 .Pp
176 prints the integers from 1 to 10,
177 while the command
178 .Dl jot 21 -1 1.00
179 .Pp
180 prints 21 evenly spaced numbers increasing from -1 to 1.
181 The
182 .Tn ASCII
183 character set is generated with
184 .Dl jot -c 128 0
185 .Pp
186 and the strings xaa through xaz with
187 .Dl jot -w xa%c 26 a
188 .Pp
189 while 20 random 8-letter strings are produced with
190 .Dl "jot -r -c 160 a z | rs -g 0 8"
191 .Pp
192 Infinitely many
193 .Em yes Ns 's
194 may be obtained through
195 .Dl jot -b yes 0
196 .Pp
197 and thirty
198 .Xr ed 1
199 substitution commands applying to lines 2, 7, 12, etc.\& is
200 the result of
201 .Dl jot -w %ds/old/new/ 30 2 - 5
202 .Pp
203 The stuttering sequence 9, 9, 8, 8, 7, etc.\& can be
204 produced by suitable choice of step size,
205 as in
206 .Dl jot - 9 0 -.5
207 .Pp
208 and a file containing exactly 1024 bytes is created with
209 .Dl jot -b x 512 > block
210 .Pp
211 Finally, to set tabs four spaces apart starting
212 from column 10 and ending in column 132, use
213 .Dl expand -`jot -s, - 10 132 4`
214 .Pp
215 and to print all lines 80 characters or longer,
216 .Dl grep `jot -s \&"\&" -b \&. 80`
217 .Sh DIAGNOSTICS
218 The following diagnostic messages deserve special explanation:
219 .Bl -diag
220 .It "illegal or unsupported format '%s'"
221 The requested conversion format specifier for
222 .Xr printf 3
223 was not of the form
224 .Dl %[#][ ][{+,-}][0-9]*[.[0-9]*]?
225 where
226 .Dq ?\&
227 must be one of
228 .Dl [l]{d,i,o,u,x}
229 or
230 .Dl {c,e,f,g,D,E,G,O,U,X}
231 .It "range error in conversion"
232 A value to be printed fell outside the range of the data type
233 associated with the requested output format.
234 .It "too many conversions"
235 More than one conversion format specifier has been supplied,
236 but only one is allowed.
237 .El
238 .Sh SEE ALSO
239 .Xr ed 1 ,
240 .Xr expand 1 ,
241 .Xr rs 1 ,
242 .Xr seq 1 ,
243 .Xr yes 1 ,
244 .Xr arc4random 3 ,
245 .Xr printf 3 ,
246 .Xr random 3
247 .Sh HISTORY
248 The
249 .Nm
250 utility first appeared in
251 .Bx 4.2 .