.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1.
.TH BFGMINER "1" "June 2014" "bfgminer 4.2.0" "User Commands"
.SH NAME
bfgminer \- multi-threaded multi-pool ASIC, FPGA, GPU and CPU bitcoin miner.
.SH SYNOPSIS
.B bfgminer

.SH DESCRIPTION
multi-threaded multi-pool ASIC, FPGA, GPU and CPU bitcoin miner.
.IP
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
.PP
.SH OPTIONS


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