Deprecate shorthand options for uncommonly-used --algo, --cpu-threads, --expiry, --gpu-threads, --intensity, --kernel-path, --kernel, --scan-time, --vectors, and --worksize

README

@@ -231,11 +231,11 @@ Options for both config file and command line:
 --device|-d <arg>   Enable only devices matching pattern (default: all)
 --disable-rejecting Automatically disable pools that continually reject shares
 --http-port <arg>   Port number to listen on for HTTP getwork miners (-1 means disabled) (default: -1)
---expiry|-E <arg>   Upper bound on how many seconds after getting work we consider a share from it stale (w/o longpoll active) (default: 120)
+--expiry <arg>      Upper bound on how many seconds after getting work we consider a share from it stale (w/o longpoll active) (default: 120)
 --expiry-lp <arg>   Upper bound on how many seconds after getting work we consider a share from it stale (with longpoll active) (default: 3600)
 --failover-only     Don't leak work to backup pools when primary pool is lagging
 --force-dev-init    Always initialize devices when possible (such as bitstream uploads to some FPGAs)
---kernel-path|-K <arg> Specify a path to where bitstream and kernel files are (default: "/usr/local/bin")
+--kernel-path <arg> Specify a path to where bitstream and kernel files are
 --load-balance      Change multipool strategy from failover to quota based balance
 --log|-l <arg>      Interval in seconds between log output (default: 20)
 --log-file|-L <arg> Append log file for output messages
@@ -266,7 +266,7 @@ Options for both config file and command line:
 --rotate <arg>      Change multipool strategy from failover to regularly rotate at N minutes (default: 0)
 --round-robin       Change multipool strategy from failover to round robin on failure
 --scan|-S <arg>     Configure how to scan for mining devices
---scan-time|-s <arg> Upper bound on time spent scanning current work, in seconds (default: 60)
+--scan-time <arg>   Upper bound on time spent scanning current work, in seconds (default: 60)
 --sched-start <arg> Set a time of day in HH:MM to start mining (a once off without a stop time)
 --sched-stop <arg>  Set a time of day in HH:MM to stop mining (will quit without a start time)
 --scrypt            Use the scrypt algorithm for mining (non-bitcoin)
@@ -299,7 +299,7 @@ GPU only options:
 
 --auto-fan          Automatically adjust all GPU fan speeds to maintain a target temperature
 --auto-gpu          Automatically adjust all GPU engine clock speeds to maintain a target temperature
---gpu-threads|-g <arg> Number of threads per GPU (1 - 10) (default: 2)
+--gpu-threads <arg> Number of threads per GPU (1 - 10) (default: -1)
 --gpu-dyninterval <arg> Set the refresh interval in ms for GPUs using dynamic intensity (default: 7)
 --gpu-engine <arg>  GPU engine (over)clock range in MHz - one value, range and/or comma separated list (e.g. 850-900,900,750-850)
 --gpu-fan <arg>     GPU fan percentage range - one value, range and/or comma separated list (e.g. 25-85,85,65)
@@ -310,12 +310,12 @@ GPU only options:
 --gpu-powertune <arg> Set the GPU powertune percentage - one value for all or separate by commas for per card.
 --gpu-reorder       Attempt to reorder GPU devices according to PCI Bus ID
 --gpu-vddc <arg>    Set the GPU voltage in Volts - one value for all or separate by commas for per card.
---intensity|-I <arg> Intensity of GPU scanning (d or -10 -> 10, default: d to maintain desktop interactivity)
---kernel|-k <arg>   Override kernel to use (diablo, poclbm, phatk or diakgcn) - one value or comma separated
+--intensity <arg>   Intensity of GPU scanning (d or -10 -> 31,default: d to maintain desktop interactivity)
+--kernel <arg>      Override sha256 kernel to use (diablo, poclbm, phatk or diakgcn) - one value or comma separated
 --no-adl            Disable the ATI display library used for monitoring and setting GPU parameters
 --temp-overheat <arg> Overheat temperature when automatically managing fan and GPU speeds (default: 85)
