Merge from vendor branch TCPDUMP:
[dragonfly.git] / games / factor / factor.6
1 .\" Copyright (c) 1989, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Landon Curt Noll.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by the University of
18 .\"     California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\"     @(#)factor.6    8.1 (Berkeley) 5/31/93
36 .\"
37 .\" $FreeBSD: src/games/factor/factor.6,v 1.5.2.3 2003/01/26 02:54:56 keramida Exp $
38 .\" $DragonFly: src/games/factor/factor.6,v 1.2 2003/06/17 04:25:23 dillon Exp $
39 .\"
40 .\" By: Landon Curt Noll   chongo@toad.com,   ...!{sun,tolsoft}!hoptoad!chongo
41 .\"
42 .\"   chongo <for a good prime call: 391581 * 2^216193 - 1> /\oo/\
43 .\"
44 .Dd October 10, 2002
45 .Dt FACTOR 6
46 .Os
47 .Sh NAME
48 .Nm factor , primes
49 .Nd factor a number, generate primes
50 .Sh SYNOPSIS
51 .Nm
52 .Op Fl h
53 .Op Ar number ...
54 .Nm primes
55 .Op Fl h
56 .Op Ar start Op Ar stop
57 .Sh DESCRIPTION
58 The
59 .Nm
60 utility will factor positive integers.
61 When a number is factored, it is printed, followed by a
62 .Ql \&: ,
63 and the list of factors on a single line.
64 Factors are listed in ascending order, and are preceded by a space.
65 If a factor divides a value more than once, it will be printed more than once.
66 .Pp
67 When
68 .Nm
69 is invoked with one or more arguments, each argument will be factored.
70 .Pp
71 When
72 .Nm
73 is invoked with no arguments,
74 .Nm
75 reads numbers, one per line, from standard input, until end of file or error.
76 Leading white-space and empty lines are ignored.
77 Numbers may be preceded by a single
78 .Ql + .
79 Numbers are terminated by a non-digit character (such as a newline).
80 After a number is read, it is factored.
81 .Pp
82 The
83 .Nm primes
84 utility prints primes in ascending order, one per line, starting at or above
85 .Ar start
86 and continuing until, but not including
87 .Ar stop .
88 The
89 .Ar start
90 value must be at least 0 and not greater than
91 .Ar stop .
92 The
93 .Ar stop
94 value must not be greater than the maximum.
95 The default and maximum value of
96 .Ar stop
97 is 4294967295 on 32-bit architectures
98 and 18446744073709551615 on 64-bit ones.
99 .Pp
100 When the
101 .Nm primes
102 utility is invoked with no arguments,
103 .Ar start
104 is read from standard input and
105 .Ar stop
106 is taken to be the maximum.
107 The
108 .Ar start
109 value may be preceded by a single
110 .Ql + .
111 The
112 .Ar start
113 value is terminated by a non-digit character (such as a newline).
114 .Sh DIAGNOSTICS
115 .Bl -diag
116 .It "negative numbers aren't permitted"
117 .It "illegal numeric format"
118 .It "start value must be less than stop value"
119 .It "Result too large"
120 .El
121 .Sh BUGS
122 .Nm
123 cannot handle the
124 .Dq "10 most wanted"
125 factor list,
126 .Nm primes
127 will not get you a world record.