xref: /minix3/games/factor/factor.6 (revision 0a6a1f1d05b60e214de2f05a7310ddd1f0e590e7)
1.\"	$NetBSD: factor.6,v 1.13 2014/10/02 21:36:37 ast Exp $
2.\"
3.\" Copyright (c) 1989, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" Landon Curt Noll.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. Neither the name of the University nor the names of its contributors
18.\"    may be used to endorse or promote products derived from this software
19.\"    without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31.\" SUCH DAMAGE.
32.\"
33.\"	@(#)factor.6	8.1 (Berkeley) 5/31/93
34.\"
35.\"
36.\" By Landon Curt Noll, http://www.isthe.com/chongo/index.html /\oo/\
37.\"
38.Dd May 15, 2010
39.Dt FACTOR 6
40.Os
41.Sh NAME
42.Nm factor
43.Nd factor a number
44.Sh SYNOPSIS
45.Nm
46.Op Ar number ...
47.Sh DESCRIPTION
48The
49.Nm
50utility factors integers larger than 1.
51When a number is factored, it is printed, followed by a
52.Dq \&: ,
53and the list of
54.Pq prime
55factors on a single line.
56Factors are listed in ascending order, and are preceded by a space.
57If a factor divides a value more than once, it will be printed more than once.
58.Pp
59When
60.Nm
61is invoked with one or more arguments, each argument will be factored.
62.Pp
63When
64.Nm
65is invoked with no arguments,
66.Nm
67reads numbers, one per line, from standard input, until end of file or error.
68Leading white-space and empty lines are ignored.
69Numbers may be preceded by a single +.
70Integer less than 2 are rejected.
71Numbers are terminated by a non-digit character (such as a newline).
72After a number is read, it is factored.
73Input lines must not be longer than
74.Dv LINE_MAX \- 1
75(currently 2047) characters.
76.Pp
77By default,
78.Nm
79is compiled against the OpenSSL bignum implementation
80.Xr openssl_bn 3 ,
81which lets it handle arbitrarily large values.
82.Pq Note however that very large values can take a very long time to factor.
83If
84.Nm
85is compiled without OpenSSL it is limited to the maximum value of
86.Vt unsigned long .
87.Sh DIAGNOSTICS
88Out of range or invalid input results in
89an appropriate error message to standard error.
90.Sh AUTHORS
91Originally by
92.An Landon Curt Noll .
93