[Pkg-bitcoin-commits] [bfgminer] 03/07: description update + manpage
Dmitry Smirnov
onlyjob at moszumanska.debian.org
Mon Nov 25 15:03:59 UTC 2013
This is an automated email from the git hooks/post-receive script.
onlyjob pushed a commit to branch master
in repository bfgminer.
commit a9a9774
Author: Dmitry Smirnov <onlyjob at member.fsf.org>
Date: Mon Nov 25 14:51:24 2013
description update + manpage
---
debian/bfgminer.1 | 389 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
debian/control | 2 +-
debian/docs | 1 +
debian/rules | 2 +-
4 files changed, 392 insertions(+), 2 deletions(-)
diff --git a/debian/bfgminer.1 b/debian/bfgminer.1
new file mode 100644
index 0000000..69b6b96
--- /dev/null
+++ b/debian/bfgminer.1
@@ -0,0 +1,389 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.10.
+.TH BFGMINER "1" "November 2013" "bfgminer 3.6.0" "User Commands"
+.SH NAME
+bfgminer \- multi-threaded multi-pool ASIC, FPGA, GPU and CPU bitcoin miner.
+.SH SYNOPSIS
+.B bfgminer
+[\fI-atDdEgIKklLmpxPQqUSsTouvwOchnV\fR]
+.SH DESCRIPTION
+multi-threaded multi-pool ASIC, FPGA, GPU and CPU bitcoin miner.
+.IP
+Drivers: avalon bigpic bitforce bitfury_gpio cairnsmore cpu cpu:asm erupter icarus klondike littlefury modminer opencl opencl:adl opencl:sensors proxy proxy:getwork proxy:stratum x6500 ztex
+Algoritms: SHA256d scrypt
+Options: ncursesw5
+.PP
+.SH OPTIONS
+
+
+.SS
+Options for both config file and command line:
+.TP
+\fB\-\-algo\fR|\-a <arg>
+Specify sha256 implementation for CPU mining:
+.TP
+fastauto*
+Quick benchmark at startup to pick a working algorithm
+.TP
+auto
+Benchmark at startup and pick fastest algorithm
+.TP
+c
+Linux kernel sha256, implemented in C
+.TP
+cryptopp
+Crypto++ C/C++ implementation
+.TP
+sse2_64
+SSE2 64 bit implementation for x86_64 machines
+.TP
+sse4_64
+SSE4.1 64 bit implementation for x86_64 machines (default: fastauto)
+.PP
+.SH OPTIONS
+
+
+.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\-\-auto\-fan\fR
+Automatically adjust all GPU fan speeds to maintain a target temperature
+.TP
+\fB\-\-auto\-gpu\fR
+Automatically adjust all GPU engine clock speeds to maintain a target temperature
+.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\-\-cpu\-threads\fR|\-t <arg>
+Number of miner CPU threads (default: \fB\-1\fR)
+.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>
+Select device to use, one value, range and/or comma separated (e.g. 0\-2,4) 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\-\-force\-dev\-init\fR
+Always initialize devices when possible (such as bitstream uploads to some FPGAs)
+.TP
+\fB\-\-gpu\-dyninterval\fR <arg>
+Set the refresh interval in ms for GPUs using dynamic intensity (default: 7)
+.TP
+\fB\-\-gpu\-platform\fR <arg>
+Select OpenCL platform ID to use for GPU mining (default: \fB\-1\fR)
+.TP
+\fB\-\-gpu\-threads\fR|\-g <arg>
+Number of threads per GPU (1 \- 10) (default: \fB\-1\fR)
+.TP
+\fB\-\-gpu\-engine\fR <arg>
+GPU engine (over)clock range in MHz \- one value, range and/or comma separated list (e.g. 850\-900,900,750\-850)
+.TP
+\fB\-\-gpu\-fan\fR <arg>
+GPU fan percentage range \- one value, range and/or comma separated list (e.g. 0\-85,85,65)
+.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\-memclock\fR <arg>
+Set the GPU memory (over)clock in MHz \- one value for all or separate by commas for per card
+.TP
+\fB\-\-gpu\-memdiff\fR <arg>
+Set a fixed difference in clock speed between the GPU and memory in auto\-gpu mode
+.TP
+\fB\-\-gpu\-powertune\fR <arg>
+Set the GPU powertune percentage \- one value for all or separate by commas for per card
+.TP
+\fB\-\-gpu\-reorder\fR
+Attempt to reorder GPU devices according to PCI Bus ID
+.TP
+\fB\-\-gpu\-vddc\fR <arg>
+Set the GPU voltage in Volts \- one value for all or separate by commas for per card
+.TP
+\fB\-\-lookup\-gap\fR <arg>
+Set GPU lookup gap for scrypt mining, comma separated
+.TP
+\fB\-\-intensity\fR|\-I <arg>
+Intensity of GPU scanning (d or \fB\-10\fR \-> 20,default: d to maintain desktop interactivity)
+.TP
+\fB\-\-kernel\-path\fR|\-K <arg>
+Specify a path to where bitstream and kernel files are (default: "/usr/share/bfgminer")
+.TP
+\fB\-\-kernel\fR|\-k <arg>
+Override sha256 kernel to use (diablo, poclbm, phatk or diakgcn) \- one value or comma separated
+.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\-\-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 not overload 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\-longpoll\fR
+Disable X\-Long\-Polling support
+.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\-opencl\-binaries\fR
+Don't attempt to use or save OpenCL kernel binaries
+.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\-\-quota\fR|\-U <arg>
+quota;URL combination for server with load\-balance strategy quotas
+.TP
+\fB\-\-real\-quiet\fR
+Disable all output
+.TP
+\fB\-\-remove\-disabled\fR
+Remove disabled devices entirely, as if they didn't exist
+.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\-serial\fR|\-S <arg>
+Serial port to probe 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\-\-shaders\fR <arg>
+GPU shaders per card for tuning scrypt, comma separated
+.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 N 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\-cutoff\fR <arg>
+Maximum temperature devices will be allowed to reach before being disabled, one value or comma separated list
+.TP
+\fB\-\-temp\-hysteresis\fR <arg>
+Set how much the temperature can fluctuate outside limits when automanaging speeds (default: 3)
+.TP
+\fB\-\-temp\-overheat\fR <arg>
+Overheat temperature when automatically managing fan and GPU speeds, one value or comma separated list (default: 85)
+.TP
+\fB\-\-temp\-target\fR <arg>
+Target temperature when automatically managing fan and clock speeds, one value or comma separated list
+.TP
+\fB\-\-text\-only\fR|\-T
+Disable ncurses formatted screen output
+.TP
+\fB\-\-thread\-concurrency\fR <arg>
+Set GPU thread concurrency for scrypt mining, comma separated
+.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\-\-vectors\fR|\-v <arg>
+Override detected optimal vector (1, 2 or 4) \- one value or comma separated list
+.TP
+\fB\-\-verbose\fR
+Log verbose output to stderr as well as status output
+.TP
+\fB\-\-worksize\fR|\-w <arg>
+Override detected optimal worksize \- one value or comma separated list
+.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\-\-help\fR|\-h
+Print this message
+.TP
+\fB\-\-ndevs\fR|\-n
+Display number of detected GPUs, OpenCL platform information, and exit
+.TP
+\fB\-\-version\fR|\-V
+Display version and exit
diff --git a/debian/control b/debian/control
index 2882ce3..c9e727d 100644
--- a/debian/control
+++ b/debian/control
@@ -22,7 +22,7 @@ Vcs-Git: git://anonscm.debian.org/pkg-bitcoin/bfgminer.git
Package: bfgminer
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
-Description: multi-threaded multi-pool GPU, FPGA and ASIC bitcoin miner
+Description: multi-threaded multi-pool ASIC, FPGA, GPU and CPU bitcoin miner
Bitcoin miner software with multi-threaded multi-pool GPU, FPGA and ASIC
mining support.
.
diff --git a/debian/docs b/debian/docs
index 317c3b6..164c007 100644
--- a/debian/docs
+++ b/debian/docs
@@ -1,5 +1,6 @@
AUTHORS
README
README.FPGA
+README.GPU
README.RPC
README.scrypt
diff --git a/debian/rules b/debian/rules
index ec2c7bd..d7904e3 100755
--- a/debian/rules
+++ b/debian/rules
@@ -27,7 +27,7 @@ override_dh_auto_install:
## remove duplicates
cd $(CURDIR)/debian/bfgminer/usr/share/doc/bfgminer && $(RM) -v COPYING* NEWS*
-MAN_NAME=multi-threaded multi-pool GPU, FPGA and CPU bitcoin miner.
+MAN_NAME=multi-threaded multi-pool ASIC, FPGA, GPU and CPU bitcoin miner.
bfgminer.1:
help2man --no-info --name="$(MAN_NAME)" ./bfgminer > bfgminer.1
perl \
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-bitcoin/bfgminer.git
More information about the Pkg-bitcoin-commits
mailing list