diff options
author | psychocrypt <psychocrypt@users.noreply.github.com> | 2017-11-30 22:46:00 +0100 |
---|---|---|
committer | psychocrypt <psychocrypt@users.noreply.github.com> | 2017-12-06 22:21:48 +0100 |
commit | 7ca6f6e2e9bd5f7a68c878a60a296af1a3636c6f (patch) | |
tree | 3e6762e99bbedd8f6cb0a3d7a919af27451038ca /doc | |
parent | 47a4d031bcc3159a298afaae6797cd19240ad0a1 (diff) | |
download | xmr-stak-7ca6f6e2e9bd5f7a68c878a60a296af1a3636c6f.zip xmr-stak-7ca6f6e2e9bd5f7a68c878a60a296af1a3636c6f.tar.gz |
allow to diable UAC dialog
- remove CMake option `WIN_UAC`
- spawn UAC dialog via restarting xmr-miner with administrator right
- allow to disable UAC with `--noUAC`
- update documentation
- remove usage section with help message (output depends on OS)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/compile.md | 5 | ||||
-rw-r--r-- | doc/tuning.md | 6 | ||||
-rw-r--r-- | doc/usage.md | 22 |
3 files changed, 7 insertions, 26 deletions
diff --git a/doc/compile.md b/doc/compile.md index 4fa940f..e97affa 100644 --- a/doc/compile.md +++ b/doc/compile.md @@ -52,11 +52,6 @@ After the configuration you need to compile the miner, follow the guide for your - 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 -### only available for Windows -- `WIN_UAC` will enable or disable the "Run As Administrator" prompt on Windows. - - 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. - ## CPU Build Options - `CPU_ENABLE` allow to disable/enable the CPU backend of the miner diff --git a/doc/tuning.md b/doc/tuning.md index 8eeefcb..8b28a43 100644 --- a/doc/tuning.md +++ b/doc/tuning.md @@ -1,6 +1,7 @@ # Tuning Guide ## Content Overview +* [Windows](windows) * [NVIDIA Backend](#nvidia-backend) * [Choose Value for `threads` and `blocks`](#choose-value-for-threads-and-blocks) * [Add more GPUs](#add-more-gpus) @@ -10,6 +11,11 @@ * [Increase Memory Pool](#increase-memory-pool) * [Scratchpad Indexing](#scratchpad-indexing) +## 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 edd5c89..a0421ac 100644 --- a/doc/usage.md +++ b/doc/usage.md @@ -30,27 +30,7 @@ The number of files depends on the available backends. ## Command Line Options The miner allow to overwrite some of the settings via command line options. - -``` -Usage: xmr-stak [OPTION]... - - -h, --help show this help - -v, --version show version number - -V, --version-long show long version number - -c, --config FILE common miner configuration file - --currency NAME currency to mine: monero or aeon - --noCPU disable the CPU miner backend - --cpu FILE CPU backend miner config file - --noAMD disable the AMD miner backend - --amd FILE AMD backend miner config file - --noNVIDIA disable the NVIDIA miner backend - --nvidia FILE NVIDIA backend miner config file - -The Following options temporary overwrites the config file settings: - -o, --url URL pool url and port, e.g. pool.usxmrpool.com:3333 - -u, --user USERNAME pool user name or wallet address - -p, --pass PASSWD pool password, in the most cases x or empty "" -``` +Run `xmr-stak --help` to show all available command line options. ## Docker image usage |