No Description

Con Kolivas 2acc2a29f2 More README updates. 12 years ago
bitstreams 6cd7f0f1be Remove unmaintained broken ztex driver. 12 years ago
ccan 1ceeb3b76c Remove prebuild ccan/opt dependencies 12 years ago
compat 4f7b6fe4c3 Avoid entering static libusb directory if --with-system-libusb is enabled. 12 years ago
lib c9ae715019 Compile CPU mining for win32 and win64 13 years ago
m4 8ec2dcc9b9 Mingw suseconds_t and sigaction fixes. 14 years ago
.gitignore c38a225ad8 ignore file that is generated on Macs 12 years ago
01-cgminer.rules 176cae2700 Add basic definitions for hashfast device recognition. 12 years ago
API-README cac7cdb25e api add device elapsed since hotplug devices Elapsed is less than cgminer Elapsed 12 years ago
API.class 00be617ce1 API.java allow partial reads 13 years ago
API.java fe802b62ae basic copyright statement in API.java 12 years ago
ASIC-README f792b1be97 Configure source for a new BaB driver 12 years ago
AUTHORS d94b4f882f Update AUTHORS file. 12 years ago
COPYING d1cddf8bad Update licensing to GPL V3. 14 years ago
ChangeLog f44dd607e9 ChangeLog refer to NEWS 13 years ago
FPGA-README a6e44cb360 ICA optional limit timing with short=N or long=N 12 years ago
LICENSE d1cddf8bad Update licensing to GPL V3. 14 years ago
MCast.class c0f4e47675 Compile MCast.java with an old java 12 years ago
MCast.java 20f4356129 API Multicast sample MCast.java+MCast.class 12 years ago
Makefile.am 28137c8e10 Merge branch 'master' into nogpu 12 years ago
NEWS 829f0687bf Bump version to 3.7.2 12 years ago
README 2acc2a29f2 More README updates. 12 years ago
api-example.c 824fd8fcad Fix the api-example.c compile under Linux 12 years ago
api-example.php aacf1e55d9 JSON reply to JSON request 14 years ago
api-example.py 1f3c642564 Change mode on python file. 12 years ago
api.c 0a0ce3b888 api.c remove all GPU/gpu references and correct code as required 12 years ago
arg-nonnull.h 3320c627f0 Added previously missing gnulib files. 14 years ago
autogen.sh 539f2c35d0 Work around older libtoolize that fails without top ltmain.sh not being present during autogen 12 years ago
bench_block.h 92af1925a6 Remove benchmark data from main.c 14 years ago
bitforce-firmware-flash.c 6bf04bc969 Remove compile errors/warnings and document compile/usage in FPGA-README 13 years ago
c++defs.h 3320c627f0 Added previously missing gnulib files. 14 years ago
cgminer.c 28137c8e10 Merge branch 'master' into nogpu 12 years ago
compat.h 564fd36c8e Use cgtime in compat.h 12 years ago
configure.ac b58d1b375e Reorder configure alphabetically for devices to compile and fail if no support is selected to be compiled in. 12 years ago
driver-avalon.c 569973275a Unlock the avalon qlock while sending tasks to not hold the lock for an extended period. 12 years ago
driver-avalon.h 74f3f9d681 Sleep in avalon send task on return to the function to allow other code to work during the sleep period. 12 years ago
driver-bab.c 385d2f9efa BaB update/format some comments 12 years ago
driver-bflsc.c 8fb7a0d1be Always use a usb read buffer instead of having to explicitly enable it. 12 years ago
driver-bflsc.h dfa849ab62 bflsc use getinfo chip parallelization if it is present 12 years ago
driver-bitforce.c 2b621b6bc1 Remove GPU mining code. 12 years ago
driver-bitfury.c 0b64d438ef Fine tune the reading of results in bitfury driver to not lose any across work restarts or corrupt due to store results not parsed during restart. 12 years ago
driver-bitfury.h 0b64d438ef Fine tune the reading of results in bitfury driver to not lose any across work restarts or corrupt due to store results not parsed during restart. 12 years ago
driver-hashfast.c 53451bfbf3 Update style. 12 years ago
driver-hashfast.h 53451bfbf3 Update style. 12 years ago
driver-icarus.c 2b621b6bc1 Remove GPU mining code. 12 years ago
driver-klondike.c 0124217db8 Fixed a math issue when reporting fan speed on the status line. 12 years ago
driver-knc-spi-fpga.c b542f5235b Add copyright notice to knc driver. 12 years ago
driver-modminer.c 2b621b6bc1 Remove GPU mining code. 12 years ago
elist.h c9ae715019 Compile CPU mining for win32 and win64 13 years ago
example.conf c01284fb07 Remove short options -r and -R to allow them to be reused and remove readme entries for deprecated options. 13 years ago
fpgautils.c 6ca0eaa987 fix windows log warnings 12 years ago
fpgautils.h 71bae003bc First draft of port of avalon driver to new cgminer queued infrastructure. 13 years ago
hexdump.c 71bae003bc First draft of port of avalon driver to new cgminer queued infrastructure. 13 years ago
hf_protocol.h d6e9a5ac18 Change SEQUENCE_DISTANCE() macro to HF_SEQUENCE_DISTANCE() 12 years ago
hf_protocol_be.h 065054f658 Structure changes for OP_NONCE, add big endian header 12 years ago
linux-usb-cgminer b2e15e493e Include HDD install details and related changes 14 years ago
logging.c 8e9f32a81b Add a forcelog variant of applog which invalidates any console lock to force output. 12 years ago
logging.h 8e9f32a81b Add a forcelog variant of applog which invalidates any console lock to force output. 12 years ago
miner.h 28137c8e10 Merge branch 'master' into nogpu 12 years ago
miner.php 9932c95569 miner.php correct sort gen field names largest to smallest 12 years ago
mknsis.sh a7518360ad Windows build tweaks. 15 years ago
sha2.c 77a2ad219f sha2 allow external access to some macros and the K array 12 years ago
sha2.h 77a2ad219f sha2 allow external access to some macros and the K array 12 years ago
usbtest.py 288f5e3b43 simple serial-USB python test script 12 years ago
usbutils.c 4e7b7f6f18 Send a zero length packet at the end of every usb transfer on windows in case libusb internally has batched them into one maxpacket sized. 12 years ago
usbutils.h 2e11a50484 Remove now unused entries from struct cg_usb_device 12 years ago
uthash.h b764862128 Update uthash to latest. 12 years ago
util.c 5d7c99f389 Revert "Return ETIMEDOUT regardless if we fail in cgsem_mswait since we may be waiting on it on shutdown and the return response is harmless." 12 years ago
util.h 669bcac36c Merge branch 'master' into hashfast 12 years ago
warn-on-use.h 3320c627f0 Added previously missing gnulib files. 14 years ago
windows-build.txt 503c527ad7 Updated links to AMD APP SDK 13 years ago

