Skip to content
This repository has been archived by the owner on Mar 21, 2022. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
Update README on cmdline flags meaning and usage
  • Loading branch information
tdemin committed Oct 13, 2020
1 parent bf97e22 commit 3a08755
Showing 1 changed file with 33 additions and 19 deletions.
52 changes: 33 additions & 19 deletions README.md
Expand Up @@ -14,6 +14,39 @@ If you're an Arch Linux user, you can install it from

`% yay -S syg_go`

### Features

* regex-based key mining (see `-regex`)
* bruteforce-resistant keys mining mode (see `-highaddr`)
* multithreaded key mining (see `-threads`)

### Usage

```
% syg_go -help
Usage of syg_go:
-highaddr
high address mining mode, excludes regex
-iter uint
per how many iterations to output status (default 100000)
-original
use original Yggdrasil code
-regex string
regex to match addresses against (default "::")
-threads int
how many threads to use for mining (default 16)
-version
display version
```

This program outputs keys found to stdout and iterations numbers reached
to stderr so that users can redirect the (possibly) irrelevant status
output to /dev/null. To redirect status output to /dev/null, run:

```
% syg_go ...flags... 2>/dev/null
```

### History

[SimpleYggGen](https://notabug.org/acetone/SimpleYggGen-Bash) is originally a
Expand Down Expand Up @@ -50,25 +83,6 @@ This program contains some modded code from Yggdrasil that aims to improve
performance. If you prefer to use original Yggdrasil code, set `-original`
flag.

### Usage

```
% syg_go -help
Usage of syg_go:
-highaddr
high address mining mode, excludes regex
-iter uint
per how many iterations to output status (default 100000)
-original
use original Yggdrasil code
-regex string
regex to match addresses against (default "::")
-threads int
how many threads to use for mining (default 16)
-version
display version
```

### Development

`go tool pprof` support is available when building with `-tags debug`. The
Expand Down

0 comments on commit 3a08755

Please sign in to comment.