README 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. Mlucas 14.1 <http://hogranch.com/mayer/README.html>
  2. mlucas is an open-source (and free/libre) program
  3. for performing Lucas-Lehmer test on prime-exponent Mersenne numbers,
  4. that is, integers of the form 2 ^ p - 1, with prime exponent p.
  5. In short, everything you need to search for world-record Mersenne primes!
  6. It has been used in the verification of various Mersenne primes,
  7. including the 45th, 46th and 48th found Mersenne prime.
  8. You may use it to test any suitable number as you wish,
  9. but it is preferable that you do so in a coordinated fashion,
  10. as part of the Great Internet Mersenne Prime Search (GIMPS).
  11. For more information on GIMPS,
  12. see <http://www.mersenne.org/prime.html> for details.
  13. Menu:
  14. Installation
  15. Usage
  16. News
  17. Licensing
  18. Bugs
  19. Copyright
  20. Installation:
  21. Generic installation guide can be found in INSTALL.
  22. Basically, the 5 steps
  23. 1. $ mkdir build && cd build
  24. 2. $ ../configure
  25. 3. $ make -j
  26. or $ make
  27. 4. $ make check
  28. 5. $ make install
  29. will complete the installation.
  30. Normally, configure should guess your system configuration.
  31. However, you can always override it by passing flags to configure.
  32. Running test in step 4 is optional.
  33. Run it if you want to be safe or have passed flags to configure.
  34. Below is a summary of the custom options understood by configure.
  35. You can read all options by running `$ ../configure -h' in step 2
  36. Custom Options:
  37. (please note that all options mentioned below does NOT override one another)
  38. --enable-NORMAL-CFLAGS='FOO' or --disable-NORMAL-CFLAGS
  39. set CFLAGS for normal source files to FOO or nothing
  40. ['-Os']
  41. --enable-TRICKY-CFLAGS='FOO' or --disable-TRICKY-CFLAGS
  42. set CFLAGS for optimization-sensitive source files
  43. to FOO or nothing ['-O1']
  44. CFLAGS='FOO' set CFLAGS for all source files to FOO ['']
  45. CPPFLAGS='FOO' set CPPFLAGS for all source files to FOO ['']
  46. LDFLAGS='FOO' set LDFLAGS for all linking to FOO ['']
  47. --host='FOO' skip autodetection and force detecting host as FOO
  48. (set --host=none to disable host-specific
  49. compilation flags)
  50. --enable-instruction=[SSE2|AVX|AVX2] or --disable-instruction
  51. build with SSE2, AVX, AVX2 or without extended
  52. instruction set
  53. --disable-threads force building without multithread-support
  54. --enable-MLUCAS-DEFAULT-PATH
  55. set MLUCAS_DEFAULT_PATH (unset by default) to
  56. "$HOME/.mlucas.d/"
  57. --disable-silent-rules increase make verbosity
  58. --enable-verbose-compiler
  59. enable verbose compiler
  60. End of Custom Options
  61. Usage:
  62. For local documentation, please refer to html/README.html
  63. For online documentation, please refer to
  64. http://hogranch.com/mayer/README.html
  65. To show the help menu of Mlucas, enter
  66. $ <BUILD_DIR>/mlucas -h
  67. After installation, you can read the man page by
  68. $ man mlucas
  69. News:
  70. To read news taken from html/README.html in plain text, see NEWS.
  71. Licensing:
  72. Most of the files are licensed under
  73. the GNU General Public License version 2 or later.
  74. Other files are under permissive licenses or in the public domain.
  75. All files except empty files or generated data
  76. should have a license header or footer.
  77. If not, please send a bug report (see section Bugs for details).
  78. See COPYING for details regarding licensing.
  79. Bugs:
  80. The argument parser is buggy. The relative position of arguments is
  81. relevant to mlucas, the order of arguments in SYNOPSIS in mlucas(1)
  82. should be followed to avoid confusing the parser.
  83. Only 100, 1000 and 10000 are supported for -iters flag. However,
  84. the parser will not reject unsupported arguments. Using
  85. unsupported arguments for -iters flag may trigger strange behaviour.
  86. For problems regarding the program mlucas, please contact the author
  87. Ernst W. Mayer <ewmayer@aol.com>. For installation and documentation
  88. related problems regarding this package and this README, please
  89. contact Alex Vong <alexvong1995@gmail.com>.
  90. See BUGS section in mlucas(1) for details.
  91. Copyright:
  92. README - readme for Mlucas
  93. Copyright (C) 2015 Alex Vong
  94. This program is free software; you can redistribute it and/or
  95. modify it under the terms of the GNU General Public License
  96. as published by the Free Software Foundation; either version 2
  97. of the License, or (at your option) any later version.
  98. This program is distributed in the hope that it will be useful,
  99. but WITHOUT ANY WARRANTY; without even the implied warranty of
  100. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  101. GNU General Public License for more details.
  102. You should have received a copy of the GNU General Public License
  103. along with this program; if not, write to the Free Software Foundation,
  104. Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.