GOSTSec
/
sgminer
mirror of https://github.com/GOSTSec/sgminer
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

doc: FAQ formatting (allows linking to specific questions). 

Squashed: removed duplicate question, fix typo.
nfactor-troky
Noel Maersk 11 years ago
parent
806b23627b
commit
be4305e4f6
1 changed files with 132 additions and 79 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 211
      doc/FAQ.md

211
doc/FAQ.md
Unescape View File

@ -1,23 +1,27 @@
# FAQ # FAQ
Q: Why don't you provide binaries? ## Why don't you provide binaries?
A: Binaries are a hassle to maintain. On Linux, they should be provided
by your distribution's package manager anyway. Runnning an unoptimised Binaries are a hassle to maintain. On Linux, they should be provided
by your distribution's package manager anyway. Running an unoptimised
binary gives a minor performance penalty. Running binaries from binary gives a minor performance penalty. Running binaries from
untrusted providers is a security risk. There has not been sufficient untrusted providers is a security risk. There has not been sufficient
community interest to provide distributed determininstic builds. community interest to provide distributed determininstic builds.
Q: It would be nice to have step-by-step installation instructions for
Linux. ## It would be nice to have step-by-step installation instructions for Linux.
A: These instructions cannot be specific enough, since it depends a lot
These instructions cannot be specific enough, since it depends a lot
on the GNU/Linux distribution you're using. It should be handled by the on the GNU/Linux distribution you're using. It should be handled by the
package manager anyway. Otherwise, such instructions will constantly package manager anyway. Otherwise, such instructions will constantly
be out-of-date. AMD does not allow redistribution of their SDKs' be out-of-date. AMD does not allow redistribution of their SDKs'
source code, so providing packages can be difficult for some GNU/Linux source code, so providing packages can be difficult for some GNU/Linux
distributions. distributions.
Q: Why is the network difficulty wrong?
A: It is not wrong. Sharediff of 1 (historically) corresponds to a ## Why is the network difficulty wrong?
It is not wrong. Sharediff of 1 (historically) corresponds to a
network difficulty of 1/65536. Throughout the inteface, share difficulty network difficulty of 1/65536. Throughout the inteface, share difficulty
is displayed as whole numbers, not fractionals. Pools use the same is displayed as whole numbers, not fractionals. Pools use the same
convention (with the notable exception of P2Pool). Until pools start convention (with the notable exception of P2Pool). Until pools start
@ -25,124 +29,172 @@ using true network difficulty to display share difficulty, there is no
reason to display difficulty differently. This is a vicious cycle and a reason to display difficulty differently. This is a vicious cycle and a
remnant of Bitcoin mining on GPUs. remnant of Bitcoin mining on GPUs.
Q: Will sgminer support FPGAs or ASICs?
A: No. sgminer will only support GPUs. It is bad software design ## Will sgminer support FPGAs or ASICs?
No. sgminer will only support GPUs. It is bad software design
practice to try and support every gadget out there. Developers practice to try and support every gadget out there. Developers
for dedicated hardware products are better off creating standalone for dedicated hardware products are better off creating standalone
software. software.
Q: Will there be scrypt-jane/Keccak/SHA-3 support?
A: Perhaps eventually, if it can be implemented without code bloat.
Q: Can you modify the display to include more of one thing in the output ## Will there be scrypt-jane/Keccak/SHA-3 support?
Perhaps eventually, if it can be implemented without code bloat.
## Can you modify the display...
...to include more of one thing in the output
and less of another, or can you change the quiet mode or can you add and less of another, or can you change the quiet mode or can you add
yet another output mode? yet another output mode?
A: Everyone will always have their own view of what's important to
monitor. The shipped NCurses TUI is intentionally ascetic, and is only Probably not. Everyone will always have their own view of what's
provided as a fallback. It is recomended to use an API client if you important to monitor. The shipped NCurses TUI is intentionally ascetic,
want to customise the display. and is only provided as a fallback. It is recomended to use an API
client if you want to customise the display.
Q: Can I mine on servers from different networks (eg litecoin and
dogecoin) at the same time?
A: No. `sgminer` keeps a database of the block it's working on to ensure ## Can I mine on servers from different networks...
...(e.g. litecoin and dogecoin) at the same time?
No. `sgminer` keeps a database of the block it's working on to ensure
it does not work on stale blocks, and having different blocks from two it does not work on stale blocks, and having different blocks from two
networks would make it invalidate the work from each other. networks would make it invalidate the work from each other.
Q: Can I configure sgminer to mine with different login credentials or
pools for each separate device?
A: No. Run separate instances with `-d`.
Q: Can I put multiple pools in the config file? ## Can I mine with different login credentials or pools for each separate device?
A: Yes, check the `example.conf` file. Alternatively, set up everything
No. Run separate instances with `-d`.
## Can I put multiple pools in the config file?
Yes, check the `example.conf` file. Alternatively, set up everything
either on the command line or via the menu after startup and choose either on the command line or via the menu after startup and choose
`Settings -> Write config file`. `Settings -> Write config file`.
Q: The build fails with `gcc is unable to build a binary`.
A: Remove the "-march=native" component of your `CFLAGS` as your version ## The build fails with `gcc is unable to build a binary`.
Remove the "-march=native" component of your `CFLAGS` as your version
of gcc does not support it. of gcc does not support it.
Q: Can you implement feature X?
A: I can, but time is limited, and people who donate are more likely to ## Can you implement feature X?
I can, but time is limited, and people who donate are more likely to
get their feature requests implemented. get their feature requests implemented.
Q: Work keeps going to my backup pool even though my primary pool
hasn't failed? ## Work keeps going to my backup pool...
A: sgminer checks for conditions where the primary pool is lagging and
...even though my primary pool hasn't failed!
`sgminer` checks for conditions where the primary pool is lagging and
will pass some work to the backup servers under those conditions. The will pass some work to the backup servers under those conditions. The
reason for doing this is to try its absolute best to keep the GPUs reason for doing this is to try its absolute best to keep the GPUs
working on something useful and not risk idle periods. You can disable working on something useful and not risk idle periods. You can disable
this behaviour with the option --failover-only. this behaviour with the option --failover-only.
Q: Is this a virus?
A: sgminer is being packaged with other trojan
scripts and some antivirus software is falsely accusing sgminer.exe as
being the actual virus, rather than whatever it is being packaged with.
If you had built sgminer yourself, then you do not have a virus on your
computer. Complain to your antivirus software company..
Q: GUI version? ## Is this a virus?
A: No. The API makes it possible for someone else to write one though.
`sgminer` may be packaged with other trojan scripts and some antivirus
software is falsely accusing sgminer.exe as being the actual virus,
rather than whatever it is being packaged with. If you had built sgminer
yourself, then you do not have a virus on your computer. Complain to
your antivirus software company..
## GUI version?
No. The API makes it possible for someone else to write one though.
Q: What are the best parameters to pass for pool / hardware / device?
A: See `doc/MINING.md` in your source distribution directory, or ## What are the best parameters to pass for pool / hardware / device?
See `doc/MINING.md` in your source distribution directory, or
[doc/MINING.md](https://github.com/veox/sgminer/blob/master/doc/MINING.md] [doc/MINING.md](https://github.com/veox/sgminer/blob/master/doc/MINING.md]
for an online version. Note that the latter is for the latest for an online version. Note that the latter is for the latest
development version, and arguments listed there are not necessarily development version, and arguments listed there are not necessarily
available in your local version. available in your local version.
Q: Is CPU mining supported?
A: No. Consider using [cpuminer](https://github.com/pooler/cpuminer).
Q: I'm having an issue. What debugging information should I provide in ## Is CPU mining supported?
the bug report?
A: See `doc/BUGS.md` in your source distribution directory, or No. Consider using [cpuminer](https://github.com/pooler/cpuminer).
## I'm having an issue. What should I provide in the bug report?
See `doc/BUGS.md` in your source distribution directory, or
[doc/BUGS.md](https://github.com/veox/sgminer/blob/master/doc/BUGS.md) [doc/BUGS.md](https://github.com/veox/sgminer/blob/master/doc/BUGS.md)
for an online version. for an online version.
Q: Is it better to mine on Linux or Windows?
A: It comes down to choice of operating system for their various ## Is it better to mine on Linux or Windows?
It comes down to choice of operating system for their various
features. Linux offers specialised mining distributions, much better features. Linux offers specialised mining distributions, much better
long term stability, remote monitoring and security, while Windows long term stability, remote monitoring and security, while Windows
offers overclocking tools that can achieve much more than sgminer can do offers overclocking tools that can achieve much more than sgminer can do
on Linux. YMMV. on Linux. YMMV.
Q: Can I mine with sgminer on a Mac?
A: sgminer will compile on OSX, but the performance of GPU mining ## Can I mine with sgminer on a Mac?
`sgminer` will compile on OSX, but the performance of GPU mining
is compromised due to the OpenCL implementation on OSX, there is no is compromised due to the OpenCL implementation on OSX, there is no
temperature or fanspeed monitoring, and the cooling design will usually temperature or fanspeed monitoring, and the cooling design will usually
not cope with constant usage leading to a high risk of thermal damage. not cope with constant usage leading to a high risk of thermal damage.
It is highly recommended not to mine on a Mac. It is highly recommended not to mine on a Mac.
Q: I switch users on Windows and my mining stops working?
A: That's correct, it does. It's a permissions issue that there is no ## I switch users on Windows and my mining stops working?
That's correct, it does. It's a permissions issue that there is no
known fix for due to monitoring of GPU fanspeeds and temperatures. If known fix for due to monitoring of GPU fanspeeds and temperatures. If
you disable the monitoring with `--no-adl` it should switch okay. you disable the monitoring with `--no-adl` it should switch okay.
Q: My network gets slower and slower and then dies for a minute?
A: Try the `--net-delay` option.
Q: How do I tune for P2Pool? ## My network gets slower and slower and then dies for a minute?
A: P2Pool has very rapid expiration of work and new blocks, it is
Try the `--net-delay` option.
## How do I tune for P2Pool?
P2Pool has very rapid expiration of work and new blocks, it is
suggested you decrease intensity, decrease `scantime` and `expiry`, suggested you decrease intensity, decrease `scantime` and `expiry`,
and/or decrease GPU threads to 1 with `-g 1`. It is also recommended to and/or decrease GPU threads to 1 with `-g 1`. It is also recommended to
use `--failover-only` since the work is effectively a separate use `--failover-only` since the work is effectively a separate
blockchain. blockchain.
Q: Are OpenCL kernels from other mining software usable in sgminer?
A: Most often no.
Q: How do I add my own kernel? ## Are OpenCL kernels from other mining software usable in sgminer?
A: See `doc/KERNEL.md` in your source distribution directory, or
Most often no.
## How do I add my own kernel?
See `doc/KERNEL.md` in your source distribution directory, or
[doc/KERNEL.md](https://github.com/veox/sgminer/blob/master/doc/KERNEL.md) [doc/KERNEL.md](https://github.com/veox/sgminer/blob/master/doc/KERNEL.md)
for an online version. for an online version.
Q: I run PHP on Windows to access the API with the example
## I run PHP on Windows to access the API with the example
`miner.php`. Why does it fail when PHP is installed properly but `miner.php`. Why does it fail when PHP is installed properly but
I only get errors about Sockets not working in the logs? I only get errors about Sockets not working in the logs?
A: See [this](http://us.php.net/manual/en/sockets.installation.php). See [this](http://us.php.net/manual/en/sockets.installation.php).
Q: What is stratum and how do I use it? ## What is stratum and how do I use it?
A: Stratum is a protocol designed for pooled mining in such a way as to
Stratum is a protocol designed for pooled mining in such a way as to
minimise the amount of network communications, yet scale to hardware minimise the amount of network communications, yet scale to hardware
of any speed. If a pool has stratum support (and most public ones do), of any speed. If a pool has stratum support (and most public ones do),
sgminer will automatically detect it and switch to the support as sgminer will automatically detect it and switch to the support as
@ -155,9 +207,13 @@ communications for the same amount of mining hashrate. If you do not
wish sgminer to automatically switch to stratum protocol even if it is wish sgminer to automatically switch to stratum protocol even if it is
detected, add the `--fix-protocol` option. detected, add the `--fix-protocol` option.
Q: Why don't the statistics add up: Accepted, Rejected, Stale, Hardware
Errors, Diff1 Work, etc. when mining greater than 1 difficulty shares? ## Why don't the statistics add up?..
A: As an example, if you look at 'Difficulty Accepted' in the RPC API,
...Accepted, Rejected, Stale, Hardware Errors, Diff1 Work, etc. when
mining greater than 1 difficulty shares?
As an example, if you look at 'Difficulty Accepted' in the RPC API,
the number of difficulty shares accepted does not usually exactly equal the number of difficulty shares accepted does not usually exactly equal
the amount of work done to find them. If you are mining at 8 difficulty, the amount of work done to find them. If you are mining at 8 difficulty,
then you would expect on average to find one 8 difficulty share, per 8 then you would expect on average to find one 8 difficulty share, per 8
@ -165,18 +221,15 @@ single difficulty shares found. However, the number is actually random
and converges over time, it is an average, not an exact value, thus you and converges over time, it is an average, not an exact value, thus you
may find more or less than the expected average. may find more or less than the expected average.
Q: Why do the scrypt diffs not match with the current difficulty target?
A: The current scrypt block difficulty is expressed in terms of how
many multiples of the BTC difficulty it currently is (eg 28) whereas
the shares of "difficulty 1" are actually 65536 times smaller than the
BTC ones. The diff expressed by sgminer is as multiples of difficulty 1
shares.
Q: Can I make a donation? ## Can I make a donation?
A: Yes, see AUTHORS.md for authors' donation addresses.
Yes, see AUTHORS.md for authors' donation addresses.
## What is Work Utility (WU)?
Q: What is Work Utility (WU)? Work utility is the product of hashrate * luck and only stabilises
A: Work utility is the product of hashrate * luck and only stabilises
over a very long period of time. Luck includes hardware error rate, over a very long period of time. Luck includes hardware error rate,
share reject rate and other parameters. Therefore, it is often a better share reject rate and other parameters. Therefore, it is often a better
indicator of hardware or software misconfiguration. indicator of hardware or software misconfiguration.

Write Preview
Loading…
Cancel
Save