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