Document the command line options
This commit is contained in:
parent
06abdc858e
commit
caeb0503a5
66
README
66
README
@ -106,3 +106,69 @@ communicate with each other and a web server so these will not be documented.
|
||||
|
||||
---
|
||||
RUNNING:
|
||||
|
||||
ckpool supports the following options:
|
||||
|
||||
-A | --standalone
|
||||
-c CONFIG | --config CONFIG
|
||||
-d CKDB-NAME | --ckdb-name CKDB-NAME
|
||||
-g GROUP | --group GROUP
|
||||
-H | --handover
|
||||
-h | --help
|
||||
-k | --killold
|
||||
-L | --log-shares
|
||||
-l LOGLEVEL | --loglevel LOGLEVEL
|
||||
-n NAME | --name NAME
|
||||
-P | --passthrough
|
||||
-p | --proxy
|
||||
-S CKDB-SOCKDIR | --ckdb-sockdir CKDB-SOCKDIR
|
||||
-s SOCKDIR | --sockdir SOCKDIR
|
||||
|
||||
|
||||
-A Standalone mode tells ckpool not to try to communicate with ckdb or log any
|
||||
ckdb requests in the rotating ckdb logs it would otherwise store. All users
|
||||
are automatically accepted without any attempt to authorise users in any way.
|
||||
|
||||
-c <CONFIG> tells ckpool to override its default configuration filename and
|
||||
load the specified one. If -c is not specified, ckpool looks for ckpool.conf
|
||||
whereas in proxy or passthrough modes it will look for ckproxy.conf
|
||||
|
||||
-d <CKDB-NAME> tells ckpool what the name of the ckdb process is that it should
|
||||
speak to, otherwise it will look for ckdb.
|
||||
|
||||
-g <GROUP> will start ckpool as the group ID specified.
|
||||
|
||||
-H will make ckpool attempt to receive a handover from a running incidence of
|
||||
ckpool with the same name, taking its client listening socket and shutting it
|
||||
down.
|
||||
|
||||
-h displays the above help
|
||||
|
||||
-k will make ckpool shut down an existing instance of ckpool with the same name,
|
||||
killing it if need be. Otherwise ckpool will refuse to start if an instance of
|
||||
the same name is already running.
|
||||
|
||||
-L will log per share information in the logs directory divided by block height
|
||||
and then workbase.
|
||||
|
||||
-l <LOGLEVEL will change the log level to that specified. Default is 5 and
|
||||
maximum debug is level 7.
|
||||
|
||||
-n <NAME> will change the ckpool process name to that specified, allowing
|
||||
multiple different named instances to be running.
|
||||
|
||||
-P will start ckpool in passthrough proxy mode where it collates all incoming
|
||||
connections and streams all information on a single connection to an upstream
|
||||
pool specified in ckproxy.conf . Downstream users all retain their individual
|
||||
presence on the master pool. Standalone mode is implied.
|
||||
|
||||
-p will start ckpool in proxy mode where it appears to be a local pool handling
|
||||
clients as separate entities while presenting shares as a single user to the
|
||||
upstream pool specified. Note that the upstream pool needs to be a ckpool for
|
||||
it to scale to large hashrates. Standalone mode is Optional.
|
||||
|
||||
-S <CKDB-SOCKDIR> tells ckpool which directory to look for the ckdb socket to
|
||||
talk to.
|
||||
|
||||
-s <SOCKDIR> tells ckpool which directory to place its own communication
|
||||
sockets (/tmp by default)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user