Professional Documents
Culture Documents
USAGE
USAGE
6
Usage: teamredminer [OPTIONS]
Options:
-a, --algo=ALGORITHM Selects the mining algorithm. Currently available:
ethash (eth, etp, others)
etchash (etc, alias for -a ethash
--eth_variant_mode=etchash)
kawpow (ravencoin)
firopow (firo)
autolykos2 (ergo)
verthash (vtc)
nimiq (nimiq)
lyra2z
phi2 (lux, argoneum)
lyra2rev3
x16r
x16rv2
x16s (pgn, xsh)
x16rt (gin)
mtp (zcoin)
cuckatoo31_grin (grin)
cuckarood29_grin (grin)
cnv8
cnr (old monero)
cnv8_half (stellite, masari)
cnv8_dbl (x-cash)
cnv8_rwz (graft)
cnv8_trtl (old turtlecoin, loki)
cnv8_upx2 (uplexa)
cn_heavy (classic CN heavy)
cn_haven (haven)
cn_saber (bittube)
cn_conceal (conceal)
trtl_chukwa (turtlecoin)
trtl_chukwa2 (turtlecoin)
GPU options:
--platform=INDEX Sets the index of the OpenCL platform to use. If not
specified, platform will
be auto-detected. Linux with multiple platforms is
only supported using no
--platform arg but instead adding --bus_reorder.
-d, --devices=DEVLIST Sets gpu devices to use from detected list. DEVLIST
should be a comma-
separated list of device indices, e.g. -d 0,1,2,4.
If not specified, all
devices on the platform(s) will be used. NOTE: by
default the devices are ordered
by pcie bus ordering. Use --list_devices to show
indices.
--init_style=1/2/3 Specified the init style (1 is default):
1: One gpu at the time, complete all before mining.
2: Three gpus at the time, complete all before
mining.
3: All gpus in parallel, start mining immediately.
--pcie_fmt=FORMAT Sets print format for pcie bus numbers. The accepted
values for FORMAT are
either 'hex' or 'dec'. The default is dec for
windows and hex for linux.
--bus_reorder Reorders the detected or specified devices after their
pcie bus id. If no
platform is specified, devices will be collected from
all detected AMD OpenCL
platforms. Note: As of version v0.7.0 this is the
default behavior.
--opencl_order Orders the detected or specified devices in the order
OpenCL presents them.
--list_devices Lists the available devices for the detected or
specified platform and exits
immediately. Bus reordering will be implemented in
the displayed order.
--nr_cu_override=X,Y,... Overrides the nr compute units per gpu as presented
by the OpenCL API. This
is primarily useful for Vega 64s flashed with 56
biosed and where the driver is
reporting 56 CU instead of the true count. Provide a
comma-separated list of the
override CU count per gpu as value for the argument.
You can skip gpus and do not
need to provide values for all gpus in the rig.
Example for a mixed rig of two Vegas
at index 1 and 3 and two other gpus:
--nr_cu_override=,64,,64. You can verify your
argument by also adding --list_devices before mining.
--fan_default_polaris=CFG Set the default config used for all Polaris gpus
(450/460/550/560/470/480/570/580/590).
The built-in default is 55:::50 for 55C core temp and
fan starting at 50%.
Note: this setting is also reused for Tonga gpus.
--fan_default_vega=CFG Set the default config used for all Vega gpus (Vega
56/Vega 64).
The built-in default is 55::70:50 for 55C core temp,
70C mem temp and fan at 50%.
--fan_default_vega2=CFG Set the default config used for all Radeon VII
gpus.
The built-in default is 70::75:80 for 70C core temp,
75C mem temp and fan at 80%.
--fan_default_navi=CFG Set the default config used for all Navi (Navi10).
The built-in default is 60::80:70 for 60C core temp,
80C mem temp and fan at 70%.
--fan_default_big_navi=CFG Set the default config used for all Big Navi
(Navi21).
The built-in default is 50:::70 for 50C core temp and
fan at 70%. The reason for
not including mem temp is a missing sensor in the
Windows ADL library.
--fan_debug Enable log printouts related to adjustments.
Watchdog options:
--no_gpu_monitor Disables the ADL (Windows) or sysfs (Linux) GPU monitor
for temperature and
fan speed.
--temp_limit=TEMP Sets the core temperature at which the miner will stop
GPUs that are too hot.
Default is 85C. Gpu-specific values can be provided
using a comma-separated list,
one value per gpu. If a gpu doesn't have a defined
value, the first value in the list
is used.
--temp_resume=TEMP Sets the core temperature below which the miner will
resume GPUs that were previously
stopped due to the core temperature exceeding limit.
Default is 60C. Gpu-specific
values can be provided using a comma-separated list,
one value per gpu. If a gpu doesn't
have a defined value, the first value in the list is
used.
--mem_temp_limit=TEMP Sets the mem temperature at which the miner will stop
GPUs that are too hot.
Default is not enabled. Only used if the gpu
provides a mem temperature sensor.
Gpu-specific values can be provided using a comma-
separated list, one value per gpu.
If a gpu doesn't have a defined value, the first
value in the list is used.
--mem_temp_resume=TEMP Sets the mem temperature below which the miner will
resume GPUs that were previously
stopped due to mem temperature exceeding limit.
Default is not enabled. Only
used if the gpu provides a mem temperature sensor.
Gpu-specific values can be provided
using a comma-separated list, one value per gpu. If
a gpu doesn't have a defined value,
the first value in the list is used.
--watchdog_script(=X) Configures the gpu watchdog to shut down the miner and
run the specified platform
and exits immediately. The default script is
watchdog.bat/watchdog.sh in the
current directory, but a different script can be
provided as an optional argument,
potentially with a absolute or relative path as well.
--watchdog_test Tests the configured watchdog script by triggering the
same action as a dead gpu
after ~20 secs of mining.
--watchdog_disabled Forces the watchdog to not execute. Can be used to
disable the watchdog in mining os
that always run with the watchdog enabled.
Ethash options:
--eth_config=CONFIG Manual ethash configuration for the miner. CONFIG must
be in the form [X][M][L].
The [M] value selects the mode which can be 'A','B',
or 'C'.
The 'B' mode uses additional memory and will only
work on 8+GB cards.
The 'C' mode uses additional memory and will only
work on 16+GB cards, such as the VII, with
a correctly configured system. See the
ETHASH_TUNING_GUIDE.txt for more details.
The [L] value selects the intensity and it's range
will depend on the GPU architecture.
The [X] prefix is optional and is Navi/Big Navi only,
it enables more mem operations and
leads to a lower tuning [L] value. It can be
beneficial whenever the auto-tuner repeatedly
hits a value close to the max possible tuning value
for the gpu.
Both values are optional, but if [L] is specified,
[M] must also be specified.
Example configs: --eth_config=A
--eth_config=B750
--eth_config=XB
CONFIG can also be a comma separated list of config
values where each is
applied to each GPU. For example:
--eth_config=A,B750,,A288
Any gpu that does not have a specific config in the
list will use the first
config in the list.
--eth_variant_mode=X This argument controls activation of the ethash changes
for ETC from epoch 390 as described
in ecip-1099. The following modes are available:
pool - Default mode. Only activates if the pool
sends an algo flag containing etchash.
Once this flag is seen, all pool jobs
will be assumed to be etchash unless another.
algo flag containing ethash is received.
etchash - Etchash mode. Epoch >= 390 will be
assumed to be etchash, lower epochs ethash. Pool
algo flags are not used.
deduce - Ignore pool algo flags and only apply a
heuristics based on the current system time
and known heights and times for ETC and
ETH. This mode should work as a generic
approach when ETH reaches epoch 390 in
Jan 2021. The system clock needs to be correct.
It should also handle any profit
switching setups that switch freely between ethash and
etchash jobs by proxying underlying
pools.
auto - As long as the pool hasn't passed an algo
flag, use deduce mode. When an algo flag
is seen, switch to pool mode.
ethash - Forced ethash mode. Never apply ecip-
1099.
force_etc - Forced etchash mode. Always apply ecip-
1099 rules. Use for ETC testnet mining.
--eth_aggr_mode Enables automatic use of the 'B' mode for all Polaris
8GB cards, unless they have a
different config provided by the --eth_config
argument. This is the same thing as
manually setting all Polaris 8GB gpus in the rig to
'B' mode using --eth_config.
For most gpus, this adds 0.1-0.2 MH/s of hashrate.
NOTE: 20-25% of rigs becomes less
stable in this mode which is the reason it isn't the
default mode. If you experience
dead gpus, you should remove this argument and run
the gpus in the 'A' mode.
--eth_stratum_mode=MODE Sets a fixed stratum mode for ethash pools. By
default the miner will attempt
to automatically determine the type of stratum the
pool supports and use that mode.
This automatic detection can be overriden by
specifying this option. The MODE can be
set to one of the following options: stratum,
nicehash, ethproxy.
--eth_worker Set the worker id that will be sent to pool. This only
applies to pools with ethproxy
stratum mode.
--eth_hash_report=X Controls hashrate reports to the configure pools. This
value is applied for all pools. Values:
default - let the miner decide based on stratum
protocol used for each pool.
force - always send hashrate reports, even if the
pool rejects them.
on - send a first hashrate report, disable for
any pool that rejects the message.
off - never send hashrate reports.
--eth_epoch Tests a specific ethash epoch. NOTE: you still need to
provide a pool as if you were mining,
but no shares will be submitted. Simulated mining
only.
--eth_alloc_epoch=N Allocates enough memory for the given epoch from the
start. The miner will try to allocate more
if it needs to later during mining. It's recommended
for rigs with one or more 4GB cards to test
and set this to the max possible value to avoid
reallocations at epoch switches. Optimal Linux
rigs should be able to handle epoch 380, Windows rigs
a little less (373-374).
--eth_dag_buf=X,Y,... The miner can allocate a single or dual buffers for the
DAG. For now, the default is DUAL buffers, which
matches the behavior in all recent TRM releases.
However, a single buffer is slightly better, leading
to a small power save for all gpu types. Only recent
drivers support single large allocations larger
than 4GiB, typically from Adrenalin 20.9.1 and
amdgpu-pro 20.x. The miner can automatically use single
buffer mode when possible using this argument, as
well a force single or dual buffers per gpu.
Supported values are A(uto), S(ingle), D(ual). You
can enumerate a comma-separated list for all gpus
in the rig, or a single value for all gpus. A gpu
that does not have a value in the comma-separated list
will use the first value. Hence, to enable auto mode
for all gpus, pass --eth_dag_buf=A
NOTE: 4GB gpus will be forced to use dual buffers.
--eth_big_mode_adjust=X,Y,... When using B- or C-modes, the miner runs
better the more vram it can allocate. Unfortunately the
drivers aren't accurate reporting how much memory
it's possible to allocate, especially on Windows.
The miner will use a safe conservative number of
256MiB (Linux) and 512MiB (Windows) as an offset from
the available vram size. If you want change this
number, you can do so using this argument by providing.
a comma-separated list with values for one or more
gpus. Values for gpus not running B/C-mode will be
ignored. If a gpu doesn't have a value in the list,
the first provided value is used instead.
The allowed interval is [-64, 2048]. The higher
number, the less vram is allocated on the gpu.
--eth_4g_max_alloc=X,Y,... This argument allows mining on 4GB gpus after
they no longer can store the full DAG in vram.
You pass either the max epoch to allocate memory for,
or the raw nr of MB to allocate. You can
provide a single value that applies to all 4GB gpus
in the rig, or use a comma-separated list for
specifying different values per gpu. Values for non-
4GB gpus are ignored.
--eth_dag_slowdown=N Slows down the DAG generation. Pass a single digit 0-
9. 0 means no slowdown (<= 0.7.9 behavior),
1 means minimal slowdown, 9 means max. Default
value: 4 for a slight slowdown.
--eth_stagger Enables staggering of gpus when building a new DAG.
This is more lean on PSUs that don't like
going from 0-100% load on all gpus at the same time.
--eth_no_stagger Disables --eth_stagger. Already the default behavior
from 0.7.18. Argument kept for backwards
compatibility only.
--eth_ramp_up Adds ramping up the intensity on all gpus after a DAG
build, gpu disable/enable or network outage.
Can help rigs with crashes right between the DAG
build and starting mining.
--eth_no_ramp_up Disables --eth_ramp_up. Already the default behavior
from 0.7.18. Argument kept for backwards
compatibility only.
--eth_direct_abort Uses a different mechanism to abort ongoing gpu jobs.
Recommended for Vegas in ROCm environments
to minimize stale shares. Will apply to Vega and
Polaris gpus in the rig only.
--eth_dag_alloc_patch Some motherboards with outdated bios can see hw errs
typically on the first or last gpu in the system.
Use this argument to force a patched dag allocation
strategy that most often solves the issue.
Upgrading your bios often solves the issue as well.
--eth_hashwatch(=M,M) Defines a min/max watchdog hashrate in MH/s expected
when gpus are hashing. If a GPU falls outside
of this range for too long it will be considered
faulty and the watchdog will be triggered. The
default min/max values are 2 MH/s and 150 MH/s. To
activate with default values, use
--eth_hashwatch. To set your own values, use e.g.
--eth_hashwatch=1.25,60. The same range is used
for all gpus in the rig. A negative value for one
side disables it, e.g. use --eth_hashwatch=-1,1000
to handle gpu resets that result in huge fake
hashrates but no minimum check.
--eth_dag_cache(=EPOCH) Enables saving eth DAGs from jobs with different
epochs to prevent having to rebuild them in the
future if jobs with the old epochs are received
again. At most one DAG will be saved if GPU memory
space allows. This is useful for switching pools
such as eth+zil mining. If you want to prebuild a
certain epoch immediately at startup, add the
optional value. Eth+zil switching miners should use
--eth_dag_cache=0. Only ethash (and not etchash)
epochs can be prebuilt at this time.
--eth_dag_cache_resv=MEM Sets the amount of GPU memory the miner will
attempt to leave unused when running with DAG caching
enabled (see --eth_dag_cache). The argument MEM is
the amount of memory to leave unused in
mebibytes. The default value is 256.
--eth_dag_cache_verify Enable dag cache read and verification after a
finished dag build. This will detect situations
where the dag cache had bit errors and the resulting
dag is partially broken. We have seen this
happen increasingly on Vegas as the dag has grown
bigger. When detected, a new buffer will be
allocated for the dag cache and the dag build
restarted.
--eth_no_4gb_kernels Disable the ethash 4GB kernels and always use the
regular kernels that assume the DAG will always
fit in available vram on all gpus. This is useful
when mining ETC or ethash coins at lower epochs
than ETH since the regular kernels have a better
performance profile.
--eth_micro_delay=VAL Navi gpus only: adds a delay (measured in
microseconds) when reenqueueing work on the gpu(s).
Weaker PSUs driving many gpus can sometimes not
handle the "slew rate" when multiple gpus happen to
reenqueue work at exactly the same time. Setting
this to e.g. 32 will smoothen out the transition
from no load to 100% load enough to lower the slew
rate on such rigs. The typical indication of this
issue is hard hangs where the rig becomes
unresponsive requiring a power cycle to reboot, but it can also
be regular gpu crashes. Valid values are 1-128. Not
using this argument means no delay, value zero.
Cryptonight options:
--rig_id Set the rig identifier that will be sent to the pool.
This is only used for
cryptonight pools.
--cn_config=CONFIG Manual cryptonight configuration for the miner. CONFIG
must be in the form
[P][I0][M][I1][:xyz], where [P] is an optional prefix
and [:xyz] is an
optional suffix. For [P], only the value of 'L' is
supported for low-end
GPUs like Lexa/Baffin. [I0] and [I1] are the thread
intensity values normally
ranging from 1 to 16, but larger values are possible
for 16GB gpus. [M] is the
mode which can be either '.', -', '+' or '*'. Mode
'.' means that the miner
should choose or scan for the best mode. Mode '*'
both a good default more and
_should_ be used if you mine on a Vega 56/64 with
modded mem timings. The
exceptions to this rule are small pad variants
(cnv8_trtl and cnv8_upx2), they
should still use '+'. For Polaris gpus, only the '-'
and '+' modes are available.
MTP options:
--allow_all_devices Some algos can't be mined on e.g. 4GB gpus. Those gpus
will be disabled automatically
by the miner. This argument overrides this logic and
allows mining on all specified
or detected devices.
X16* options:
--hash_order=VALUE Sets a fixed hash order for algorithms like x16r for
benchmarking purposes.
Note that using this option needs a pool connection
but will not submit shares.
The standard benchmark hash order for x16r is
--hash_order=0123456789abcdef.
Nimiq options:
--nimiq_worker=VALUE Sets the worker/device name for nimiq to pass to the
pool(s).
--nimiq_no_proxy Disables the automatic Nimiq proxy executed as a
separate process. This means that the
host and port passed to the miner must be pointing to
a proxy.
--nimiq_proxy=VALUE Overrides the default path to the Nimiq proxy. The
default is trm_nimiq_proxy-win.exe.
and trm_nimiq_proxy-linux in the current miner
director.
--nimiq_port=VALUE Overrides the default local port (4444) used for the
Nimiq proxy. This can be used if your
system is already using port 4444 for some other
tcp/ip service.
Verthash options:
--verthash_file=FILE Sets the filename to be used to load/store the verthash
data file. If this option is
specified when the verthash algo is used, the miner
will attempt to load the verthash
data from the file. If the file does not exist, the
miner will generate the verthash
data and then save it in the file for future use. If
this option is not specified the
miner will generate the verthash data in system
memory on every start.
--verthash_max_uploads=N Some motherboards have issues with all gpus in the
rig uploading the verthash table
at the same time. This argument limits the number of
concurrent gpus that are uploading
the table at the same time at startup. Allowed
values are 1-32. The default value is 4.
Autolykos2 options:
--autolykos_mem_adjust=N Sets the amount of memory in MiB that the miner
should leave unused when allocating
GPU buffers for autolykos. The default value is 384
on linux and 512 on windows. For GPUs
with displays attached, the default is increased by
512. If dual mining with ZIL, the
default value is increased by 1024. The option can
also be provided with a comma separated
list of values where each value is applied to each
GPU. If an empty value is specified
in the list, the default will be used for that GPU.
If a value is not specified for a GPU
it will use the first value in the list. For
example:
--autolykos_mem_adjust=256,512,,256
--autolykos_slowdown=N Adds a slowdown of the pad build process. Valid
values are 0-100. The default is 0, no
slowdown.
--zil_end Marks that we're done with the ZIL mining config and
all following arguments are for the primary
algo. This argument isn't strictly necessary, but
should be included for mining distros since
the user has no guarantee what arguments will be
added automatically at the end of the command
line by the distro.
--stats_mode=single/dual When adding ZIL dual mining, the stats output will
by default be duplicated to add info for
the ZIL mining. Some contexts might get confused by
this if they are parsing the TRM outut or
log files. To switch to the default output, add
--stats_mode=single.