Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[dragonfly.git] / usr.bin / 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.8.2.6 2002/07/15 07:13:13 keramida Exp $
34 .\" $DragonFly: src/usr.bin/jot/jot.1,v 1.2 2003/06/17 04:29:27 dillon Exp $
35 .\"
36 .Dd June 6, 1993
37 .Dt JOT 1
38 .Os
39 .Sh NAME
40 .Nm jot
41 .Nd print sequential or random data
42 .Sh SYNOPSIS
43 .Nm
44 .Op Fl cnr
45 .Op Fl b Ar word
46 .Op Fl w Ar word
47 .Op Fl s Ar string
48 .Op Fl p Ar precision
49 .Op Ar reps Op Ar begin Op Ar end Op Ar s
50 .Sh DESCRIPTION
51 The
52 .Nm
53 utility is used to print out increasing, decreasing, random,
54 or redundant data, usually numbers, one per line.
55 .Pp
56 The following options are available:
57 .Bl -tag -width indent
58 .It Fl r
59 Generate random data instead of the default sequential data.
60 .It Fl b Ar word
61 Just print
62 .Ar word
63 repetitively.
64 .It Fl w Ar word
65 Print
66 .Ar word
67 with the generated data appended to it.
68 Octal, hexadecimal, exponential,
69 .Tn ASCII ,
70 zero padded,
71 and right-adjusted representations
72 are possible by using the appropriate
73 .Xr printf 3
74 conversion specification inside
75 .Ar word ,
76 in which case the data are inserted rather than appended.
77 .It Fl c
78 This is an abbreviation for
79 .Fl w Ar %c .
80 .It Fl s Ar string
81 Print data separated by
82 .Ar string .
83 Normally, newlines separate data.
84 .It Fl n
85 Do not print the final newline normally appended to the output.
86 .It Fl p Ar precision
87 Print only as many digits or characters of the data
88 as indicated by the integer
89 .Ar precision .
90 In the absence of
91 .Fl p ,
92 the precision is the greater of the precisions of
93 .Ar begin
94 and
95 .Ar end .
96 The
97 .Fl p
98 option is overridden by whatever appears in a
99 .Xr printf 3
100 conversion following
101 .Fl w .
102 .El
103 .Pp
104 The last four arguments indicate, respectively,
105 the number of data, the lower bound, the upper bound,
106 and the step size or, for random data, the seed.
107 While at least one of them must appear,
108 any of the other three may be omitted, and
109 will be considered as such if given as
110 .Fl "" .
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 its default unless 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 random 3 .
144 The name
145 .Nm
146 derives in part from
147 .Nm iota ,
148 a function in APL.
149 .Sh EXAMPLES
150 The command
151 .Dl jot 21 -1 1.00
152 .Pp
153 prints 21 evenly spaced numbers increasing from -1 to 1.
154 The
155 .Tn ASCII
156 character set is generated with
157 .Dl jot -c 128 0
158 .Pp
159 and the strings xaa through xaz with
160 .Dl jot -w xa%c 26 a
161 .Pp
162 while 20 random 8-letter strings are produced with
163 .Dl "jot -r -c 160 a z | rs -g 0 8"
164 .Pp
165 Infinitely many
166 .Em yes Ns 's
167 may be obtained through
168 .Dl jot -b yes 0
169 .Pp
170 and thirty
171 .Xr ed 1
172 substitution commands applying to lines 2, 7, 12, etc. is
173 the result of
174 .Dl jot -w %ds/old/new/ 30 2 - 5
175 .Pp
176 The stuttering sequence 9, 9, 8, 8, 7, etc. can be
177 produced by suitable choice of step size,
178 as in
179 .Dl jot - 9 0 -.5
180 .Pp
181 and a file containing exactly 1024 bytes is created with
182 .Dl jot -b x 512 > block
183 .Pp
184 Finally, to set tabs four spaces apart starting
185 from column 10 and ending in column 132, use
186 .Dl expand -`jot -s, - 10 132 4`
187 .Pp
188 and to print all lines 80 characters or longer,
189 .Dl grep `jot -s \&"\&" -b \&. 80`
190 .Sh DIAGNOSTICS
191 .Ex -std
192 The following diagnostic messages deserve special explanation:
193 .Bl -diag
194 .It "illegal or unsupported format '%s'"
195 The requested conversion format specifier for
196 .Xr printf 3
197 was not of the form
198 .Dl %[#][ ][{+,-}][0-9]*[.[0-9]*]?
199 where
200 .Dq ?\&
201 must be one of
202 .Dl [l]{d,i,o,u,x}
203 or
204 .Dl {c,e,f,g,D,E,G,O,U,X}
205 .It "range error in conversion"
206 A value to be printed fell outside the range of the data type
207 associated with the requested output format.
208 .It "too many conversions"
209 More than one conversion format specifier has been supplied,
210 but only one is allowed.
211 .El
212 .Sh SEE ALSO
213 .Xr ed 1 ,
214 .Xr expand 1 ,
215 .Xr rs 1 ,
216 .Xr yes 1 ,
217 .Xr printf 3 ,
218 .Xr random 3