---vectors|-v <arg>  Override detected optimal vector (1, 2 or 4) - one value or comma separated list
---worksize|-w <arg> Override detected optimal worksize - one value or comma separated list
+--vectors <arg>     Override detected optimal vector (1, 2 or 4) - one value or comma separated list
+--worksize <arg>    Override detected optimal worksize - one value or comma separated list
 
 GPU mining is disabled by default for SHA256d if you have any dedicated mining
 devices, but can be enabled explicitly specifying the -S opencl:auto option.
@@ -752,9 +752,9 @@ A; Try the --net-delay option if you are on a getwork or GBT server.
 Q: How do I tune for P2Pool?
 A: P2Pool has very rapid expiration of work and new blocks, it is suggested you
 decrease intensity by 1 from your optimal value, and decrease GPU threads to 1
-with -g 1. It is also recommended to use --failover-only since the work is
-effectively like a different block chain. If mining with a Mini Rig, it is worth
-adding the --bfl-range option.
+with --gpu-threads 1. It is also recommended to use --failover-only since the
+work is effectively like a different block chain. If mining with a Mini Rig, it
+is worth adding the --bfl-range option.
 
 Q: Are OpenCL kernels from other mining software useable in BFGMiner?
 A: No, the APIs are slightly different between the different software and they

README.CPU

@@ -9,7 +9,7 @@ README for further information).
 
 The following CPU mining options are available:
 
---algo|-a <arg> Specify sha256 implementation for CPU mining:
+--algo <arg>        Specify sha256 implementation for CPU mining:
         fastauto*       Quick benchmark at startup to pick a working algorithm
         auto            Benchmark at startup and pick fastest algorithm
         c               Linux kernel sha256, implemented in C
@@ -21,7 +21,7 @@ The following CPU mining options are available:
         sse2_64         SSE2 64 bit implementation for x86_64 machines
         sse4_64         SSE4.1 64 bit implementation for x86_64 machines
         altivec_4way    Altivec implementation for PowerPC G4 and G5 machines
---cpu-threads|-t <arg> Number of miner CPU threads (default: 4)
+--cpu-threads <arg> Number of miner CPU threads (default: -1)
 
 CPU FAQ:
 

README.GPU

@@ -14,23 +14,23 @@ mining performance.
 
 Single pool, dedicated miner:
 
-bfgminer -S opencl:auto -o http://pool:port -u username -p password -I 9
+bfgminer -S opencl:auto -o http://pool:port -u username -p password --intensity 9
 
 Single pool, first card regular desktop, 3 other dedicated cards:
 
-bfgminer -S opencl:auto -o http://pool:port -u username -p password -I d,9,9,9
+bfgminer -S opencl:auto -o http://pool:port -u username -p password --intensity d,9,9,9
 
 Multiple pool, dedicated miner:
 
-bfgminer -S opencl:auto -o http://pool1:port -u pool1username -p pool1password -o http://pool2:port -u pool2usernmae -p pool2password -I 9
+bfgminer -S opencl:auto -o http://pool1:port -u pool1username -p pool1password -o http://pool2:port -u pool2usernmae -p pool2password --intensity 9
 
 Add overclocking settings, GPU and fan control for all cards:
 
-bfgminer -S opencl:auto -o http://pool:port -u username -p password -I 9 --auto-fan --auto-gpu --gpu-engine 750-950 --gpu-memclock 300
+bfgminer -S opencl:auto -o http://pool:port -u username -p password --intensity 9 --auto-fan --auto-gpu --gpu-engine 750-950 --gpu-memclock 300
 
 Add overclocking settings, GPU and fan control with different engine settings for 4 cards:
 
-bfgminer -S opencl:auto -o http://pool:port -u username -p password -I 9 --auto-fan --auto-gpu --gpu-engine 750-950,945,700-930,960 --gpu-memclock 300
+bfgminer -S opencl:auto -o http://pool:port -u username -p password --intensity 9 --auto-fan --auto-gpu --gpu-engine 750-950,945,700-930,960 --gpu-memclock 300
 
 READ WARNINGS AND DOCUMENTATION BELOW ABOUT OVERCLOCKING
 
