Browse Source

Update configuration.md

Updated information about `includes` and `hamsi-short`.
djm34
ystarnaud 10 years ago
parent
commit
16361a6f8e
  1. 39
      doc/configuration.md

39
doc/configuration.md

@ -7,7 +7,7 @@
* [Configuration Settings Order](#configuration-settings-order) * [Configuration Settings Order](#configuration-settings-order)
* [Globals and the Default Profile](#globals-and-the-default-profile) * [Globals and the Default Profile](#globals-and-the-default-profile)
* [Working with Profiles and Pool Specific Settings](#working-with-profiles-and-pool-specific-settings) * [Working with Profiles and Pool Specific Settings](#working-with-profiles-and-pool-specific-settings)
* [Includes](#includes) * [Include and Includes](#include-and-includes)
* [CLI Only options](#cli-only-options) * [CLI Only options](#cli-only-options)
* [Config-file and CLI options](#config-file-and-cli-options) * [Config-file and CLI options](#config-file-and-cli-options)
@ -173,11 +173,13 @@ The end result of the above would look like this:
[Top](#configuration-and-command-line-options) [Top](#configuration-and-command-line-options)
## Includes ## Include and Includes
`Include` is a special keyword only available in the configuration file. You can include json-formatted files at any level of the configuration parsing. The values read in the included `include` and `includes` are special keywords only available in the configuration file. You can include json-formatted files at any level of the configuration parsing. The values read in the included
files are applied to the current object being parsed. files are applied to the current object being parsed.
`include` is used to include one single file. If you want to include multiple files, use `includes`, which is an array of filenames.
``` ```
/etc/pool.ip.credentials: /etc/pool.ip.credentials:
{ {
@ -211,6 +213,18 @@ sgminer.conf:
... ...
``` ```
The example below shows how you could breakdown your config across multiple smaller files:
```
sgminer.conf:
"includes":[
"/etc/pools.conf",
"/etc/profiles.conf",
"/etc/gpus.conf"
],
...
```
There is no limit as to how includes can be used as long as they follow proper json syntax. There is no limit as to how includes can be used as long as they follow proper json syntax.
[Top](#configuration-and-command-line-options) [Top](#configuration-and-command-line-options)
@ -349,6 +363,7 @@ sgminer 4.2.1-116-g2e8b-dirty
* [lookup-gap](#lookup-gap) * [lookup-gap](#lookup-gap)
* [nfactor](#nfactor) * [nfactor](#nfactor)
* [hamsi-expand-big](#hamsi-expand-big) * [hamsi-expand-big](#hamsi-expand-big)
* [hamsi-short](#hamsi-short)
* [shaders](#shaders) * [shaders](#shaders)
* [thread-concurrency](#thread-concurrency) * [thread-concurrency](#thread-concurrency)
* [worksize](#worksize) * [worksize](#worksize)
@ -722,7 +737,7 @@ Overrides the default scrypt parameter N, specified as the factor of 2 (`N = 2^n
### hamsi-expand-big ### hamsi-expand-big
Sets SPH_HAMSI_EXPAND_BIG for X13 algorithms. Values `"4"` and `"1"` are commonly used. Changing this may improve hashrate. Which value is better depends on GPU type and even manufacturer (i.e. exact GPU model). Sets SPH_HAMSI_EXPAND_BIG for X13 derived algorithms. Values `"4"` and `"1"` are commonly used. Changing this may improve hashrate. Which value is better depends on GPU type and even manufacturer (i.e. exact GPU model).
*Available*: Global *Available*: Global
@ -736,6 +751,22 @@ Sets SPH_HAMSI_EXPAND_BIG for X13 algorithms. Values `"4"` and `"1"` are commonl
[Top](#configuration-and-command-line-options) :: [Config-file and CLI options](#config-file-and-cli-options) :: [Algorithm Options](#algorithm-options) [Top](#configuration-and-command-line-options) :: [Config-file and CLI options](#config-file-and-cli-options) :: [Algorithm Options](#algorithm-options)
### hamsi-short
Sets SPH_HAMSI_SHORT for X13 derived algorithms. Changing this may improve hashrate. Which value is better depends on GPU type and even manufacturer (i.e. exact GPU model).
*Available*: Global
*Config File Syntax:* `"hamsi-short":true`
*Command Line Syntax:* `--hamsi-short`
*Argument:* None
*Default:* `false`
[Top](#configuration-and-command-line-options) :: [Config-file and CLI options](#config-file-and-cli-options) :: [Algorithm Options](#algorithm-options)
### shaders ### shaders
Number of shaders per GPU for algorithm tuning. Number of shaders per GPU for algorithm tuning.

Loading…
Cancel
Save