summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJudemir Ribeiro <jribeiro@venetian.bioinfo.puc.cl>2018-04-01 15:58:14 -0300
committerJudemir Ribeiro <jribeiro@venetian.bioinfo.puc.cl>2018-04-01 15:58:14 -0300
commit3290a3cd851c0af76aef1b8dcaca73241a5c5761 (patch)
tree11b52d66ab0ce86fa98387450aa6884f282f7738 /doc
parenta036cd81592e3b3de804ba88bb8f94729ab60b7d (diff)
downloadxmr-stak-3290a3cd851c0af76aef1b8dcaca73241a5c5761.zip
xmr-stak-3290a3cd851c0af76aef1b8dcaca73241a5c5761.tar.gz
Ported xmr-stak 2.3.0 rc to ppc64le
Diffstat (limited to 'doc')
-rw-r--r--doc/FAQ.md44
-rw-r--r--doc/compile.md13
-rw-r--r--doc/compile_Linux.md73
-rw-r--r--doc/tuning.md5
-rw-r--r--doc/usage.md11
5 files changed, 12 insertions, 134 deletions
diff --git a/doc/FAQ.md b/doc/FAQ.md
index 8739fc4..a5b2083 100644
--- a/doc/FAQ.md
+++ b/doc/FAQ.md
@@ -1,47 +1,12 @@
# FAQ
## Content Overview
-* ["Obtaining SeLockMemoryPrivilege failed."](#obtaining-selockmemoryprivilege-failed)
-* [VirtualAlloc failed](#virtualalloc-failed)
-* [Error msvcp140.dll and vcruntime140.dll not available](#error-msvcp140dll-and-vcruntime140dll-not-available)
* [Error: MEMORY ALLOC FAILED: mmap failed](#error-memory-alloc-failed-mmap-failed)
-* [Illegal instruction (core dumped)](#illegal-instruction)
-* [Virus Protection Alert](#virus-protection-alert)
* [Change Currency to Mine](#change-currency-to-mine)
* [How can I mine Monero](#how-can-i-mine-monero)
* [Why is Monero named monero7](why-is-monero-named-monero7)
* [Which currency must be chosen if my fork coin is not listed](#which-currency-must-be-chosen-if-my-fork-coin-is-not-listed)
-## "Obtaining SeLockMemoryPrivilege failed."
-
-For professional versions of Windows see [this article](https://msdn.microsoft.com/en-gb/library/ms190730.aspx).
-Make sure to reboot afterwards!
-
-For Windows 7/10 Home:
-
-1) Download and install [Windows Server 2003 Resource Kit Tools](https://www.microsoft.com/en-us/download/details.aspx?id=17657). Ignore any incompatibility warning during installation.
-
-2) Open cmd or PowerShell as an administrator.
-
-3) Use `ntrights -u %USERNAME% +r SeLockMemoryPrivilege` where %USERNAME% is the user that will be running the program.
-
-4) Reboot.
-
-Reference: http://rybkaforum.net/cgi-bin/rybkaforum/topic_show.pl?pid=259791#pid259791
-
-*Warning: Do not download ntrights.exe from any other site other than the offical Microsoft download page.*
-
-## VirtualAlloc failed
-
-If you set up the user rights properly ([see above](https://github.com/fireice-uk/xmr-stak/blob/master/doc/FAQ.md#selockmemoryprivilege-failed)), and your system has 4-8GB of RAM (50%+ use), there is a significant chance that there simply won't be a large enough chunk of contiguous memory because Windows is fairly bad at mitigating memory fragmentation.
-
-If that happens, disable all auto-staring applications and run the miner after a reboot.
-
-## Error msvcp140.dll and vcruntime140.dll not available
-
-Download and install this [runtime package](https://go.microsoft.com/fwlink/?LinkId=746572) from Microsoft. *Warning: Do NOT use "missing dll" sites - dll's are exe files with another name, and it is a fairly safe bet that any dll on a shady site like that will be trojaned. Please download offical runtimes from Microsoft above.*
-
-
## Error: MEMORY ALLOC FAILED: mmap failed
On Linux you will need to configure large page support and increase your ulimit -l.
@@ -59,15 +24,6 @@ You WILL need to log out and log back in for these settings to take affect on yo
You can also do it Windows-style and simply run-as-root, but this is NOT recommended for security reasons.
-## Illegal Instruction
-
-This typically means you are trying to run it on a CPU that does not have [AES](https://en.wikipedia.org/wiki/AES_instruction_set). This only happens on older version of miner, new version gives better error message (but still wont' work since your CPU doesn't support the required instructions).
-
-## Virus Protection Alert
-
-Some virus protection software flags the miner binary as *malware*. This is a false positive — the software does not contain any malware (and since it is open source, you can verify that yourself!)
-If your antivirus software flags **xmr-stak**, it will likely move it to its quarantine area. You may have to whitelist **xmr-stak** in your antivirus.
-
## Change Currency to Mine
If the miner is compiled for Monero and Aeon than you can change
diff --git a/doc/compile.md b/doc/compile.md
index 984c013..77287a2 100644
--- a/doc/compile.md
+++ b/doc/compile.md
@@ -6,10 +6,7 @@
* [CPU Build Options](#cpu-build-options)
* [AMD Build Options](#amd-build-options)
* [NVIDIA Build Options](#nvidia-build-options)
-* [Compile on Windows](compile_Windows.md)
* [Compile on Linux](compile_Linux.md)
-* [Compile on FreeBSD](compile_FreeBSD.md)
-* [Compile on macOS](compile_macOS.md)
## Build System
@@ -28,10 +25,7 @@ There are two easy ways to set variables for `cmake` to configure *xmr-stak*
- set a value `cmake .. -DNAME_OF_THE_OPTION=value`
After the configuration you need to compile the miner, follow the guide for your platform:
-* [Compile in Windows](compile_Windows.md)
* [Compile in Linux](compile_Linux.md)
-* [Compile in FreeBSD](compile_FreeBSD.md)
-* [Compile in macOS](compile_macOS.md)
## Generic Build Options
- `CMAKE_INSTALL_PREFIX` install miner to the home folder
@@ -42,14 +36,13 @@ After the configuration you need to compile the miner, follow the guide for your
- if you use static compile to run the miner on another system set `-DXMR-STAK_COMPILE=generic`
- `CMAKE_BUILD_TYPE` set the build type
- valid options: `Release` or `Debug`
- - you should always keep `Release` for your productive miners
+ - you should always keep `Release` for your production miners
- `MICROHTTPD_ENABLE` allow to disable/enable the dependency *microhttpd*
- there is no *http* interface available if option is disabled: `cmake .. -DMICROHTTPD_ENABLE=OFF`
- `OpenSSL_ENABLE` allow to disable/enable the dependency *OpenSSL*
- it is not possible to connect to a *https* secured pool if option is disabled: `cmake .. -DOpenSSL_ENABLE=OFF`
- `XMR-STAK_COMPILE` select the CPU compute architecture (default: native)
- native means the miner binary can be used only on the system where it is compiled but will archive the highest hash rate
- - use `cmake .. -DXMR-STAK_COMPILE=generic` to run the miner on all CPU's with sse2
## CPU Build Options
@@ -60,11 +53,11 @@ After the configuration you need to compile the miner, follow the guide for your
## AMD Build Options
-- `OpenCL_ENABLE` allow to disable/enable the AMD backend of the miner
+- `OpenCL_ENABLE` allow to disable/enable the AMD backend of the miner, default OFF
## NVIDIA Build Options
-- `CUDA_ENABLE` allow to disable/enable the NVIDIA backend of the miner
+- `CUDA_ENABLE` allow to disable/enable the NVIDIA backend of the miner, default OFF
- `CUDA_ARCH` build for a certain compute architecture
- this option needs a semicolon separated list
- `cmake .. -DCUDA_ARCH=61` or `cmake .. -DCUDA_ARCH=20;61`
diff --git a/doc/compile_Linux.md b/doc/compile_Linux.md
index 729f4d2..ae8e43d 100644
--- a/doc/compile_Linux.md
+++ b/doc/compile_Linux.md
@@ -2,9 +2,9 @@
## Install Dependencies
-### AMD APP SDK 3.0 (only needed to use AMD GPUs)
+### OpenCL
-- download and install the latest version from [http://developer.amd.com/amd-accelerated-parallel-processing-app-sdk/](http://developer.amd.com/amd-accelerated-parallel-processing-app-sdk/)
+AMD ROCm should compile, but I cannot test it due to lack of hardware.
### Cuda 8.0+ (only needed to use NVIDIA GPUs)
@@ -16,24 +16,9 @@
### GNU Compiler
```
- # Ubuntu / Debian
+ # Ubuntu
sudo apt install libmicrohttpd-dev libssl-dev cmake build-essential libhwloc-dev
- git clone https://github.com/fireice-uk/xmr-stak.git
- mkdir xmr-stak/build
- cd xmr-stak/build
- cmake ..
- make install
-
- # Arch
- sudo pacman -S --needed base-devel hwloc openssl cmake libmicrohttpd
- git clone https://github.com/fireice-uk/xmr-stak.git
- mkdir xmr-stak/build
- cd xmr-stak/build
- cmake ..
- make install
-
- # Fedora
- sudo dnf install gcc gcc-c++ hwloc-devel libmicrohttpd-devel libstdc++-static make openssl-devel cmake
+ #install IBM developer tools or compile gcc 6.3.x yourself
git clone https://github.com/fireice-uk/xmr-stak.git
mkdir xmr-stak/build
cd xmr-stak/build
@@ -42,62 +27,20 @@
# CentOS
sudo yum install centos-release-scl epel-release
- sudo yum install cmake3 devtoolset-4-gcc* hwloc-devel libmicrohttpd-devel openssl-devel make
- scl enable devtoolset-4 bash
+ sudo yum install cmake3 hwloc-devel libmicrohttpd-devel openssl-devel make
+ #install IBM developer tools or compile gcc 6.3.x yourself
git clone https://github.com/fireice-uk/xmr-stak.git
mkdir xmr-stak/build
cd xmr-stak/build
cmake3 ..
make install
- # Ubuntu 14.04
- sudo add-apt-repository ppa:ubuntu-toolchain-r/test
- sudo apt update
- sudo apt install gcc-5 g++-5 make
- sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-5 1 --slave /usr/bin/g++ g++ /usr/bin/g++-5
- curl -L http://www.cmake.org/files/v3.4/cmake-3.4.1.tar.gz | tar -xvzf - -C /tmp/
- cd /tmp/cmake-3.4.1/ && ./configure && make && sudo make install && cd -
- sudo update-alternatives --install /usr/bin/cmake cmake /usr/local/bin/cmake 1 --force
- sudo apt install libmicrohttpd-dev libssl-dev libhwloc-dev
- git clone https://github.com/fireice-uk/xmr-stak.git
- mkdir xmr-stak/build
- cd xmr-stak/build
- cmake ..
- make install
-
- # TinyCore Linux 8.x
- # TinyCore is 32-bit only, but there is an x86-64 port, known as "Pure 64,"
- # hosted on the TinyCore home page, and it works well.
- # Beware that huge page support is not enabled in the kernel distributed
- # with Pure 64. Consider http://wiki.tinycorelinux.net/wiki:custom_kernel
- # Note that as of yet there are no distro packages for microhttpd or hwloc.
- # hwloc is easy enough to install manually though, shown below.
- # Also note that only CPU mining has been tested on this platform, thus the
- # disabling of CUDA and OpenCL shown below.
- tce-load -iw openssl-dev.tcz cmake.tcz make.tcz gcc.tcz git.tcz \
- glibc_base-dev.tcz linux-4.8.1_api_headers.tcz \
- glibc_add_lib.tcz
- wget https://www.open-mpi.org/software/hwloc/v1.11/downloads/hwloc-1.11.8.tar.gz
- tar xzvf hwloc-1.11.8.tar.gz
- cd hwloc-1.11.8
- ./configure --prefix=/usr/local
- make
- sudo make install
- cd ..
- git clone http://github.com/fireice-uk/xmr-stak
- cd xmr-stak
- mkdir build
- cd build
- CC=gcc cmake .. -DCUDA_ENABLE=OFF \
- -DOpenCL_ENABLE=OFF \
- -DMICROHTTPD_ENABLE=OFF
- make install
```
-- g++ version 5.1 or higher is required for full C++11 support.
+- IBM g++ version 6.3 or higher is required for full Altivec and C++11 support.
If you want to compile the binary without installing libraries / compiler or just compile binary for some other distribution, please check the [build_xmr-stak_docker.sh script](scripts/build_xmr-stak_docker/build_xmr-stak_docker.sh).
-### To do a generic and static build for a system without gcc 5.1+
+### To do a generic and static build for a system without gcc 6.3+
```
cmake -DCMAKE_LINK_STATIC=ON -DXMR-STAK_COMPILE=generic .
make install
diff --git a/doc/tuning.md b/doc/tuning.md
index 47ad0bb..3f5dbfe 100644
--- a/doc/tuning.md
+++ b/doc/tuning.md
@@ -21,11 +21,6 @@ To benchmark the miner speed there are two ways.
- Mine against a pool end press the key `h` after 30 sec to see the hash report.
- Start the miner with the cli option `--benchmark BLOCKVERSION`. The miner will not connect to any pool and performs a 60sec performance benchmark with all enabled back-ends.
-## Windows
-"Run As Administrator" prompt (UAC) confirmation is needed to use large pages on Windows 7.
-On Windows 10 it is only needed once to set up the account to use them.
-Disable the dialog with the command line option `--noUAC`
-
## NVIDIA Backend
By default the NVIDIA backend can be tuned in the config file `nvidia.txt`
diff --git a/doc/usage.md b/doc/usage.md
index 1f1fb09..6a1008d 100644
--- a/doc/usage.md
+++ b/doc/usage.md
@@ -2,7 +2,6 @@
## Content Overview
* [Configuration](#configuration)
-* [Usage on Windows](#usage-on-windows)
* [Usage on Linux](#usage-on-linux)
* [Command Line Options](#command-line-options)
* [HTML and JSON API report configuraton](#html-and-json-api-report-configuraton)
@@ -16,15 +15,7 @@ The number of files depends on the available backends.
`pools.txt` contains the selected mining pools and currency to mine.
`amd.txt`, `cpu.txt` and `nvidia.txt` contains miner backend specific settings and can be used for further tuning ([Tuning Guide](tuning.md)).
-
-## Usage on Windows
-1) Double click the `xmr-stak.exe` file
-2) Fill in the pool url settings, currency, username and password
-
-`set XMRSTAK_NOWAIT=1` disable the dialog `Press any key to exit.` for non UAC execution.
-
-
-## Usage on Linux & macOS
+## Usage on Linux
1) Open a terminal within the folder with the binary
2) Start the miner with `./xmr-stak`
OpenPOWER on IntegriCloud