.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.46.5.
.TH CGMINER "1" "June 2015" "cgminer 4.9.2" "User Commands"
.SH NAME
cgminer \- multi-threaded multi-pool GPU, FPGA and CPU bitcoin miner.
.SH SYNOPSIS
.B cgminer
[\fI\,-DlmpPqUTouOchnV\/\fR]
.SH DESCRIPTION
multi-threaded multi-pool GPU, FPGA and CPU bitcoin miner.
Built with avalon avalon2 avalon4 bflsc bitfury cointerra drillbit hashfast icarus klondike mining support.
.PP
.SH OPTIONS


.SS
Options for both config file and command line:
.TP
\fB\-\-anu\-freq\fR <arg>    
Set AntminerU1/2 frequency in MHz, range 125\-500 (default: 250.0)
.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: cgminer 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
.TP
\fB\-\-api\-mcast\-code\fR <arg> 
Code expected in the API Multicast message, don't use '\-'
.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\-\-api\-host\fR <arg>    
Specify API listen address, default: 0.0.0.0
.TP
\fB\-\-au3\-freq\fR <arg>    
Set AntminerU3 frequency in MHz, range 100\-250 (default: 225.0)
.TP
\fB\-\-au3\-volt\fR <arg>    
Set AntminerU3 voltage in mv, range 725\-850, 0 to not set (default: 775)
.TP
\fB\-\-avalon\-auto\fR       
Adjust avalon overclock frequency dynamically for best hashrate
.TP
\fB\-\-avalon\-cutoff\fR <arg> 
Set avalon overheat cut off temperature (default: 60)
.TP
\fB\-\-avalon\-fan\fR        
Set fanspeed percentage for avalon, single value or range (default: 20\-100)
.TP
\fB\-\-avalon\-freq\fR       
Set frequency range for avalon\-auto, single value or range
.TP
\fB\-\-avalon\-options\fR <arg> 
Set avalon options baud:miners:asic:timeout:freq:tech
.TP
\fB\-\-avalon\-temp\fR <arg> 
Set avalon target temperature (default: 50)
.TP
\fB\-\-avalon2\-freq\fR      
Set frequency range for Avalon2, single value or range, step: 25
.TP
\fB\-\-avalon2\-voltage\fR   
Set Avalon2 core voltage, in millivolts, step: 125
.TP
\fB\-\-avalon2\-fan\fR       
Set Avalon2 target fan speed
.TP
\fB\-\-avalon2\-cutoff\fR <arg> 
Set Avalon2 overheat cut off temperature (default: 98)
.TP
\fB\-\-avalon2\-fixed\-speed\fR 
Set Avalon2 fan to fixed speed
.TP
\fB\-\-avalon2\-polling\-delay\fR <arg> 
Set Avalon2 polling delay value (ms) (default: 20)
.TP
\fB\-\-avalon4\-automatic\-voltage\fR 
Automatic adjust voltage base on module DH
.TP
\fB\-\-avalon4\-voltage\fR   
Set Avalon4 core voltage, in millivolts, step: 125
.TP
\fB\-\-avalon4\-freq\fR      
Set frequency for Avalon4, 1 to 3 values, example: 445:385:370
.TP
\fB\-\-avalon4\-fan\fR       
Set Avalon4 target fan speed range
.TP
\fB\-\-avalon4\-temp\fR <arg> 
Set Avalon4 target temperature (default: 42)
.TP
\fB\-\-avalon4\-cutoff\fR <arg> 
Set Avalon4 overheat cut off temperature (default: 65)
.TP
\fB\-\-avalon4\-polling\-delay\fR <arg> 
Set Avalon4 polling delay value (ms) (default: 20)
.TP
\fB\-\-avalon4\-ntime\-offset\fR <arg> 
Set Avalon4 MM ntime rolling max offset (default: 4)
.TP
\fB\-\-avalon4\-aucspeed\fR <arg> 
Set Avalon4 AUC IIC bus speed (default: 400000)
.TP
\fB\-\-avalon4\-aucxdelay\fR <arg> 
Set Avalon4 AUC IIC xfer read delay, 4800 ~= 1ms (default: 19200)
.TP
\fB\-\-balance\fR           
Change multipool strategy from failover to even share balance
.TP
\fB\-\-benchfile\fR <arg>   
Run cgminer in benchmark mode using a work file \- produces no shares
.TP
\fB\-\-benchfile\-display\fR 
Display each benchfile nonce found
.TP
\fB\-\-benchmark\fR         
Run cgminer in benchmark mode \- produces no shares
.TP
\fB\-\-bflsc\-overheat\fR <arg> 
Set overheat temperature where BFLSC devices throttle, 0 to disable (default: 85)
.TP
\fB\-\-bitburner\-voltage\fR <arg> 
Set BitBurner (Avalon) core voltage, in millivolts
.TP
\fB\-\-bitburner\-fury\-voltage\fR <arg> 
Set BitBurner Fury core voltage, in millivolts
.TP
\fB\-\-bitburner\-fury\-options\fR <arg> 
Override avalon\-options for BitBurner Fury boards baud:miners:asic:timeout:freq
.TP
\fB\-\-bxf\-bits\fR <arg>    
Set max BXF/HXF bits for overclocking (default: 54)
.TP
\fB\-\-bxf\-debug\fR <arg>   
BXF: Debug all USB I/O, > is to the board(s), < is from the board(s) (default: 0)
.TP
\fB\-\-bxf\-temp\-target\fR <arg> 
Set target temperature for BXF/HXF devices (default: 82)
.TP
\fB\-\-bxm\-bits\fR <arg>    
Set BXM bits for overclocking (default: 54)
.TP
\fB\-\-btc\-address\fR <arg> 
Set bitcoin target address when solo mining to bitcoind (mandatory)
.TP
\fB\-\-btc\-sig\fR <arg>     
Set signature to add to coinbase when solo mining (optional)
.TP
\fB\-\-compact\fR           
Use compact display without per device statistics
.TP
\fB\-\-cta\-load\fR <arg>    
Set load for CTA devices, 0\-255 range (default: 0)
.TP
\fB\-\-ps\-load\fR <arg>     
Set power supply load for CTA devices, 0\-100 range (default: 0)
.TP
\fB\-\-debug\fR|\-D          
Enable debug output
.TP
\fB\-\-disable\-rejecting\fR 
Automatically disable pools that continually reject shares
.TP
\fB\-\-drillbit\-options\fR <arg> 
Set drillbit options <int|ext>:clock[:clock_divider][:voltage]
.TP
\fB\-\-drillbit\-auto\fR <arg> 
Enable drillbit automatic tuning <every>:[<gooderr>:<baderr>:<maxerr>]
.TP
\fB\-\-fix\-protocol\fR      
Do not redirect to stratum protocol from GBT
.TP
\fB\-\-hfa\-hash\-clock\fR <arg> 
Set hashfast clock speed (default: 550)
.TP
\fB\-\-hfa\-fail\-drop\fR <arg> 
Set how many MHz to drop clockspeed each failure on an overlocked hashfast device (default: 10)
.TP
\fB\-\-hfa\-fan\fR           
Set fanspeed percentage for hashfast, single value or range (default: 10\-85)
.TP
\fB\-\-hfa\-name\fR <arg>    
Set a unique name for a single hashfast device specified with \fB\-\-usb\fR or the first device found
.TP
\fB\-\-hfa\-noshed\fR        
Disable hashfast dynamic core disabling feature
.TP
\fB\-\-hfa\-options\fR <arg> 
Set hashfast options name:clock (comma separated)
.TP
\fB\-\-hfa\-temp\-overheat\fR <arg> 
Set the hashfast overheat throttling temperature (default: 95)
.TP
\fB\-\-hfa\-temp\-target\fR <arg> 
Set the hashfast target temperature (0 to disable) (default: 88)
.TP
\fB\-\-hro\-freq\fR          
Set the hashratio clock frequency
.TP
\fB\-\-hotplug\fR <arg>     
Seconds between hotplug checks (0 means never check)
.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: 5)
.TP
\fB\-\-lowmem\fR            
Minimise caching of shares for low memory applications
.TP
\fB\-\-monitor\fR|\-m <arg>  
Use custom pipe cmd for output messages
.TP
\fB\-\-nfu\-bits\fR <arg>    
Set nanofury bits for overclocking, range 32\-63 (default: 50)
.TP
\fB\-\-net\-delay\fR         
Impose small delays in networking to not overload slow routers
.TP
\fB\-\-no\-submit\-stale\fR   
Don't submit shares if they are detected as stale
.TP
\fB\-\-osm\-led\-mode\fR <arg> 
Set LED mode for OneStringMiner devices (default: 4)
.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\-\-protocol\-dump\fR|\-P  
Verbose dump of protocol\-level activities
.TP
\fB\-\-quiet\fR|\-q          
Disable logging output, display status and errors
.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\-\-rock\-freq\fR <arg>   
Set RockMiner frequency in MHz, range 125\-500 (default: 270.0)
.TP
\fB\-\-rotate\fR <arg>      
Change multipool strategy from failover to regularly rotate at N minutes
.TP
\fB\-\-round\-robin\fR       
Change multipool strategy from failover to round robin on failure
.TP
\fB\-\-sched\-start\fR       
Set a time of day in HH:MM to start mining (a once off without a stop time)
.TP
\fB\-\-sched\-stop\fR        
Set a time of day in HH:MM to stop mining (will quit without a start time)
.TP
\fB\-\-sharelog\fR          
Append share log to file
.TP
\fB\-\-shares\fR <arg>      
Quit after mining N shares (default: unlimited)
.TP
\fB\-\-socks\-proxy\fR <arg> 
Set socks4 proxy (host:port)
.TP
\fB\-\-suggest\-diff\fR <arg> 
Suggest miner difficulty for pool to user (default: none)
.TP
\fB\-\-syslog\fR            
Use system log for output messages (default: standard error)
.TP
\fB\-\-temp\-cutoff\fR       
Temperature where a device will be automatically disabled, one value or comma separated list (default: 0)
.TP
\fB\-\-text\-only\fR|\-T      
Disable ncurses formatted screen output
.TP
\fB\-\-url\fR|\-o <arg>      
URL for bitcoin JSON\-RPC server
.TP
\fB\-\-usb\fR <arg>         
USB device selection
.TP
\fB\-\-user\fR|\-u <arg>     
Username for bitcoin JSON\-RPC server
.TP
\fB\-\-userpass\fR|\-O <arg> 
Username:Password pair for bitcoin JSON\-RPC server
.TP
\fB\-\-verbose\fR           
Log verbose output to stderr as well as status output
.TP
\fB\-\-widescreen\fR        
Use extra wide display without toggling
.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\-\-default\-config\fR <arg> 
Specify the filename of the default config file
Loaded at start and used when saving without a name.
.TP
\fB\-\-help\fR|\-h           
Print this message
.TP
\fB\-\-ndevs\fR|\-n          
Display all USB devices and exit
.TP
\fB\-\-version\fR|\-V        
Display version and exit