Ecosystem/xmrig
Ecosystem/xmrig
1
0
Fork 0
mirror of https://github.com/xmrig/xmrig.git synced 2024-11-17 08:17:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add comments to config file.

Browse source
This commit is contained in:
XMRig 2017-10-07 00:49:38 +03:00
parent fc810dc87b
commit 1123c20da0
2 changed files with 52 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
src/Options.cpp
View file

@ -55,36 +55,39 @@ Options *Options::m_self = nullptr;
static char const usage[] = "\ static char const usage[] = "\
Usage: " APP_ID " [OPTIONS]\n\ Usage: " APP_ID " [OPTIONS]\n\
Options:\n\ Options:\n\
-a, --algo=ALGO cryptonight (default) or cryptonight-lite\n\ -a, --algo=ALGO cryptonight (default) or cryptonight-lite\n\
-o, --url=URL URL of mining server\n\ -o, --url=URL URL of mining server\n\
-O, --userpass=U:P username:password pair for mining server\n\ -O, --userpass=U:P username:password pair for mining server\n\
-u, --user=USERNAME username for mining server\n\ -u, --user=USERNAME username for mining server\n\
-p, --pass=PASSWORD password for mining server\n\ -p, --pass=PASSWORD password for mining server\n\
-t, --threads=N number of miner threads\n\ -t, --threads=N number of miner threads\n\
-v, --av=N algorithm variation, 0 auto select\n\ -v, --av=N algorithm variation, 0 auto select\n\
-k, --keepalive send keepalived for prevent timeout (need pool support)\n\ -k, --keepalive send keepalived for prevent timeout (need pool support)\n\
-r, --retries=N number of times to retry before switch to backup server (default: 5)\n\ -r, --retries=N number of times to retry before switch to backup server (default: 5)\n\
-R, --retry-pause=N time to pause between retries (default: 5)\n\ -R, --retry-pause=N time to pause between retries (default: 5)\n\
--cpu-affinity set process affinity to CPU core(s), mask 0x3 for cores 0 and 1\n\ --cpu-affinity set process affinity to CPU core(s), mask 0x3 for cores 0 and 1\n\
--cpu-priority set process priority (0 idle, 2 normal to 5 highest)\n\ --cpu-priority set process priority (0 idle, 2 normal to 5 highest)\n\
--no-huge-pages disable huge pages support\n\ --no-huge-pages disable huge pages support\n\
--no-color disable colored output\n\ --no-color disable colored output\n\
--donate-level=N donate level, default 5%% (5 minutes in 100 minutes)\n\ --donate-level=N donate level, default 5%% (5 minutes in 100 minutes)\n\
--user-agent set custom user-agent string for pool\n\ --user-agent set custom user-agent string for pool\n\
-B, --background run the miner in the background\n\ -B, --background run the miner in the background\n\
-c, --config=FILE load a JSON-format configuration file\n\ -c, --config=FILE load a JSON-format configuration file\n\
-l, --log-file=FILE log all output to a file\n" -l, --log-file=FILE log all output to a file\n"
# ifdef HAVE_SYSLOG_H # ifdef HAVE_SYSLOG_H
"\ "\
-S, --syslog use system log for output messages\n" -S, --syslog use system log for output messages\n"
# endif # endif
"\ "\
--max-cpu-usage=N maximum CPU usage for automatic threads mode (default 75)\n\ --max-cpu-usage=N maximum CPU usage for automatic threads mode (default 75)\n\
--safe safe adjust threads and av settings for current CPU\n\ --safe safe adjust threads and av settings for current CPU\n\
--nicehash enable nicehash support\n\ --nicehash enable nicehash/xmrig-proxy support\n\
--print-time=N print hashrate report every N seconds\n\ --print-time=N print hashrate report every N seconds\n\
-h, --help display this help and exit\n\ --api-port=N port for the miner API\n\
-V, --version output version information and exit\n\ --api-access-token=T access token for API\n\
--api-worker-id=ID custom worker-id for API\n\
-h, --help display this help and exit\n\
-V, --version output version information and exit\n\
"; ";

46
src/config.json
View file

@ -1,31 +1,31 @@
{ {
"algo": "cryptonight", "algo": "cryptonight", // cryptonight (default) or cryptonight-lite
"av": 0, "av": 0, // algorithm variation, 0 auto select
"background": false, "background": false, // true to run the miner in the background
"colors": true, "colors": true, // false to disable colored output
"cpu-affinity": null, "cpu-affinity": null, // set process affinity to CPU core(s), mask "0x3" for cores 0 and 1
"cpu-priority": null, "cpu-priority": null, // set process priority (0 idle, 2 normal to 5 highest)
"donate-level": 5, "donate-level": 5, // donate level, mininum 1%
"log-file": null, "log-file": null, // log all output to a file, example: "c:/some/path/xmrig.log"
"max-cpu-usage": 75, "max-cpu-usage": 75, // maximum CPU usage for automatic mode, usually limiting factor is CPU cache not this option.
"print-time": 60, "print-time": 60, // print hashrate report every N seconds
"retries": 5, "retries": 5, // number of times to retry before switch to backup server
"retry-pause": 5, "retry-pause": 5, // time to pause between retries
"safe": false, "safe": false, // true to safe adjust threads and av settings for current CPU
"syslog": false, "syslog": false, // use system log for output messages
"threads": null, "threads": null, // number of miner threads
"pools": [ "pools": [
{ {
"url": "pool.minemonero.pro:5555", "url": "pool.minemonero.pro:5555", // URL of mining server
"user": "", "user": "", // username for mining server
"pass": "x", "pass": "x", // password for mining server
"keepalive": true, "keepalive": true, // send keepalived for prevent timeout (need pool support)
"nicehash": false "nicehash": false // enable nicehash/xmrig-proxy support
} }
], ],
"api": { "api": {
"port": 0, "port": 0, // port for the miner API https://github.com/xmrig/xmrig/wiki/API
"access-token": null, "access-token": null, // access token for API
"worker-id": null "worker-id": null // custom worker-id for API
} }
} }