@@ -306,7 +306,7 @@ To work around this you would use:
 GPU FAQ:
 
 Q: Can I change the intensity settings individually for each GPU?
-A: Yes, pass a list separated by commas such as -I d,4,9,9
+A: Yes, pass a list separated by commas such as --intensity d,4,9,9
 
 Q: The CPU usage is high.
 A: The ATI drivers after 11.6 have a bug that makes them consume 100% of one
@@ -324,10 +324,10 @@ you will be able to run. You are more likely to hit your limits with BFGMiner
 and you will find you may need to overclock your GPU less aggressively. The
 software cannot be responsible and make your GPU hang directly. If you simply
 cannot get it to ever stop hanging, try decreasing the intensity, and if even
-that fails, try changing to the poclbm kernel with -k poclbm, though you will
-sacrifice performance. BFGMiner is designed to try and safely restart GPUs as
-much as possible, but NOT if that restart might actually crash the rest of the
-GPUs mining, or even the machine. It tries to restart them with a separate
+that fails, try changing to the poclbm kernel with --kernel poclbm, though you
+will sacrifice performance. BFGMiner is designed to try and safely restart GPUs
+as much as possible, but NOT if that restart might actually crash the rest of
+the GPUs mining, or even the machine. It tries to restart them with a separate
 thread and if that separate thread dies, it gives up trying to restart any more
 GPUs.
 

README.scrypt

@@ -40,7 +40,7 @@ lines are in the .bat before starting BFGMiner:
 setx GPU_MAX_ALLOC_PERCENT 100
 setx GPU_USE_SYNC_OBJECTS 1
 
---intensity XX (-I XX)
+--intensity XX
 
 Just like in Bitcoin mining, scrypt mining takes an intensity, however the
 scale goes from 0 to 31. 
@@ -99,7 +99,7 @@ all you will need to set.
 
 
 Optional parameters to tune:
--g, --thread-concurrency, --lookup-gap
+--gpu-threads, --thread-concurrency, --lookup-gap
 
 --thread-concurrency:
 This tunes the optimal size of work that scrypt can do. It is internally tuned
@@ -111,10 +111,11 @@ into --shaders and is ultimately a BETTER way to tune performance.
 SUMMARY: Spend lots of time finding the highest value that your device likes
 and increases hashrate.
 
--g:
+--gpu-threads:
 Once you have found the optimal shaders and intensity, you can start increasing
-the -g value till BFGMiner fails to start. This is really only of value if you
-want to run low intensities as you will be unable to run more than 1.
+the --gpu-threads value till BFGMiner fails to start. This is really only of
+value if you want to run low intensities as you will be unable to run more than
+1.
 SUMMARY: Don't touch this.
 
 --lookup-gap
@@ -127,12 +128,12 @@ SUMMARY: Don't touch this.
 
 
 Related parameters:
---worksize XX (-w XX)
+--worksize XX
 Has a minor effect, should be a multiple of 64 up to 256 maximum.
 SUMMARY: Worth playing with once everything else has been tried but will
 probably do nothing.
 
---vectors XX (-v XX)
+--vectors XX
 Vectors are NOT used by the scrypt mining kernel.
 SUMMARY: Does nothing.
 
@@ -180,7 +181,7 @@ generated.
 
 First try without any thread concurrency or even shaders, as BFGMiner will try to
 find an optimal value:
-bfgminer -I 13
+bfgminer --intensity 13
 
 If that starts mining, see what bin was generated, it is likely the largest
 meaningful TC you can set.
@@ -216,7 +217,7 @@ without crashing the GPU, you will have to use a lower memclock.
 Then, and only then, bother trying to increase intensity further.
 
 My final settings were:
---gpu-engine 1141  --gpu-memclock 1875 -I 20
+--gpu-engine 1141  --gpu-memclock 1875 --intensity 20
 for a hashrate of 745kH.
 
 Note I did not bother setting a thread concurrency. Once you have the magic