README

This is a multi-threaded multi-pool FPGA and ASIC miner for bitcoin.

This code is provided entirely free of charge by the programmer in his spare
time so donations would be greatly appreciated. Please consider donating to the
address below.

Con Kolivas
15qSxP1SQcUX3o4nhkfdbgyoWEFMomJ4rZ

DOWNLOADS:

http://ck.kolivas.org/apps/cgminer

GIT TREE:

https://github.com/ckolivas/cgminer

Support thread:

http://bitcointalk.org/index.php?topic=28402.0

IRC Channel:

irc://irc.freenode.net/cgminer

License: GPLv3. See COPYING for details.

SEE ALSO API-README, ASIC-README and FGPA-README FOR MORE INFORMATION ON EACH.

---

EXECUTIVE SUMMARY ON USAGE:

Single pool:

cgminer -o http://pool:port -u username -p password

Multiple pools:

cgminer -o http://pool1:port -u pool1username -p pool1password -o http://pool2:port -u pool2usernmae -p pool2password

Single pool with a standard http proxy:

cgminer -o "http:proxy:port|http://pool:port" -u username -p password

Single pool with a socks5 proxy:

cgminer -o "socks5:proxy:port|http://pool:port" -u username -p password

Single pool with stratum protocol support:

cgminer -o stratum+tcp://pool:port -u username -p password

The list of proxy types are:
http: standard http 1.1 proxy
http0: http 1.0 proxy
socks4: socks4 proxy
socks5: socks5 proxy
socks4a: socks4a proxy
socks5h: socks5 proxy using a hostname

