sgminer/doc/configuration.md

# Configuration and command-line options

*Work in progress!*


## Config-file and CLI options

### algorithm

Allows choosing between the few mining algorithms for incompatible
cryptocurrencies.

Requires a string.

Currently supported:

* `adaptive-nfactor` - Vertcoin-style adaptive N-factor scrypt.
N-factor defaults to 11.
* everything else - Litecoin-style static N-factor scrypt.


### nfactor

Overrides the default N-factor scrypt parameter.

Requires an unsigned integer.
config: add `--algorithm` option and documentation. Doc in `doc/configuration.md` (has to be started sometime, no?). Configuration function has to be lamely-named set_algo(), because set_algorithm() is already declared in algorithm.h (prevent namespace conflict). algorithm has to be added as global variable due to the way the callback is done (by CCAN/opt, which in itself is nice). This can be cleaned up significantly by (at least) introducing a global configuration struct, but there is no reason to do it now just for this - better a wholesale manana. 2014-03-06 19:59:51 +00:00			`# Configuration and command-line options`

			`Work in progress!`


			`## Config-file and CLI options`

			`### algorithm`

			`Allows choosing between the few mining algorithms for incompatible`
			`cryptocurrencies.`

			`Requires a string.`

			`Currently supported:`

			* `adaptive-nfactor` - Vertcoin-style adaptive N-factor scrypt.
			`N-factor defaults to 11.`
			`* everything else - Litecoin-style static N-factor scrypt.`


			`### nfactor`

			`Overrides the default N-factor scrypt parameter.`

			`Requires an unsigned integer.`