Merge branch 'man-page' into develop

CMakeLists.txt

@@ -100,6 +100,12 @@ endif (WIN32)
 install(FILES README.md LICENSE LICENSE.bitcoin
 		DESTINATION ${CMAKE_INSTALL_DATADIR}/${CMAKE_PROJECT_NAME})
 
+configure_file( docs/eosio-keygen.1.in
+				${PROJECT_BINARY_DIR}/man1/eosio-keygen.1 )
+
+install(DIRECTORY ${PROJECT_BINARY_DIR}/man1
+		DESTINATION ${CMAKE_INSTALL_MANDIR})
+
 # --------------------------------
 #  Debian package script
 # --------------------------------

docs/eosio-keygen.1.in

@@ -0,0 +1,120 @@
+.TH @PROJECT_NAME@ 1 "January, 2020" "@PROJECT_NAME@ @PROJECT_VERSION@"
+
+.SH NAME
+@PROJECT_NAME@ - Generate public and private keypair for
+.UR https://eos.io/
+EOS
+.UE .
+
+.SH SYNOPSIS
+
+.SY @PROJECT_NAME@
+.OP \-h|--help
+.YS
+
+.SY @PROJECT_NAME@
+search
+.OP \--l33t
+.OP \--threads=<num>
+.B word_list
+.OP count
+.YS
+
+.SY @PROJECT_NAME@
+benchmark
+.OP num_keys
+.YS
+
+.SH DESCRIPTION
+.P
+Output one EOSIO key pair if no arguments are given
+.P
+Options and subcommands are as follows:
+
+.TP 15
+.B -h, --help
+Shows this help text.
+.TP 15
+.B search
+performs a search, finding
+.I <count>
+public keys containing one or more words from
+.I <word_list>
+(separated with ',').
+.PP
+.RS 16
+Search specific options:
+.RS 2
+.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 recomends.
+.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
+
+
+.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.
+.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

scripts/generate_deb.sh.in

@@ -8,6 +8,7 @@ PACKAGE_DESCRIPTION="Keygenerator for EOSIO"
 PACKAGE_PREFIX=$(echo "@CMAKE_INSTALL_PREFIX@" | sed -E 's~^/~~')
 PACKAGE_BINDIR="@CMAKE_INSTALL_BINDIR@"
 PACKAGE_SHAREDIR="@CMAKE_INSTALL_DATADIR@/@CMAKE_PROJECT_NAME@"
+PACKAGE_MANDIR="@CMAKE_INSTALL_MANDIR@"
 PACKAGE_TMPDIR="tmp/debroot"
 
 if [[ -f /etc/upstream-release/lsb-release ]]; then
@@ -46,8 +47,10 @@ cat ${BASE_DIR}/${PACKAGE_TMPDIR}/DEBIAN/control
 
 mkdir -p ${BASE_DIR}/${PACKAGE_TMPDIR}/${PACKAGE_PREFIX}/${PACKAGE_BINDIR}
 mkdir -p ${BASE_DIR}/${PACKAGE_TMPDIR}/${PACKAGE_PREFIX}/${PACKAGE_SHAREDIR}
+mkdir -p ${BASE_DIR}/${PACKAGE_TMPDIR}/${PACKAGE_PREFIX}/${PACKAGE_MANDIR}
 
 cp ${BASE_DIR}/${PACKAGE_NAME} ${BASE_DIR}/${PACKAGE_TMPDIR}/${PACKAGE_PREFIX}/${PACKAGE_BINDIR}/${PACKAGE_NAME}
+cp -r ${BASE_DIR}/man1 ${BASE_DIR}/${PACKAGE_TMPDIR}/${PACKAGE_PREFIX}/${PACKAGE_MANDIR}
 
 for file in README.md LICENSE LICENSE.bitcoin ; do
     cp ${BASE_DIR}/../${file} ${BASE_DIR}/${PACKAGE_TMPDIR}/${PACKAGE_PREFIX}/${PACKAGE_SHAREDIR}