From 3a2c80e9b5800cd33c4763b2a27b425812ed2b02 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Mon, 10 Apr 2023 16:35:15 +0200 Subject: [PATCH] cli/docs: adding antelope-keygen-benchmark.1.in and antelope-keygen-search.1.in --- cli/CMakeLists.txt | 2 + cli/docs/antelope-keygen-benchmark.1.in | 67 ++++++++++++++ cli/docs/antelope-keygen-search.1.in | 112 ++++++++++++++++++++++++ 3 files changed, 181 insertions(+) create mode 100644 cli/docs/antelope-keygen-benchmark.1.in create mode 100644 cli/docs/antelope-keygen-search.1.in diff --git a/cli/CMakeLists.txt b/cli/CMakeLists.txt index 087b24d..ff3512f 100644 --- a/cli/CMakeLists.txt +++ b/cli/CMakeLists.txt @@ -68,6 +68,8 @@ install(FILES ${PROJECT_BINARY_DIR}/README.cli.md if (UNIX) configure_file( docs/antelope-keygen.1.in ${PROJECT_BINARY_DIR}/man1/antelope-keygen.1 ) + configure_file( docs/antelope-keygen-search.1.in ${PROJECT_BINARY_DIR}/man1/antelope-keygen-search.1 ) + configure_file( docs/antelope-keygen-benchmark.1.in ${PROJECT_BINARY_DIR}/man1/antelope-keygen-benchmark.1 ) install(DIRECTORY ${PROJECT_BINARY_DIR}/man1 DESTINATION ${CMAKE_INSTALL_MANDIR} diff --git a/cli/docs/antelope-keygen-benchmark.1.in b/cli/docs/antelope-keygen-benchmark.1.in new file mode 100644 index 0000000..cd16012 --- /dev/null +++ b/cli/docs/antelope-keygen-benchmark.1.in @@ -0,0 +1,67 @@ +.TH @PROJECT_NAME@-benchmark 1 "April, 2023" "@PROJECT_NAME@-benchmark @PROJECT_VERSION@" + +.SH NAME +@PROJECT_NAME@ benchmark - Benchmark the performance of the @PROJECT_NAME@ key generator. + +.SH SYNOPSIS + +.SY @PROJECT_NAME@ +benchmark +.OP \-h|--help +.YS + +.SY @PROJECT_NAME@ +benchmark +.OP num_keys +.YS + +.SH DESCRIPTION + +performs a benchmark test, generating \fInum_keys\fR (default 1000) keys and measuring the time. + +.SH SECURITY NOTICE + +.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 +INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +.br +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +.br +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF +.br +CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE +.br +OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +.SH BUGS + +Report bugs to +.UR https://github.com/eosswedenorg/eosio-keygen/issues +Github +.UE . Thank you. + +.SH AUTHOR + +.MT henrik@eossweden.org +Henrik Hautakoski +.ME + +.UR https://eossweden.org +EOS Sw/eden +.UE \ No newline at end of file diff --git a/cli/docs/antelope-keygen-search.1.in b/cli/docs/antelope-keygen-search.1.in new file mode 100644 index 0000000..1ab0af3 --- /dev/null +++ b/cli/docs/antelope-keygen-search.1.in @@ -0,0 +1,112 @@ +.TH @PROJECT_NAME@-search 1 "April, 2023" "@PROJECT_NAME@-search @PROJECT_VERSION@" + +.SH NAME +@PROJECT_NAME@ search - Search after +.UR https://antelope.io +Antelope IO +.UE +vanity keys. + +.SH SYNOPSIS + +.SY @PROJECT_NAME@ +search +.OP \-h|--help +.YS + +.SY @PROJECT_NAME@ +search +.OP -m +.OP \--l33t +.OP \--threads +.OP \--dict ... +.OP \--lang ... +.B word_list +.OP count +.YS + +.SH DESCRIPTION + +.PP +performs a search, finding \fIcount\fR public keys containing one or more words from +\fIword_list\fR (separated with ','). +.PP +Instead of a list it is possible to specify a file with words (separated with newline \fB'\\n'\fR) using +\fIfile: and find all l33tspeak combinations of that word and uses the new list for the search. +.TP +\fB\-\-threads\fR \fInum\fR +Use <\fInum\fR> of parallel threads for searching. Default is what the operating system recommends. +.TP +\fB\-\-dict\fR \fIfile\fR +Use words found in \fIfile\fR (separated by newline) to highlight words in the keys found. +.br +There can be more then one \fB\-\-dict\fR flag. +In that case contents of all files are merged into one dictionary. +.br +\fBnote:\fR the words in this file are not used for search. only for highlight output. +.TP +\fB\-\-lang\fR \fIvalue\fR +Same as \fB\-\-dict\fR but will use \fIvalue\fR to find a file in +\fB@CMAKE_INSTALL_FULL_DATADIR@/@CMAKE_PROJECT_NAME@/dict\fR. +.br +There can be more then one \fB\-\-lang\fR flag. In that case contents of all files are merged into one dictionary. +.TP +\fBcount\fR +Number of keys to search for (default is 10) + +.SH SECURITY NOTICE + +.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 +INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +.br +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +.br +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF +.br +CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE +.br +OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +.SH BUGS + +Report bugs to +.UR https://github.com/eosswedenorg/eosio-keygen/issues +Github +.UE . Thank you. + +.SH AUTHOR + +.MT henrik@eossweden.org +Henrik Hautakoski +.ME + +.UR https://eossweden.org +EOS Sw/eden +.UE \ No newline at end of file