Skip to content

Commit a41421c

Browse files
rigelminerrigelminer
authored
Update README.md
1 parent 887186f commit a41421c

File tree

1 file changed

+201
-1
lines changed

1 file changed

+201
-1
lines changed

‎README.md‎

Lines changed: 201 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Rigel
22
This is a cryptocurrency miner for Nvidia GPUs
33

4+
![rigel](https://user-images.githubusercontent.com/119491468/204774245-a26bcf43-247f-40ee-8aee-b49982aeac69.png)
5+
46
## Supported algorithms
57
* ethash (Ethereum PoW, Zilliqa)
68
* etchash (Ethereum Classic)
@@ -20,4 +22,202 @@ Currently there is no developer fee, but it will be added in one of the future r
2022
* Temperature limits and fan control
2123
* HTTP API
2224

23-
![rigel](https://user-images.githubusercontent.com/119491468/204774245-a26bcf43-247f-40ee-8aee-b49982aeac69.png)
25+
## Usage
26+
```
27+
-a, --algorithm <ALGORITHM>
28+
Selects the mining algorithm
29+
30+
Currently supported:
31+
etchash (ETC)
32+
ethash (ETHW)
33+
kheavyhash (Kaspa)
34+
zil (Zilliqa)
35+
36+
-o, --url <URL>
37+
Sets the pool URL
38+
39+
Format:
40+
<mining protocol>+<transport protocol>://<pool hostname>:<port number>
41+
42+
Mining protocols: stratum, ethproxy, zmp (zil only)
43+
Transport protocols: tcp, ssl
44+
45+
When dual or triple mining the value should be prepended with
46+
the algorithm index `[<index>]`. Primary algorithm has index 1.
47+
Failover pools are set by using `-o` multiple times.
48+
49+
Examples:
50+
-o stratum+ssl://pool.woolypooly.com:3112
51+
-o zmp+tcp://zil.flexpool.io:9486
52+
mine Zilliqa to flexpool using ZMP protocol
53+
-o [1]stratum+tcp://eth.f2pool.com:6688 -o [2]stratum+ssl://pool.woolypooly.com:3112
54+
mine the primary algorithm to f2pool and the second algorithm to woolypooly
55+
56+
-u, --user <USER>
57+
Sets the username for pool authorisation
58+
59+
When dual or triple mining the value should be prepended with
60+
the algorithm index `[<index>]`. Primary algorithm has index 1.
61+
62+
-w, --worker <WORKER>
63+
Sets the worker name
64+
65+
When dual or triple mining the value should be prepended with
66+
the algorithm index `[<index>]`. Primary algorithm has index 1.
67+
68+
-d, --devices <D1,D2,...>
69+
Sets GPU devices to use for mining
70+
71+
Must be a comma-separated list of device indices. If not specified,
72+
all detected devices will be used. Devices are ordered by their
73+
PCI bus addresses. First GPU has index of 0.
74+
To display all available devices, use --list-devices.
75+
76+
Example:
77+
-d 0,2,4,5
78+
79+
--list-devices
80+
List available mining devices and exit
81+
82+
--dual-mode <MODE1,MODE2,...>
83+
Controls GPU behaviour in dual mining mode
84+
85+
Format: <algo>:<dual ratio>
86+
`<algo>` must be one of the following:
87+
a1 - first algorithm
88+
a2 - second algorithm,
89+
a12 - both
90+
91+
`<dual ratio>` is optional, and, if present,
92+
must be `rXX` (`dual ratio` coefficient set to `XX`)
93+
94+
Comma-separated list of values can be used to set values per-GPU
95+
To skip a GPU, set the corresponding value to underscore `_`
96+
97+
Examples:
98+
--dual-mode a1,_,a12:r5,a2
99+
GPU#0 will mine the primary algorithm
100+
GPU#1 will dual mine with default settings
101+
GPU#1 will dual mine, dual ratio set to 5
102+
GPU#2 will mine the second algorithm
103+
104+
--temp-limit <LIMIT1,LIMIT2,...>
105+
Sets GPU thermal limits
106+
107+
Sets the temperatures of GPU core and memory upon reaching which the miner
108+
stops the overheated GPU and waits for it to cool down before resuming.
109+
110+
Comma-separated list of values can be used to set values per-GPU
111+
To skip a GPU, set the corresponding value to underscore `_`
112+
113+
Examples:
114+
--temp-limit tc[60-70]
115+
stops the GPU when its core temperature reaches 70 degrees celsius
116+
and resumes mining when it cools down to 60 degrees
117+
118+
--temp-limit tm[105-115]
119+
stops the GPU when its memory temperature reaches 115 degrees celsius
120+
and resumes mining when it cools down to 60 degrees
121+
122+
--temp-limit tc[60-70]tm[105-115]
123+
enables both core and memory temperature limits
124+
125+
--cpu-check
126+
Enables CPU verification of found shares before sending them to the pool
127+
128+
--cclock <FREQ1,FREQ2,...>
129+
Sets GPU core clock frequency offset in MHz
130+
131+
Comma-separated list of values can be used to set values per-GPU
132+
To skip a GPU, set the corresponding value to underscore `_`
133+
When dual or triple mining the value may be prepended with
134+
the algorithm index `[<index>]`. Primary algorithm has index 1.
135+
136+
--mclock <FREQ1,FREQ2,...>
137+
Sets GPU memory clock frequency offset in MHz
138+
139+
Comma-separated list of values can be used to set values per-GPU
140+
To skip a GPU, set the corresponding value to underscore `_`
141+
When dual or triple mining the value may be prepended with
142+
the algorithm index `[<index>]`. Primary algorithm has index 1.
143+
144+
--lock-cclock <FREQ1,FREQ2,...>
145+
Locks GPU core clock frequency to the given value in MHz
146+
147+
Comma-separated list of values can be used to set values per-GPU
148+
To skip a GPU, set the corresponding value to underscore `_`
149+
When dual or triple mining the value may be prepended with
150+
the algorithm index `[<index>]`. Primary algorithm has index 1.
151+
152+
--lock-mclock <FREQ1,FREQ2,...>
153+
Locks GPU memory clock frequency to the given value in MHz
154+
155+
Comma-separated list of values can be used to set values per-GPU
156+
To skip a GPU, set the corresponding value to underscore `_`
157+
When dual or triple mining the value may be prepended with
158+
the algorithm index `[<index>]`. Primary algorithm has index 1.
159+
160+
--pl <PL1,PL2,...>
161+
Set GPU power limit to the given value in Watts
162+
163+
Comma-separated list of values can be used to set values per-GPU
164+
To skip a GPU, set the corresponding value to underscore `_`
165+
When dual or triple mining the value may be prepended with
166+
the algorithm index `[<index>]`. Primary algorithm has index 1.
167+
168+
--fan-control <FAN1,FAN2,...>
169+
Sets GPU fan control mode
170+
171+
Can either force the GPU fans to work at a given static speed in %,
172+
or adjust the fan speed to keep the GPU temperature (core, memory, or both)
173+
at a desired level (auto-fan mode)
174+
175+
Format:
176+
--fan-control N
177+
set fan speed to `N`%
178+
--fan-control t:[Tc,Tm][Finit;Fmin-Fmax]
179+
enables auto-fan with `Tc` and `Tm` core and memory temperatures
180+
respectively, set initial fan speed to `Finit`% and limit the
181+
fan speed range to [`Fmin`%,`Fmax`%] range.
182+
every value is optional and can be set to underscore `_`
183+
meaning the default value should be used.
184+
185+
Comma-separated list of values can be used to set values per-GPU
186+
To skip a GPU, set the corresponding value to underscore `_`
187+
188+
Examples:
189+
--fan-control 30
190+
sets GPU fan speed to 30%
191+
--fan-control t:[60;_][50;30-95]
192+
target core temp is 60 degrees, initial fan speed is 50%, 30%-95% range
193+
--fan-control t:[_;90][_;_-95]
194+
target memory temp is 90 degrees, max fan speed 95%
195+
--fan-control t:[70;100][_;_-_]
196+
adjust fan so that core temperature <= 70, memory temperature <= 100,
197+
with no restrictions on the fan speed
198+
199+
-l, --log-file <LOG_FILE>
200+
Enables logging output of the miner to the specified log file
201+
202+
--api-bind <IP:PORT>
203+
Enables HTTP API and binds it to the specified socket address
204+
205+
Examples:
206+
--api-bind 127.0.0.1:5000
207+
--api-bind 0.0.0.0:5000
208+
209+
--long-timestamps
210+
Enables milliseconds timestamps in the miner output
211+
212+
--no-tui
213+
Disables terminal user interface (TUI)
214+
215+
--no-watchdog
216+
Disables miner watchdog
217+
218+
-h, --help
219+
Print help information (use `-h` for a summary)
220+
221+
-V, --version
222+
Print version information
223+
```

0 commit comments

Comments
 (0)