If you compile cgminer with a version of CURL before 7.19.4 then some of the above will
not be available. All are available since CURL version 7.19.4

If you specify the --socks-proxy option to cgminer, it will only be applied to all pools
that don't specify their own proxy setting like above


After saving configuration from the menu, you do not need to give cgminer any
arguments and it will load your configuration.

Any configuration file may also contain a single
"include" : "filename"
to recursively include another configuration file.
Writing the configuration will save all settings from all files in the output.


---
BUILDING CGMINER FOR YOURSELF

DEPENDENCIES:
Mandatory:
pkg-config http://www.freedesktop.org/wiki/Software/pkg-config
libtool http://www.gnu.org/software/libtool/
Optional:
curl dev library http://curl.haxx.se/libcurl/
(libcurl4-openssl-dev - Must tell configure --disable-libcurl otherwise
it will attempt to compile it in)

curses dev library
(libncurses5-dev or libpdcurses on WIN32 for text user interface)

libudev dev library (libudev-dev)
(This is only required for USB device support and is linux only)

If building from git:
autoconf
automake

If building on Red Hat:
sudo yum install autoconf automake autoreconf libtool openssl-compat-bitcoin-devel.x86_64 \
curl libcurl libcurl-devel openssh

CGMiner specific configuration options:
--enable-avalon Compile support for Avalon (default disabled)
--enable-bflsc Compile support for BFL ASICs (default disabled)
--enable-bitforce Compile support for BitForce FPGAs (default
disabled)
--enable-bitfury Compile support for BitFury ASICs (default disabled)
--enable-hashfast Compile support for Hashfast (default disabled)
--enable-icarus Compile support for Icarus (default disabled)
--enable-knc Compile support for KnC miners (default disabled)
--enable-bab Compile support for BlackArrow Bitfury (default disabled)
--enable-klondike Compile support for Klondike (default disabled)
--enable-modminer Compile support for ModMiner FPGAs(default disabled)
--without-curses Compile support for curses TUI (default enabled)
--with-system-libusb Compile against dynamic system libusb (default use
included static libusb)

Basic *nix build instructions:
To actually build:

./autogen.sh # only needed if building from git repo
CFLAGS="-O2 -Wall -march=native" ./configure
make

No installation is necessary. You may run cgminer from the build
directory directly, but you may do make install if you wish to install
cgminer to a system location or location you specified.

Native WIN32 build instructions: see windows-build.txt

---

Usage instructions: Run "cgminer --help" to see options:

Usage: cgminer [-DdElmpPQqUsTouOchnV]

