[Pkg-bitcoin-commits] [cgminer] 01/01: Updated manpage since the new binary will have same configuration on all archs
Scott Sheridan Howard
showard at moszumanska.debian.org
Sat Nov 8 16:13:31 UTC 2014
This is an automated email from the git hooks/post-receive script.
showard pushed a commit to branch master
in repository cgminer.
commit f7d77e36688f197b721e773fbc628c0db2431c81
Author: Scott Howard <showard314 at gmail.com>
Date: Sat Nov 8 11:13:09 2014 -0500
Updated manpage since the new binary will have same configuration on all archs
---
debian/cgminer.1 | 395 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
debian/changelog | 7 +
debian/clean | 1 -
debian/rules | 35 +++--
4 files changed, 418 insertions(+), 20 deletions(-)
diff --git a/debian/cgminer.1 b/debian/cgminer.1
new file mode 100644
index 0000000..33d8c7d
--- /dev/null
+++ b/debian/cgminer.1
@@ -0,0 +1,395 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.44.1.
+.TH CGMINER "1" "November 2014" "cgminer 4.7.0" "User Commands"
+.SH NAME
+cgminer \- multi-threaded multi-pool GPU, FPGA and CPU bitcoin miner.
+.SH SYNOPSIS
+.B cgminer
+[\fI-DElmpPQqUSsTouOchnV\fR]
+.SH DESCRIPTION
+multi-threaded multi-pool GPU, FPGA and CPU bitcoin miner.
+Built with ant.S1 avalon avalon2 bflsc bitforce bitfury cointerra drillbit hashfast icarus klondike KnC BaB minion modminer Bitmine.A1 spondoolies sp30 mining support.
+.PP
+.SH OPTIONS
+
+
+.SS
+Options for both config file and command line:
+.TP
+\fB\-\-anu\-freq\fR <arg>
+Set AntminerU1 frequency in MHz, range 125\-500 (default: 200.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\-\-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\-\-bab\-options\fR <arg>
+Set bab options max:def:min:up:down:hz:delay:trf
+.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\-\-bfl\-range\fR
+Use nonce range on bitforce devices if supported
+.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\-\-bitmain\-auto\fR
+Adjust bitmain overclock frequency dynamically for best hashrate
+.TP
+\fB\-\-bitmain\-cutoff\fR <arg>
+Set bitmain overheat cut off temperature (default: 75)
+.TP
+\fB\-\-bitmain\-fan\fR
+Set fanspeed percentage for bitmain, single value or range (default: 20\-100)
+.TP
+\fB\-\-bitmain\-freq\fR
+Set frequency range for bitmain\-auto, single value or range
+.TP
+\fB\-\-bitmain\-hwerror\fR
+Set bitmain device detect hardware error
+.TP
+\fB\-\-bitmain\-options\fR <arg>
+Set bitmain options baud:miners:asic:timeout:freq
+.TP
+\fB\-\-bitmain\-temp\fR <arg>
+Set bitmain target temperature (default: 50)
+.TP
+\fB\-\-bitmine\-a1\-options\fR <arg>
+Bitmine A1 options ref_clk_khz:sys_clk_khz:spi_clk_khz:override_chip_num
+.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\-\-bet\-clk\fR <arg>
+Set Block Erupter clock (default: 0)
+.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\-\-expiry\fR|\-E <arg>
+Upper bound on how many seconds after getting work we consider a share from it stale (default: 120)
+.TP
+\fB\-\-failover\-only\fR
+Don't leak work to backup pools when primary pool is lagging
+.TP
+\fB\-\-fix\-protocol\fR
+Do not redirect to a different getwork protocol (eg. stratum)
+.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 (default: 280)
+.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\-\-minion\-chipreport\fR <arg>
+Seconds to report chip 5min hashrate, range 0\-100 (default: 0=disabled) (default: 0)
+.TP
+\fB\-\-minion\-freq\fR <arg>
+Set minion chip frequencies in MHz, single value or comma list, range 100\-1400 (default: 1200)
+.TP
+\fB\-\-minion\-freqchange\fR <arg>
+Millisecond total time to do frequency changes (default: 1000) (default: 1000)
+.TP
+\fB\-\-minion\-freqpercent\fR <arg>
+Percentage to use when starting up a chip (default: 70%) (default: 70)
+.TP
+\fB\-\-minion\-idlecount\fR
+Report when IdleCount is >0 or changes
+.TP
+\fB\-\-minion\-ledcount\fR <arg>
+Turn off led when more than this many chips below the ledlimit (default: 0) (default: 0)
+.TP
+\fB\-\-minion\-ledlimit\fR <arg>
+Turn off led when chips GHs are below this (default: 90) (default: 98)
+.TP
+\fB\-\-minion\-noautofreq\fR
+Disable automatic frequency adjustment
+.TP
+\fB\-\-minion\-overheat\fR
+Enable directly halting any chip when the status exceeds 100C
+.TP
+\fB\-\-minion\-spidelay\fR <arg>
+Add a delay in microseconds after each SPI I/O (default: 0)
+.TP
+\fB\-\-minion\-spireset\fR <arg>
+SPI regular reset: iNNN for I/O count or sNNN for seconds \- 0 means none
+.TP
+\fB\-\-minion\-spisleep\fR <arg>
+Sleep time in milliseconds when doing an SPI reset (default: 200)
+.TP
+\fB\-\-minion\-temp\fR <arg>
+Set minion chip temperature threshold, single value or comma list, range 120\-160 (default: 135C)
+.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\-\-queue\fR|\-Q <arg>
+Maximum number of work items to have queued (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\-\-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\-\-scan\-serial\fR|\-S
+Serial port to probe for Serial FPGA Mining device
+.TP
+\fB\-\-scan\-time\fR|\-s <arg>
+Upper bound on time spent scanning current work, in seconds (default: \fB\-1\fR)
+.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
diff --git a/debian/changelog b/debian/changelog
index c1cf1cf..0ce64a5 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+cgminer (4.7.0-2) UNRELEASED; urgency=medium
+
+ * Updated manpage since the new binary will have same configuration
+ on all archs
+
+ -- Scott Howard <showard at debian.org> Sat, 08 Nov 2014 11:10:48 -0500
+
cgminer (4.7.0-1) unstable; urgency=medium
* New upstream release.
diff --git a/debian/clean b/debian/clean
index bf681e7..0b97d0b 100644
--- a/debian/clean
+++ b/debian/clean
@@ -1,4 +1,3 @@
API.class
*.1
cgminer-api
-debian/cgminer.1
diff --git a/debian/rules b/debian/rules
index 450f4ab..2c6f32a 100755
--- a/debian/rules
+++ b/debian/rules
@@ -45,24 +45,6 @@ override_dh_auto_build:
$(shell dpkg-buildflags --get CPPFLAGS) \
-I /usr/include/libusb-1.0/ -o cgminer-api
-
-#generates manpage, done during build since each arch has different config flags
-MAN_NAME=multi-threaded multi-pool GPU, FPGA and CPU bitcoin miner.
-debian/cgminer.1:
- help2man --no-discard-stderr --no-info --name="$(MAN_NAME)" ./cgminer #for debugging bug #757381
- help2man --no-discard-stderr --no-info --name="$(MAN_NAME)" ./cgminer > debian/cgminer.1
- perl \
- -E 's{\s+(It was generated by help2man)}{ $$1}; # correcting help2man comment' \
- -E 's{^cgminer\s+[\d.]+$$}{$(MAN_NAME)}; # correcting DESCRIPTION section' \
- -E 's{\.PP\K}{\n.SH OPTIONS\n}; # create OPTIONS section' \
- -E 's{^(Options\s+for)}{.SS\n$$1}; # separate Options paragraphs' \
- -E 's{^(\\fB\\-\\-)}{.TP\n$$1}; # prepend each option with .TP' \
- -E 's{(?:<arg>\s+|\s\s+|\\fR\s+(?!<arg>))\K}{\n}; # separate arguments and their descriptions' \
- -pi $@
-
-override_dh_installman: debian/cgminer.1
- dh_installman
-
override_dh_installchangelogs:
dh_installchangelogs NEWS
@@ -75,7 +57,22 @@ copyright_check:
DPATH := $(abspath $(dir $(MAKEFILE_LIST)))
VER ?= $(shell dpkg-parsechangelog -l$(DPATH)/changelog | perl -ne 'print $$1 if m{Version:\s*([\d\.]+)}')
-.PHONY: get-orig-source
+.PHONY: get-orig-source generate-manpage
+
get-orig-source:
@echo "# Downloading..."
uscan --noconf --verbose --rename --destdir=$(CURDIR) --check-dirname-level=0 --force-download --download-version $(VER) $(DPATH)
+
+#generates manpage, make sure package is installed first
+MAN_NAME=multi-threaded multi-pool GPU, FPGA and CPU bitcoin miner.
+debian/cgminer.1: /usr/bin/cgminer
+ help2man --no-discard-stderr --no-info --name="$(MAN_NAME)" $? #for debugging bug #757381
+ help2man --no-discard-stderr --no-info --name="$(MAN_NAME)" $? > $@
+ perl \
+ -E 's{\s+(It was generated by help2man)}{ $$1}; # correcting help2man comment' \
+ -E 's{^cgminer\s+[\d.]+$$}{$(MAN_NAME)}; # correcting DESCRIPTION section' \
+ -E 's{\.PP\K}{\n.SH OPTIONS\n}; # create OPTIONS section' \
+ -E 's{^(Options\s+for)}{.SS\n$$1}; # separate Options paragraphs' \
+ -E 's{^(\\fB\\-\\-)}{.TP\n$$1}; # prepend each option with .TP' \
+ -E 's{(?:<arg>\s+|\s\s+|\\fR\s+(?!<arg>))\K}{\n}; # separate arguments and their descriptions' \
+ -pi $@
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-bitcoin/cgminer.git
More information about the Pkg-bitcoin-commits
mailing list