[Pkg-bitcoin-commits] [SCM] cgminer packaging branch, master, updated. debian/2.11.3-1-4-g7f804aa
Dmitry Smirnov
onlyjob at member.fsf.org
Fri Apr 26 05:49:21 UTC 2013
The following commit has been merged in the master branch:
commit 7f804aaa89793b61b8e5cdc88c894cf9c8c340ce
Author: Dmitry Smirnov <onlyjob at member.fsf.org>
Date: Fri Apr 26 15:36:05 2013 +1000
create man page on build-time; Closes: #705703
* Also create debian/clean file
diff --git a/debian/cgminer.1 b/debian/cgminer.1
deleted file mode 100644
index edff4ef..0000000
--- a/debian/cgminer.1
+++ /dev/null
@@ -1,230 +0,0 @@
-.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.40.10.
-.TH CGMINER "1" "November 2012" "cgminer 2.9.3" "User Commands"
-.SH NAME
-cgminer \- multi-threaded multi-pool GPU, FPGA and CPU bitcoin miner
-.SH SYNOPSIS
-.B cgminer
-[\fI-DdGEgIKklmpPQqSsTouvwOchnV\fR]
-.SH DESCRIPTION
-cgminer -- multi-threaded multi-pool GPU, FPGA and CPU bitcoin miner
-.PP
-.SH OPTIONS
-.SS
-Options for both config file and command line:
-.TP
-\fB\-\-algo\fR|\-a <arg>
-Specify sha256 implementation for CPU mining:
-.IP
-\fBauto\fR
- Benchmark at startup and pick fastest algorithm
-.IP
-\fBc\fR
- Linux kernel sha256, implemented in C
-.IP
-\fB4way\fR
- tcatm's 4\-way SSE2 implementation
-.IP
-\fBvia\fR
- VIA padlock implementation
-.IP
-\fBcryptopp\fR
- Crypto++ C/C++ implementation
-.IP
-\fBsse2_64\fR
- SSE2 64 bit implementation for x86_64 machines
-.IP
-\fBsse4_64\fR
- SSE4.1 64 bit implementation for x86_64 machines (default: sse2_64)
-.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\-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 cgminer in benchmark mode \- produces no shares
-.TP
-\fB\-\-bfl\-range\fR
-Use nonce range on bitforce devices if supported
-.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\-\-device\fR|\-d <arg>
-Select device to use, (Use repeat \fB\-d\fR for multiple devices, default: all)
-.TP
-\fB\-\-disable\-gpu\fR|\-G
-Disable GPU mining even if suitable devices exist
-.TP
-\fB\-\-enable\-cpu\fR|\-C
-Enable CPU mining with other mining (default: no CPU mining if other devices exist)
-.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\-\-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: 2)
-.TP
-\fB\-\-intensity\fR|\-I <arg>
-Intensity of GPU scanning (d or \fB\-10\fR \-> 14, 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/bin")
-.TP
-\fB\-\-kernel\fR|\-k <arg>
-Override sha256 kernel to use (diablo, poclbm, phatk or diakgcn) \- one value or comma separated
-.TP
-\fB\-\-load\-balance\fR
-Change multipool strategy from failover to efficiency based balance
-.TP
-\fB\-\-log\fR|\-l <arg>
-Interval in seconds between log output (default: 5)
-.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\-pool\-disable\fR
-Do not automatically disable pools that continually reject shares
-.TP
-\fB\-\-no\-restart\fR
-Do not attempt to restart GPUs that hang or cgminer if it crashes
-.TP
-\fB\-\-no\-submit\-stale\fR
-Don't submit shares if they are detected as stale
-.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>
-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\-\-real\-quiet\fR
-Disable all output
-.TP
-\fB\-\-remove\-disabled\fR
-Remove disabled devices entirely, as if they didn't exist
-.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 FPGA Mining device
-.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\-\-sharelog\fR <arg>
-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\-\-syslog\fR
-Use system log for output messages (default: standard error)
-.TP
-\fB\-\-temp\-cutoff\fR <arg>
-Temperature where a device will be automatically disabled, one value or comma separated list (default: 95)
-.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\-\-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\-\-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 number of detected GPUs, OpenCL platform information, and exit
-.TP
-\fB\-\-version\fR|\-V
-Display version and exit
diff --git a/debian/changelog b/debian/changelog
index 353a4cc..fc7e84f 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -6,6 +6,8 @@ cgminer (3.0.1-1) UNRELEASED; urgency=low
* Added "--enable-avalon" configure option.
* Build-Depends on "libudev-dev [!kfreebsd-any]" to allow building on
kfreebsd without "libudev-dev".
+ * Build man page automatically (Closes: #705703).
+ + "help2man" added to Build-Depends.
-- Dmitry Smirnov <onlyjob at debian.org> Fri, 26 Apr 2013 13:55:49 +1000
diff --git a/debian/clean b/debian/clean
new file mode 100644
index 0000000..b51b733
--- /dev/null
+++ b/debian/clean
@@ -0,0 +1,2 @@
+API.class
+*.1
diff --git a/debian/control b/debian/control
index e68aa80..2095a6b 100644
--- a/debian/control
+++ b/debian/control
@@ -3,7 +3,7 @@ Section: net
Priority: optional
Maintainer: Debian Bitcoin Packaging Team <pkg-bitcoin-devel at lists.alioth.debian.org>
Uploaders: Dmitry Smirnov <onlyjob at debian.org>, Scott Howard <showard at debian.org>
-Build-Depends: debhelper (>= 9), dh-autoreconf
+Build-Depends: debhelper (>= 9), dh-autoreconf, help2man
,libcurl4-gnutls-dev | libcurl4-dev
,libncurses5-dev
,libusb-1.0-0-dev
diff --git a/debian/manpages b/debian/manpages
index 0f65186..f7e585b 100644
--- a/debian/manpages
+++ b/debian/manpages
@@ -1 +1 @@
-debian/*.1
+*.1
diff --git a/debian/rules b/debian/rules
index 7258eab..3eaf409 100755
--- a/debian/rules
+++ b/debian/rules
@@ -28,6 +28,21 @@ override_dh_auto_install:
dh_auto_install
chmod a-x $(CURDIR)/debian/cgminer/*/*/*/*.cl
+override_dh_installman: cgminer.1
+ dh_installman
+
+MAN_NAME=multi-threaded multi-pool GPU, FPGA and CPU bitcoin miner.
+cgminer.1:
+ help2man --no-info --name="$(MAN_NAME)" ./cgminer > 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_installchangelogs:
dh_installchangelogs NEWS
--
cgminer packaging
More information about the Pkg-bitcoin-commits
mailing list