Options for both config file and command line:
--api-allow Allow API access (if enabled) only to the given list of [W:]IP[/Prefix] address[/subnets]
This overrides --api-network and you must specify 127.0.0.1 if it is required
W: in front of the IP address gives that address privileged access to all api commands
--api-description Description placed in the API status header (default: cgminer version)
--api-groups API one letter groups G:cmd:cmd[,P:cmd:*...]
See API-README for usage
--api-listen Listen for API requests (default: disabled)
By default any command that does not just display data returns access denied
See --api-allow to overcome this
--api-network Allow API (if enabled) to listen on/for any address (default: only 127.0.0.1)
--api-mcast Enable API Multicast listener, (default: disabled)
The listener will only run if the API is also enabled
--api-mcast-addr API Multicast listen address, (default: 224.0.0.75)
--api-mcast-code Code expected in the API Multicast message, don't use '-' (default: "FTW")
--api-mcast-port API Multicast listen port, (default: 4028)
--api-port Port number of miner API (default: 4028)
--balance Change multipool strategy from failover to even share balance
--benchmark Run cgminer in benchmark mode - produces no shares
--compact Use compact display without per device statistics
--debug|-D Enable debug output
--device|-d Select device to use, one value, range and/or comma separated (e.g. 0-2,4) default: all
--disable-rejecting Automatically disable pools that continually reject shares
--expiry|-E Upper bound on how many seconds after getting work we consider a share from it stale (default: 120)
--failover-only Don't leak work to backup pools when primary pool is lagging
--fix-protocol Do not redirect to a different getwork protocol (eg. stratum)
--hotplug Set hotplug check time to seconds (0=never default: 5) - only with libusb
--kernel-path|-K Specify a path to where bitstream files are (default: "/usr/local/bin")
--load-balance Change multipool strategy from failover to quota based balance
--log|-l Interval in seconds between log output (default: 5)
--lowmem Minimise caching of shares for low memory applications
--monitor|-m Use custom pipe cmd for output messages
--net-delay Impose small delays in networking to not overload slow routers
--no-submit-stale Don't submit shares if they are detected as stale
--pass|-p Password for bitcoin JSON-RPC server
--per-device-stats Force verbose mode and output per-device statistics
--protocol-dump|-P Verbose dump of protocol-level activities
--queue|-Q Minimum number of work items to have queued (0 - 10) (default: 1)
--quiet|-q Disable logging output, display status and errors
--real-quiet Disable all output
--remove-disabled Remove disabled devices entirely, as if they didn't exist
--rotate Change multipool strategy from failover to regularly rotate at N minutes (default: 0)
--round-robin Change multipool strategy from failover to round robin on failure
--scan-time|-s Upper bound on time spent scanning current work, in seconds (default: 60)
--sched-start Set a time of day in HH:MM to start mining (a once off without a stop time)
--sched-stop Set a time of day in HH:MM to stop mining (will quit without a start time)
--sharelog Append share log to file
--shares Quit after mining N shares (default: unlimited)
--socks-proxy Set socks4 proxy (host:port) for all pools without a proxy specified
--syslog Use system log for output messages (default: standard error)
--temp-cutoff Temperature where a device will be automatically disabled, one value or comma separated list (default: 95)
--text-only|-T Disable ncurses formatted screen output
--url|-o URL for bitcoin JSON-RPC server
--user|-u Username for bitcoin JSON-RPC server
--verbose Log verbose output to stderr as well as status output
--userpass|-O Username:Password pair for bitcoin JSON-RPC server
Options for command line only:
--config|-c Load a JSON-format configuration file
See example.conf for an example configuration.
--help|-h Print this message
--version|-V Display version and exit


USB device (ASIC and FPGA) options:

--icarus-options Set specific FPGA board configurations - one set of values for all or comma separated
--icarus-timing Set how the Icarus timing is calculated - one setting/value for all or comma separated
--usb USB device selection (See below)
--usb-dump (See FPGA-README)

See FGPA-README or ASIC-README for more information regarding these.


ASIC only options:

--avalon-auto Adjust avalon overclock frequency dynamically for best hashrate
--avalon-fan Set fanspeed percentage for avalon, single value or range (default: 20-100)
--avalon-freq Set frequency range for avalon-auto, single value or range
--avalon-cutoff Set avalon overheat cut off temperature (default: 60)
--avalon-options Set avalon options baud:miners:asic:timeout:freq
--avalon-temp Set avalon target temperature (default: 50)
--bflsc-overheat Set overheat temperature where BFLSC devices throttle, 0 to disable (default: 90)
--bitburner-fury-options Override avalon-options for BitBurner Fury boards baud:miners:asic:timeout:freq
--bitburner-fury-voltage Set BitBurner Fury core voltage, in millivolts
--bitburner-voltage Set BitBurner (Avalon) core voltage, in millivolts
--klondike-options Set klondike options clock:temptarget

See ASIC-README for more information regarding these.


FPGA only options:

--bfl-range Use nonce range on bitforce devices if supported

See FGPA-README for more information regarding this.


Cgminer should automatically find all of your Avalon ASIC, BFL ASIC, BitForce
FPGAs, Icarus bitstream FPGAs, Klondike ASIC, ASICMINER usb block erupters,
KnC ASICs, BaB ASICs, Hashfast ASICs and ModMiner FPGAs.

---

SETTING UP USB DEVICES

WINDOWS:

On windows, the direct USB support requires the installation of a WinUSB
driver (NOT the ftdi_sio driver), and attach it to your devices.
The easiest way to do this is to use the zadig utility which will install the
drivers for you and then once you plug in your device you can choose the
"list all devices" from the "option" menu and you should be able to see the
device as something like: "BitFORCE SHA256 SC". Choose the install or replace
driver option and select WinUSB. You can either google for zadig or download
it from the cgminer directory in the DOWNLOADS link above.

LINUX:

On linux, the direct USB support requires no drivers at all. However due to
permissions issues, you may not be able to mine directly on the devices as a
regular user without giving the user access to the device or by mining as
root (administrator). In order to give your regular user access, you can make
him a member of the plugdev group with the following commands:

