mirror of
https://github.com/eosswedenorg/antelope-keygen
synced 2026-06-17 03:50:03 +02:00
cli/docs/antelope-keygen.1.in: remove subcommands and refer to their man pages. update security notice and some formatting fixes.
This commit is contained in:
parent
3a2c80e9b5
commit
133aa230fb
1 changed files with 44 additions and 98 deletions
|
|
@ -20,115 +20,61 @@ Antelope IO
|
|||
.OP \--format <value>
|
||||
.YS
|
||||
|
||||
.SY @PROJECT_NAME@
|
||||
search
|
||||
.OP -m
|
||||
.OP \--l33t
|
||||
.OP \--threads <num>
|
||||
.OP \--dict <file1> ...
|
||||
.OP \--lang <value> ...
|
||||
.B word_list
|
||||
.OP count
|
||||
.YS
|
||||
.SH SUBCOMMANDS
|
||||
|
||||
.SY @PROJECT_NAME@
|
||||
benchmark
|
||||
.OP num_keys
|
||||
.YS
|
||||
.PP
|
||||
\fB@PROJECT_NAME@ search\fR
|
||||
.RS 4
|
||||
Search after
|
||||
.UR https://antelope.io
|
||||
Antelope IO
|
||||
.UE
|
||||
vanity keys.
|
||||
.br
|
||||
see \fB@PROJECT_NAME@-search\fR(1)
|
||||
.RE
|
||||
|
||||
.PP
|
||||
\fB@PROJECT_NAME@ benchmark\fR
|
||||
.RS 4
|
||||
Benchmark the performance of the @PROJECT_NAME@ key generator.
|
||||
.br
|
||||
see \fB@PROJECT_NAME@-benchmark\fR(1)
|
||||
.RE
|
||||
|
||||
.SH DESCRIPTION
|
||||
.P
|
||||
.PP
|
||||
Output one Antelope key pair if no arguments are given
|
||||
.P
|
||||
.PP
|
||||
Options and subcommands are as follows:
|
||||
|
||||
.TP 20
|
||||
.B -h, --help
|
||||
.TP
|
||||
\fB\-h\fR, \fB\-\-help\fR
|
||||
Shows this help text.
|
||||
.TP 20
|
||||
.B -v
|
||||
.TP
|
||||
\fB\-v\fR
|
||||
Shows version.
|
||||
.TP 20
|
||||
.B --format <value>
|
||||
What keyformat to use, valid values are: K1, legacy, fio
|
||||
.TP 20
|
||||
.B search
|
||||
performs a search, finding
|
||||
.I <count>
|
||||
public keys containing one or more words from
|
||||
.I <word_list>
|
||||
(separated with ',').
|
||||
Instead of a list it is possible to specify a file with words (separated with newline '\\n') using
|
||||
.I file:<filename>
|
||||
.RS 16
|
||||
Search specific options:
|
||||
.RS 2
|
||||
.TP 20
|
||||
.B -m
|
||||
Monochrome, disables all color output.
|
||||
.TP 20
|
||||
.B --l33t
|
||||
Takes each word in
|
||||
.I <word_list>
|
||||
and find all l33tspeak combinations of that word and uses the new list for the search.
|
||||
.TP 20
|
||||
.B --threads <num>
|
||||
Use
|
||||
.I <num>
|
||||
of parallel threads for searching. Default is what the operating system recommends.
|
||||
.TP 20
|
||||
.B --dict <file>
|
||||
Use words found in
|
||||
.I <file>
|
||||
(separated by newline) to highlight words in the keys found (note that the words in this
|
||||
file are not used for search. only for highlight output). There can be more then one
|
||||
.B --dict
|
||||
flag. In that case contents of all files are merged into one dictionary.
|
||||
.TP 20
|
||||
.B --lang <value>
|
||||
Same as
|
||||
.B --dict
|
||||
but will use
|
||||
.I <value>
|
||||
to find a file in
|
||||
.B @CMAKE_INSTALL_FULL_DATADIR@/@CMAKE_PROJECT_NAME@/dict.
|
||||
There can be more then one
|
||||
.B --lang
|
||||
flag. In that case contents of all files are merged into one dictionary.
|
||||
.TP 20
|
||||
.B count
|
||||
Number of keys to search for (default is 10)
|
||||
.RE 1
|
||||
.TP 15
|
||||
.B benchmark
|
||||
performs a benchmark test, generating
|
||||
.I <num_keys>
|
||||
keys and measuring the time.
|
||||
.PP
|
||||
.RS 16
|
||||
Benchmark specific options:
|
||||
.RS 2
|
||||
.TP 15
|
||||
.B num_keys
|
||||
Number of keys to search for (default is 10)
|
||||
.RE 1
|
||||
|
||||
.TP
|
||||
\fB\-\-format\fR \fR\fI\,value\/\fR
|
||||
What keyformat to use, valid values are: \fIK1\fR, \fIlegacy\fR, \fIfio\fR
|
||||
|
||||
.SH SECURITY NOTICE
|
||||
|
||||
Keys are generated by OpenSSL\'s
|
||||
.B EC_KEY_generate_key
|
||||
function. The program will
|
||||
never expose your keys to anything but the computers memory and output of the\
|
||||
program. You are free to inspect the source code and compile yourself to verify.
|
||||
.P
|
||||
However, use this at your own risk. we cannot guarantee that the keys are\
|
||||
cryptographically secure as this depends on OpenSSL's implementation (alto it is\
|
||||
widely used and should be safe)
|
||||
.P
|
||||
Please read the
|
||||
.I LICENSE
|
||||
file.
|
||||
.PP
|
||||
Keys are generated using
|
||||
.UR https://github.com/eosswedenorg/libantelope
|
||||
libantelope
|
||||
.UE .
|
||||
while the library does not claim to guarantee cryptographically secure keys. it
|
||||
relies on widly used open source cryptographic libraries (OpenSSL, libsecp256k1).
|
||||
|
||||
.PP
|
||||
Use at your own risk. The author and
|
||||
.UR https://eossweden.org
|
||||
Sw/eden
|
||||
.UE
|
||||
does not take responsability for any damage caused by keys generated by the program.
|
||||
|
||||
.P
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
|
||||
.br
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue