GOSTSec/sgminer
1
0
Fork 0
mirror of https://github.com/GOSTSec/sgminer synced 2025-02-08 04:54:29 +00:00
Code Issues Releases Wiki Activity

doc: update README.md with "state" option.

Browse Source 
Closes https://github.com/veox/sgminer/issues/44
This commit is contained in:
Noel Maersk 2014-01-27 18:17:14 +02:00
parent d3a3ee6b31
commit a65ff54b08
1 changed files with 27 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -334,11 +334,12 @@ the above quotas in a configuration file they would be specified thus:
} }
] ]
### Extra File Configuration ### Extra File Configuration
If you want to store a number of pools in your configuration file, but don't always If you want to store a number of pools in your configuration file, but
want them automatically enabled at start up (or restart), then the new "disable-pool" don't always want them automatically enabled at start up (or restart),
option can be used: then the "state" option with a value of "disabled" can be used:
"pools" : [ "pools" : [
{ {
@ -350,40 +351,47 @@ option can be used:
"quota" : "2;poolb:portb", "quota" : "2;poolb:portb",
"user" : "usernameb", "user" : "usernameb",
"pass" : "passb", "pass" : "passb",
"disable-pool" : "1" "state" : "disabled"
} }
] ]
It is then trivial to change the "disable-pool" setting to "0" in the configuration file It is then trivial to change the "state" setting to "enabled" in the
at anytime and then restart the miner ('s' followed by 'c'). Or, you can enable the pool configuration file at anytime and then restart the miner (see below).
whilst the miner is still running ('p' followed by 'e' followed by pool number) - but the You can enable the pool whilst the miner is still running ('p' followed
pool be still be disabled on restart if the config file is not changed. This option is by 'e' followed by pool number) - but the pool will still be disabled on
NOT created when the 'Write config file' option is used ('s' followed by 'w'). restart if the config file is not changed.
In a similar manner, a 'remove-pool' option is also available. This can be mix and matched "state" can also be set to "hidden". This allows the json file to
with the 'disable-pool' option. Using 'remove-pool' enables the json file to contain a contain a large number of pools, of which some could be automatically
large number of pools, of which some could be automatically culled at start up. culled at start up. This makes it easy to swap pools in and out of the
This makes it easy to swap pools in and out of the runtime selection, without having a runtime selection, without having a large list of pools cluttering up
large list of pools cluttering up the disaply. A 'restart' of the miner ('s' followed by 'c') the display.
will reload the config file and any changes the may have been made.
"pools" : [ "pools" : [
{ {
"poolname" : "Main Pool", "poolname" : "Main Pool",
"url" : "poola:porta", "url" : "poola:porta",
"user" : "usernamea", "user" : "usernamea",
"pass" : "passa", "pass" : "passa",
"disable-pool" : "0" "state" : "disabled"
}, },
{ {
"poolname" : "Joe's Weekend Pool" "poolname" : "Joe's Weekend Pool",
"quota" : "2;poolb:portb", "quota" : "2;poolb:portb",
"user" : "usernameb", "user" : "usernameb",
"pass" : "passb", "pass" : "passb",
"remove-pool" : "1" "state" : "hidden"
} }
] ]
These options are considered experimental and therefore will NOT be
created when the 'Write config file' option is used ('s' followed by
'w').
A restart of the miner ('s' followed by 'c') will reload the config
file and any changes that may have been made.
## Logging ## Logging
sgminer will log to stderr if it detects stderr is being redirected to a sgminer will log to stderr if it detects stderr is being redirected to a