sudo usermod -G plugdev -a `whoami`

If your distribution does not have the plugdev group you can create it with:

sudo groupadd plugdev

In order for the BFL devices to instantly be owned by the plugdev group and
accessible by anyone from the plugdev group you can copy the file
"01-cgminer.rules" from the cgminer archive into the /etc/udev/rules.d
directory with the following command:

sudo cp 01-cgminer.rules /etc/udev/rules.d/

After this you can either manually restart udev and re-login, or more easily
just reboot.

Advanced USB options:

The --usb option can restrict how many Avalon, BFL ASIC, BitForce FPGAs,
Klondike ASIC, ModMiner FPGAs or Icarus bitstream FPGAs it finds:

--usb 1:2,1:3,1:4,1:*
or
--usb BAS:1,BFL:1,MMQ:0,ICA:0,KLN:0
or
--usb :10

You can only use one of the above 3

The first version
--usb 1:2,1:3,1:4,1:*
allows you to select which devices to mine on with a list of USB
bus_number:device_address
All other USB devices will be ignored
Hotplug will also only look at the devices matching the list specified and
find nothing new if they are all in use
You can specify just the USB bus_number to find all devices like 1:*
which means any devices on USB bus_number 1
This is useful if you unplug a device then plug it back in the same port,
it usually reappears with the same bus_number but a different device_address

You can see the list of all USB devices on linux with 'sudo lsusb'
Cgminer will list the recognised USB devices with the '-n' option or the
'--usb-dump 0' option
The '--usb-dump N' option with a value of N greater than 0 will dump a lot
of details about each recognised USB device
If you wish to see all USB devices, include the --usb-list-all option

The second version
--usb BAS:1,BFL:1,MMQ:0,ICA:0,KLN:0
allows you to specify how many devices to choose based on each device
driver cgminer has - there are currently 5 USB drivers: BAS, BFL, MMQ.
ICA & KLN
N.B. you can only specify which device driver to limit, not the type of
each device, e.g. with BAS:n you can limit how many BFL ASIC devices will
be checked, but you cannot limit the number of each type of BFL ASIC
Also note that the MMQ count is the number of MMQ backplanes you have
not the number of MMQ FPGAs

The third version
--usb :10
means only use a maximum of 10 devices of any supported USB devices
Once cgminer has 10 devices it will not configure any more and hotplug will
not scan for any more
If one of the 10 devices stops working, hotplug - if enabled, as is default
- will scan normally again until it has 10 devices

--usb :0 will disable all USB I/O other than to initialise libusb

NOTE: The --device option will limit which devices are in use based on their
numbering order of the total devices, so if you hotplug USB devices regularly,
it will not reliably be the same devices.

---

WHILE RUNNING:

The following options are available while running with a single keypress:

[P]ool management [S]ettings [D]isplay options [Q]uit

P gives you:

Current pool management strategy: Failover
[F]ailover only disabled
[A]dd pool [R]emove pool [D]isable pool [E]nable pool
[C]hange management strategy [S]witch pool [I]nformation


S gives you:

[Q]ueue: 1
[S]cantime: 60
[E]xpiry: 120
[W]rite config file
[C]gminer restart


D gives you:

[N]ormal [C]lear [S]ilent mode (disable all output)
[D]ebug:off
[P]er-device:off
[Q]uiet:off
[V]erbose:off
[R]PC debug:off
[W]orkTime details:off
co[M]pact: off
[L]og interval:5


Q quits the application.


The running log shows output like this:

[2013-11-09 11:04:41] Accepted 01b3bde7 Diff 150/128 AVA 1 pool 0
[2013-11-09 11:04:49] Accepted 015df995 Diff 187/128 AVA 1 pool 0
[2013-11-09 11:04:50] Accepted 01163b68 Diff 236/128 AVA 1 pool 0
[2013-11-09 11:04:53] Accepted 9f745840 Diff 411/128 BAS 1 pool 0

The 8 byte hex value are the 1st nonzero bytes of the share being submitted to
the pool. The 2 diff values are the actual difficulty target that share reached
followed by the difficulty target the pool is currently asking for.

