Initial import from FreeBSD RELENG_4:
[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 .\"
39 .\" By: Landon Curt Noll   chongo@toad.com,   ...!{sun,tolsoft}!hoptoad!chongo
40 .\"
41 .\"   chongo <for a good prime call: 391581 * 2^216193 - 1> /\oo/\
42 .\"
43 .Dd October 10, 2002
44 .Dt FACTOR 6
45 .Os
46 .Sh NAME
47 .Nm factor , primes
48 .Nd factor a number, generate primes
49 .Sh SYNOPSIS
50 .Nm
51 .Op Fl h
52 .Op Ar number ...
53 .Nm primes
54 .Op Fl h
55 .Op Ar start Op Ar stop
56 .Sh DESCRIPTION
57 The
58 .Nm
59 utility will factor positive integers.
60 When a number is factored, it is printed, followed by a
61 .Ql \&: ,
62 and the list of factors on a single line.
63 Factors are listed in ascending order, and are preceded by a space.
64 If a factor divides a value more than once, it will be printed more than once.
65 .Pp
66 When
67 .Nm
68 is invoked with one or more arguments, each argument will be factored.
69 .Pp
70 When
71 .Nm
72 is invoked with no arguments,
73 .Nm
74 reads numbers, one per line, from standard input, until end of file or error.
75 Leading white-space and empty lines are ignored.
76 Numbers may be preceded by a single
77 .Ql + .
78 Numbers are terminated by a non-digit character (such as a newline).
79 After a number is read, it is factored.
80 .Pp
81 The
82 .Nm primes
83 utility prints primes in ascending order, one per line, starting at or above
84 .Ar start
85 and continuing until, but not including
86 .Ar stop .
87 The
88 .Ar start
89 value must be at least 0 and not greater than
90 .Ar stop .
91 The
92 .Ar stop
93 value must not be greater than the maximum.
94 The default and maximum value of
95 .Ar stop
96 is 4294967295 on 32-bit architectures
97 and 18446744073709551615 on 64-bit ones.
98 .Pp
99 When the
100 .Nm primes
101 utility is invoked with no arguments,
102 .Ar start
103 is read from standard input and
104 .Ar stop
105 is taken to be the maximum.
106 The
107 .Ar start
108 value may be preceded by a single
109 .Ql + .
110 The
111 .Ar start
112 value is terminated by a non-digit character (such as a newline).
113 .Sh DIAGNOSTICS
114 .Bl -diag
115 .It "negative numbers aren't permitted"
116 .It "illegal numeric format"
117 .It "start value must be less than stop value"
118 .It "Result too large"
119 .El
120 .Sh BUGS
121 .Nm
122 cannot handle the
123 .Dq "10 most wanted"
124 factor list,
125 .Nm primes
126 will not get you a world record.