miner.c

@@ -1852,7 +1852,7 @@ static char *set_null(const char __maybe_unused *arg)
 /* These options are available from config file or commandline */
 static struct opt_table opt_config_table[] = {
 #ifdef WANT_CPUMINE
-	OPT_WITH_ARG("--algo|-a",
+	OPT_WITH_ARG("--algo",
 		     set_algo, show_algo, &opt_algo,
 		     "Specify sha256 implementation for CPU mining:\n"
 		     "\tfastauto*\tQuick benchmark at startup to pick a working algorithm\n"
@@ -1881,6 +1881,9 @@ static struct opt_table opt_config_table[] = {
     "\n\taltivec_4way\tAltivec implementation for PowerPC G4 and G5 machines"
 #endif
 		),
+	OPT_WITH_ARG("-a",
+	             set_algo, show_algo, &opt_algo,
+	             opt_hidden),
 #endif
 	OPT_WITH_ARG("--api-allow",
 		     set_api_allow, NULL, NULL,
@@ -1975,9 +1978,12 @@ static struct opt_table opt_config_table[] = {
 			"Use compact display without per device statistics"),
 #endif
 #ifdef WANT_CPUMINE
-	OPT_WITH_ARG("--cpu-threads|-t",
+	OPT_WITH_ARG("--cpu-threads",
 		     force_nthreads_int, opt_show_intval, &opt_n_threads,
 		     "Number of miner CPU threads"),
+	OPT_WITH_ARG("-t",
+	             force_nthreads_int, opt_show_intval, &opt_n_threads,
+	             opt_hidden),
 #endif
 	OPT_WITHOUT_ARG("--debug|-D",
 		     enable_debug, &opt_debug,
@@ -2004,9 +2010,12 @@ static struct opt_table opt_config_table[] = {
 			opt_set_bool, &opt_usecpu,
 			opt_hidden),
 #endif
-	OPT_WITH_ARG("--expiry|-E",
+	OPT_WITH_ARG("--expiry",
 		     set_int_0_to_9999, opt_show_intval, &opt_expiry,
 		     "Upper bound on how many seconds after getting work we consider a share from it stale (w/o longpoll active)"),
+	OPT_WITH_ARG("-E",
+	             set_int_0_to_9999, opt_show_intval, &opt_expiry,
+	             opt_hidden),
 	OPT_WITH_ARG("--expiry-lp",
 		     set_int_0_to_9999, opt_show_intval, &opt_expiry_lp,
 		     "Upper bound on how many seconds after getting work we consider a share from it stale (with longpoll active)"),
@@ -2025,9 +2034,12 @@ static struct opt_table opt_config_table[] = {
 	OPT_WITH_ARG("--gpu-platform",
 		     set_int_0_to_9999, opt_show_intval, &opt_platform_id,
 		     "Select OpenCL platform ID to use for GPU mining"),
-	OPT_WITH_ARG("--gpu-threads|-g",
+	OPT_WITH_ARG("--gpu-threads",
 		     set_int_1_to_10, opt_show_intval, &opt_g_threads,
 		     "Number of threads per GPU (1 - 10)"),
+	OPT_WITH_ARG("-g",
+	             set_int_1_to_10, opt_show_intval, &opt_g_threads,
+	             opt_hidden),
 #ifdef HAVE_ADL
 	OPT_WITH_ARG("--gpu-engine",
 		     set_gpu_engine, NULL, NULL,
@@ -2058,28 +2070,37 @@ static struct opt_table opt_config_table[] = {
 	OPT_WITH_ARG("--lookup-gap",
 		     set_lookup_gap, NULL, NULL,
 		     "Set GPU lookup gap for scrypt mining, comma separated"),
-	OPT_WITH_ARG("--intensity|-I",
+	OPT_WITH_ARG("--intensity",
 		     set_intensity, NULL, NULL,
 		     "Intensity of GPU scanning (d or " MIN_SHA_INTENSITY_STR
 		     " -> " MAX_SCRYPT_INTENSITY_STR
 		     ",default: d to maintain desktop interactivity)"),
 #else
-	OPT_WITH_ARG("--intensity|-I",
+	OPT_WITH_ARG("--intensity",
 		     set_intensity, NULL, NULL,
 		     "Intensity of GPU scanning (d or " MIN_SHA_INTENSITY_STR
 		     " -> " MAX_SHA_INTENSITY_STR
 		     ",default: d to maintain desktop interactivity)"),
 #endif
+	OPT_WITH_ARG("-I",
+	             set_intensity, NULL, NULL,
+	             opt_hidden),
 #endif
 #if defined(HAVE_OPENCL) || defined(USE_MODMINER) || defined(USE_X6500) || defined(USE_ZTEX)
-	OPT_WITH_ARG("--kernel-path|-K",
+	OPT_WITH_ARG("--kernel-path",
 		     opt_set_charp, opt_show_charp, &opt_kernel_path,
 	             "Specify a path to where bitstream and kernel files are"),
+	OPT_WITH_ARG("-K",
+	             opt_set_charp, opt_show_charp, &opt_kernel_path,
+	             opt_hidden),
 #endif
 #ifdef HAVE_OPENCL
-	OPT_WITH_ARG("--kernel|-k",
+	OPT_WITH_ARG("--kernel",
 		     set_kernel, NULL, NULL,
 		     "Override sha256 kernel to use (diablo, poclbm, phatk or diakgcn) - one value or comma separated"),
+	OPT_WITH_ARG("-k",
+	             set_kernel, NULL, NULL,
+	             opt_hidden),
 #endif
 #ifdef USE_ICARUS
 	OPT_WITH_ARG("--icarus-options",
@@ -2244,9 +2265,12 @@ static struct opt_table opt_config_table[] = {
 	OPT_WITH_ARG("--scan-device|--scan-serial|--devscan",
 		     add_serial, NULL, NULL,
 		     opt_hidden),
-	OPT_WITH_ARG("--scan-time|-s",
+	OPT_WITH_ARG("--scan-time",
 		     set_int_0_to_9999, opt_show_intval, &opt_scantime,
 		     "Upper bound on time spent scanning current work, in seconds"),
+	OPT_WITH_ARG("-s",
+		     set_int_0_to_9999, opt_show_intval, &opt_scantime,
+		     opt_hidden),
 	OPT_WITH_ARG("--scantime",
 		     set_int_0_to_9999, opt_show_intval, &opt_scantime,
 		     opt_hidden),
@@ -2347,9 +2371,12 @@ static struct opt_table opt_config_table[] = {
 		     set_user, NULL, NULL,
 		     "Username for bitcoin JSON-RPC server"),
 #ifdef HAVE_OPENCL
-	OPT_WITH_ARG("--vectors|-v",
+	OPT_WITH_ARG("--vectors",
 		     set_vector, NULL, NULL,
 		     "Override detected optimal vector (1, 2 or 4) - one value or comma separated list"),
+	OPT_WITH_ARG("-v",
+	             set_vector, NULL, NULL,
+	             opt_hidden),
 #endif
 	OPT_WITHOUT_ARG("--verbose",
 			opt_set_bool, &opt_log_output,
@@ -2358,9 +2385,12 @@ static struct opt_table opt_config_table[] = {
 	                opt_set_bool, &opt_weighed_stats,
 	                "Display statistics weighed to difficulty 1"),
 #ifdef HAVE_OPENCL
-	OPT_WITH_ARG("--worksize|-w",
+	OPT_WITH_ARG("--worksize",
 		     set_worksize, NULL, NULL,
 		     "Override detected optimal worksize - one value or comma separated list"),
+	OPT_WITH_ARG("-w",
+	             set_worksize, NULL, NULL,
+	             opt_hidden),
 #endif
 	OPT_WITHOUT_ARG("--unittest",
 			opt_set_bool, &opt_unittest, opt_hidden),