---
Also many issues and FAQs are covered in the forum thread
dedicated to this program,
http://forum.bitcoin.org/index.php?topic=28402.0

The output line shows the following:
(5s):1713.6 (avg):1707.8 Mh/s | A:729 R:8 HW:0 WU:22.53/m

Each column is as follows:
5s: A 5 second exponentially decaying average hash rate
avg: An all time average hash rate
A: The total difficulty of Accepted shares
R: The total difficulty of Rejected shares
HW: The number of HardWare errors
WU: The Work Utility defined as the number of diff1 shares work / minute
(accepted or rejected).

BAS 1: max 67C 3.27V | 62.29G/62.19Gh/s | A:140813 R:256 HW:2860 WU: 852.0/m

Each column is as follows:
Temperature (if supported)
Fanspeed (if supported)
A 5 second exponentially decaying average hash rate
An all time average hash rate
The total difficulty of accepted shares
The total difficulty of rejected shares
The number of hardware erorrs
The work utility defined as the number of diff1 shares work / minute

The cgminer status line shows:
ST: 1 SS: 0 NB: 1 LW: 8 GF: 1 RF: 1

ST is STaged work items (ready to use).
SS is Stale Shares discarded (detected and not submitted so don't count as rejects)
NB is New Blocks detected on the network
LW is Locally generated Work items
GF is Getwork Fail Occasions (server slow to provide work)
RF is Remote Fail occasions (server slow to accept work)

The block display shows:
Block: 0074c5e482e34a506d2a051a... Started: [17:17:22] Best share: 2.71K

This shows a short stretch of the current block, when the new block started,
and the all time best difficulty share you've found since starting cgminer
this time.


---
MULTIPOOL

FAILOVER STRATEGIES WITH MULTIPOOL:
A number of different strategies for dealing with multipool setups are
available. Each has their advantages and disadvantages so multiple strategies
are available by user choice, as per the following list:

FAILOVER:
The default strategy is failover. This means that if you input a number of
pools, it will try to use them as a priority list, moving away from the 1st
to the 2nd, 2nd to 3rd and so on. If any of the earlier pools recover, it will
move back to the higher priority ones.

ROUND ROBIN:
This strategy only moves from one pool to the next when the current one falls
idle and makes no attempt to move otherwise.

ROTATE:
This strategy moves at user-defined intervals from one active pool to the next,
skipping pools that are idle.

LOAD BALANCE:
This strategy sends work to all the pools on a quota basis. By default, all
pools are allocated equal quotas unless specified with --quota. This
apportioning of work is based on work handed out, not shares returned so is
independent of difficulty targets or rejected shares. While a pool is disabled
or dead, its quota is dropped until it is re-enabled. Quotas are forward
looking, so if the quota is changed on the fly, it only affects future work.
If all pools are set to zero quota or all pools with quota are dead, it will
fall back to a failover mode. See quota below for more information.

The failover-only flag has special meaning in combination with load-balance
mode and it will distribute quota back to priority pool 0 from any pools that
are unable to provide work for any reason so as to maintain quota ratios
between the rest of the pools.

BALANCE:
This strategy monitors the amount of difficulty 1 shares solved for each pool
and uses it to try to end up doing the same amount of work for all pools.


---
QUOTAS

The load-balance multipool strategy works off a quota based scheduler. The
quotas handed out by default are equal, but the user is allowed to specify any
arbitrary ratio of quotas. For example, if all the quota values add up to 100,
each quota value will be a percentage, but if 2 pools are specified and pool0
is given a quota of 1 and pool1 is given a quota of 9, pool0 will get 10% of
the work and pool1 will get 90%. Quotas can be changed on the fly by the API,
and do not act retrospectively. Setting a quota to zero will effectively
disable that pool unless all other pools are disabled or dead. In that
scenario, load-balance falls back to regular failover priority-based strategy.
While a pool is dead, it loses its quota and no attempt is made to catch up
when it comes back to life.

To specify quotas on the command line, pools should be specified with a
semicolon separated --quota(or -U) entry instead of --url. Pools specified with
--url are given a nominal quota value of 1 and entries can be mixed.

For example:
--url poola:porta -u usernamea -p passa --quota "2;poolb:portb" -u usernameb -p passb
Will give poola 1/3 of the work and poolb 2/3 of the work.

Writing configuration files with quotas is likewise supported. To use the above
quotas in a configuration file they would be specified thus:

"pools" : [
{
"url" : "poola:porta",
"user" : "usernamea",
"pass" : "passa"
},
{
"quota" : "2;poolb:portb",
"user" : "usernameb",
"pass" : "passb"
}
]


---
LOGGING

cgminer will log to stderr if it detects stderr is being redirected to a file.
To enable logging simply add 2>logfile.txt to your command line and logfile.txt
will contain the logged output at the log level you specify (normal, verbose,
debug etc.)

In other words if you would normally use:
./cgminer -o xxx -u yyy -p zzz
if you use
./cgminer -o xxx -u yyy -p zzz 2>logfile.txt
it will log to a file called logfile.txt and otherwise work the same.

There is also the -m option on linux which will spawn a command of your choice
and pipe the output directly to that command.

The WorkTime details 'debug' option adds details on the end of each line
displayed for Accepted or Rejected work done. An example would be:

<-00000059.ed4834a3 M:X D:1.0 G:17:02:38:0.405 C:1.855 (2.995) W:3.440 (0.000) S:0.461 R:17:02:47

The first 2 hex codes are the previous block hash, the rest are reported in
seconds unless stated otherwise:
The previous hash is followed by the getwork mode used M:X where X is one of
P:Pool, T:Test Pool, L:LP or B:Benchmark,
then D:d.ddd is the difficulty required to get a share from the work,
then G:hh:mm:ss:n.nnn, which is when the getwork or LP was sent to the pool and
the n.nnn is how long it took to reply,
followed by 'O' on it's own if it is an original getwork, or 'C:n.nnn' if it was
a clone with n.nnn stating how long after the work was recieved that it was cloned,
(m.mmm) is how long from when the original work was received until work started,
W:n.nnn is how long the work took to process until it was ready to submit,
(m.mmm) is how long from ready to submit to actually doing the submit, this is
usually 0.000 unless there was a problem with submitting the work,
S:n.nnn is how long it took to submit the completed work and await the reply,
R:hh:mm:ss is the actual time the work submit reply was received

If you start cgminer with the --sharelog option, you can get detailed
information for each share found. The argument to the option may be "-" for
standard output (not advisable with the ncurses UI), any valid positive number
for that file descriptor, or a filename.

To log share data to a file named "share.log", you can use either:
./cgminer --sharelog 50 -o xxx -u yyy -p zzz 50>share.log
./cgminer --sharelog share.log -o xxx -u yyy -p zzz

For every share found, data will be logged in a CSV (Comma Separated Value)
format:
timestamp,disposition,target,pool,dev,thr,sharehash,sharedata
For example (this is wrapped, but it's all on one line for real):
1335313090,reject,
ffffffffffffffffffffffffffffffffffffffffffffffffffffffff00000000,
http://localhost:8337,GPU0,0,
6f983c918f3299b58febf95ec4d0c7094ed634bc13754553ec34fc3800000000,
00000001a0980aff4ce4a96d53f4b89a2d5f0e765c978640fe24372a000001c5
000000004a4366808f81d44f26df3d69d7dc4b3473385930462d9ab707b50498
f681634a4f1f63d01a0cd43fb338000000000080000000000000000000000000
0000000000000000000000000000000000000000000000000000000080020000

---

RPC API

For RPC API details see the API-README file

---

FAQ

Q: Can I mine on servers from different networks (eg xxxcoin and bitcoin) at
the same time?
A: No, cgminer 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 networks would
make it invalidate the work from each other.

Q: Can I configure cgminer to mine with different login credentials or pools
for each separate device?
A: No.

Q: Can I put multiple pools in the config file?
A: Yes, check the example.conf file. Alternatively, set up everything either on
the command line or via the menu after startup and choose settings->write
config file and the file will be loaded one each startup.

Q: The build fails with gcc is unable to build a binary.
A: Remove the "-march=native" component of your CFLAGS as your version 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 get
their feature requests implemented.

Q: Work keeps going to my backup pool even though my primary pool hasn't
failed?
A: Cgminer checks for conditions where the primary pool is lagging and 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 devices working on something
useful and not risk idle periods. You can disable this behaviour with the
option --failover-only.

Q: Is this a virus?
A: Cgminer is being packaged with other trojan scripts and some antivirus
software is falsely accusing cgminer.exe as being the actual virus, rather
than whatever it is being packaged with. If you installed cgminer yourself,
then you do not have a virus on your computer. Complain to your antivirus
software company. They seem to be flagging even source code now from cgminer
as viruses, even though text source files can't do anything by themself.

Q: 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 yet another
output mode?
A: Everyone will always have their own view of what's important to monitor.
The defaults are very sane and I have very little interest in changing this
any further.

Q: What are the best parameters to pass for X pool/hardware/device.
A: Virtually always, the DEFAULT parameters give the best results. Most user
defined settings lead to worse performance.

Q: What happened to CPU and GPU mining?
A: Their efficiency makes them irrelevant in the bitcoin mining world today
and the author has no interest in supporting alternative coins that are better
mined by these devices.

Q: GUI version?
A: No. The RPC interface makes it possible for someone else to write one
though.

Q: I'm having an issue. What debugging information should I provide?
A: Start cgminer with your regular commands and add -D -T --verbose and provide
the full startup output and a summary of your hardware and operating system.

Q: Why don't you provide win64 builds?
A: Win32 builds work everywhere and there is precisely zero advantage to a
64 bit build on windows.

Q: Is it faster to mine on windows or linux?
A: It makes no difference in terms of performance. It comes down to choice of
operating system for their various features and your comfort level. However
linux is the primary development platform and is virtually guaranteed to be
more stable.

Q: My network gets slower and slower and then dies for a minute?
A; Try the --net-delay option if you are on a getwork or GBT server.

Q: How do I tune for p2pool?
A: It is also recommended to use --failover-only since the work is effectively
like a different block chain, and not enabling --no-submit-stale. If mining with
a BFL (fpga) minirig, it is worth adding the --bfl-range option.

Q: I run PHP on windows to access the API with the example miner.php. Why does
it fail when php is installed properly but I only get errors about Sockets not
working in the logs?
A: http://us.php.net/manual/en/sockets.installation.php

Q: What is a PGA?
A: At the moment, cgminer supports 3 FPGAs: BitForce, Icarus and ModMiner.
They are Field-Programmable Gate Arrays that have been programmed to do Bitcoin
mining. Since the acronym needs to be only 3 characters, the "Field-" part has
been skipped.

Q: What is an ASIC?
A: They are Application Specify Integrated Circuit devices and provide the
highest performance per unit power due to being dedicated to only one purpose.

Q: Can I mine scrypt with FPGAs or ASICs?
A: No.

Q: What is stratum and how do I use it?
A: Stratum is a protocol designed for pooled mining in such a way as to
minimise the amount of network communications, yet scale to hardware of any
speed. With versions of cgminer 2.8.0+, if a pool has stratum support, cgminer
will automatically detect it and switch to the support as advertised if it can.
If you input the stratum port directly into your configuration, or use the
special prefix "stratum+tcp://" instead of "http://", cgminer will ONLY try to
use stratum protocol mining. The advantages of stratum to the miner are no
delays in getting more work for the miner, less rejects across block changes,
and far less network communications for the same amount of mining hashrate. If
you do NOT wish cgminer to automatically switch to stratum protocol even if it
is 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?
A: 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 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 single difficulty shares found.
However, the number is actually random and converges over time, it is an average,
not an exact value, thus you may find more or less than the expected average.

Q: My keyboard input momentarily pauses or repeats keys every so often on
windows while mining?
A: The USB implementation on windows can be very flaky on some hardware and
every time cgminer looks for new hardware to hotplug it it can cause these
sorts of problems. You can disable hotplug with:
--hotplug 0

Q: What should my Work Utility (WU) be?
A: Work utility is the product of hashrate * luck and only stabilises over a
very long period of time. Assuming all your work is valid work, bitcoin mining
should produce a work utility of approximately 1 per 71.6MH. This means at
5GH you should have a WU of 5000 / 71.6 or ~ 69. You cannot make your machine
do "better WU" than this - it is luck related. However you can make it much
worse if your machine produces a lot of hardware errors producing invalid work.


---

This code is provided entirely free of charge by the programmer in his spare
time so donations would be greatly appreciated. Please consider donating to the
address below.

Con Kolivas
15qSxP1SQcUX3o4nhkfdbgyoWEFMomJ4rZ