bfgminer(1) multi-threaded multi-pool ASIC, FPGA, GPU and CPU bitcoin miner.




multi-threaded multi-pool ASIC, FPGA, GPU and CPU bitcoin miner.
Lowlevel: ftdi pci pci:uio pci:vfio spi usb vcom

Drivers: antminer avalon bfx bifury bigpic bitforce bitforce:pci bitfury_gpio cairnsmore drillbit dualminer erupter gridseed hashbusteravalon hashbusterusb hashfast icarus klondike littlefury modminer opencl opencl:adl opencl:sensors proxy proxy:getwork proxy:stratum rockminer twinfury x6500 ztex

Algorithms: SHA256d scrypt

Options: ncursesw5


Options for both config file and command line:

--api-allow <arg>
Allow API access only to the given list of [G:]IP[/Prefix] addresses[/subnets]
--api-description <arg>
Description placed in the API status header, default: BFGMiner version
--api-groups <arg>
API one letter groups G:cmd:cmd[,P:cmd:*...] defining the cmds a groups can use
Enable API, default: disabled
Enable API Multicast listener, default: disabled
--api-mcast-addr <arg>
API Multicast listen address (default: "")
--api-mcast-code <arg>
Code expected in the API Multicast message, don't use '-' (default: "FTW")
--api-mcast-des <arg>
Description appended to the API Multicast reply, default: ''
--api-mcast-port <arg>
API Multicast listen port (default: 4028)
Allow API (if enabled) to listen on/for any address, default: only
--api-port <arg>
Port number of miner API (default: 4028)
Change multipool strategy from failover to even share balance
Run BFGMiner in benchmark mode - produces no shares
Use nonce range on bitforce devices if supported
--chroot-dir <arg>
Chroot to a directory right after startup
--cmd-idle <arg>
Execute a command when a device is allowed to be idle (rest or wait)
--cmd-sick <arg>
Execute a command when a device is declared sick
--cmd-dead <arg>
Execute a command when a device is declared dead
--coinbase-addr <arg>
Set coinbase payout address for solo mining
--coinbase-sig <arg>
Set coinbase signature when possible
Use compact display without per device statistics
Enable debug output
Enable debug logging
Verbose dump of device protocol-level activities
--device|-d <arg>
Enable only devices matching pattern (default: all)
Automatically disable pools that continually reject shares
--http-port <arg>
Port number to listen on for HTTP getwork miners (-1 means disabled) (default: -1)
--expiry|-E <arg>
Upper bound on how many seconds after getting work we consider a share from it stale (w/o longpoll active) (default: 120)
--expiry-lp <arg>
Upper bound on how many seconds after getting work we consider a share from it stale (with longpoll active) (default: 3600)
Don't leak work to backup pools when primary pool is lagging
--failover-switch-delay <arg>
Delay in seconds before switching back to a failed pool (default: 300)
Always initialize devices when possible (such as bitstream uploads to some FPGAs)
--gpu-platform <arg>
Select OpenCL platform ID to use for GPU mining (default: -1)
--gpu-map <arg>
Map OpenCL to ADL device order manually, paired CSV (e.g. 1:0,2:1 maps OpenCL 1 to ADL 0, 2 to 1)
Attempt to reorder GPU devices according to PCI Bus ID
--kernel-path <arg>
Specify a path to where bitstream and kernel files are (default: "/usr/share/bfgminer")
--klondike-options <arg>
Set klondike options clock:temptarget
Change multipool strategy from failover to quota based balance
--log|-l <arg>
Interval in seconds between log output (default: 20)
--log-file|-L <arg>
Append log file for output messages
Include microseconds in log output
--monitor|-m <arg>
Use custom pipe cmd for output messages
Impose small delays in networking to avoid overloading slow routers
Disable the ATI display library used for monitoring and setting GPU parameters
Disable getblocktemplate support
Disable getwork support
Disable hotplug detection
Disable X-Long-Polling support
Ignore pool requests to redirect to another server
Do not attempt to restart devices that hang
Disable Stratum detection
Don't submit shares if they are detected as stale
Don't use Unicode characters in TUI
--noncelog <arg>
Create log of all nonces found
--pass|-p <arg>
Password for bitcoin JSON-RPC server
Force verbose mode and output per-device statistics
--pool-priority <arg>
Priority for just the previous-defined pool
--pool-proxy|-x <arg>
Proxy URI to use for connecting to just the previous-defined pool
Verbose dump of protocol-level activities
--queue|-Q <arg>
Minimum number of work items to have queued (0+) (default: 1)
Disable logging output, display status and errors
--quit-summary <arg>
Summary printed when you quit: none/devs/procs/detailed
--quota|-U <arg>
quota;URL combination for server with load-balance strategy quotas
Disable all output
--request-diff <arg>
Request a specific difficulty from pools (default: 1.0)
--retries <arg>
Number of times to retry failed submissions before giving up (-1 means never) (default: -1)
--rotate <arg>
Change multipool strategy from failover to regularly rotate at N minutes (default: 0)
Change multipool strategy from failover to round robin on failure
--scan|-S <arg>
Configure how to scan for mining devices
--scan-time|-s <arg>
Upper bound on time spent scanning current work, in seconds (default: 60)
--sched-start <arg>
Set a time of day in HH:MM to start mining (a once off without a stop time)
--sched-stop <arg>
Set a time of day in HH:MM to stop mining (will quit without a start time)
Use the scrypt algorithm for mining (non-bitcoin)
--set-device <arg>
Set default parameters on devices; eg, NFY:osc6_bits=50
--setuid <arg>
Username of an unprivileged user to run as
--sharelog <arg>
Append share log to file
--shares <arg>
Quit after mining 2^32 * N hashes worth of shares (default: unlimited)
Show per processor statistics in summary
--skip-security-checks <arg>
Skip security checks sometimes to save bandwidth; only check 1/<arg>th of the time (default: never skip)
--socks-proxy <arg>
Set socks proxy (host:port)
--stratum-port <arg>
Port number to listen on for stratum miners (-1 means disabled) (default: -1)
--submit-threads <arg>
Minimum number of concurrent share submissions (default: 64) (default: 64)
Use system log for output messages (default: standard error)
--temp-hysteresis <arg>
Set how much the temperature can fluctuate outside limits when automanaging speeds (default: 3)
Disable ncurses formatted screen output
Use Unicode characters in TUI
--url|-o <arg>
URL for bitcoin JSON-RPC server
--user|-u <arg>
Username for bitcoin JSON-RPC server
Log verbose output to stderr as well as status output
Display statistics weighed to difficulty 1
--userpass|-O <arg>
Username:Password pair for bitcoin JSON-RPC server
Display extra work time debug information

Options for command line only:

--config|-c <arg>
Load a JSON-format configuration file See example.conf for an example configuration.
Inhibit loading default config file
Print this message
Display version and exit