From 24054988f49b7f8d041318f451d3b55f016961d8 Mon Sep 17 00:00:00 2001 From: Janek Bevendorff Date: Fri, 25 Oct 2019 18:44:44 +0200 Subject: [PATCH] Add keepassxc man page and move cli man page to share folder --- README.md | 2 +- {src/cli => share/docs/man}/keepassxc-cli.1 | 4 ++- share/docs/man/keepassxc.1 | 39 +++++++++++++++++++++ src/CMakeLists.txt | 4 +++ src/cli/CMakeLists.txt | 2 +- 5 files changed, 48 insertions(+), 3 deletions(-) rename {src/cli => share/docs/man}/keepassxc-cli.1 (99%) create mode 100644 share/docs/man/keepassxc.1 diff --git a/README.md b/README.md index d7c62a7a5a..a8ca4c4d48 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ so please check out your distribution's package list to see if KeePassXC is avai - YubiKey challenge-response support - TOTP generation - CSV import -- A [Command Line Interface (keepassxc-cli)](./src/cli/keepassxc-cli.1) +- A [Command Line Interface (keepassxc-cli)](./share/docs/man/keepassxc-cli.1) - DEP and ASLR hardening - Stand-alone password and passphrase generator - Password strength meter diff --git a/src/cli/keepassxc-cli.1 b/share/docs/man/keepassxc-cli.1 similarity index 99% rename from src/cli/keepassxc-cli.1 rename to share/docs/man/keepassxc-cli.1 index c22e7e73ec..15d0fedc1f 100644 --- a/src/cli/keepassxc-cli.1 +++ b/share/docs/man/keepassxc-cli.1 @@ -6,7 +6,9 @@ keepassxc-cli \- command line interface for the \fBKeePassXC\fP password manager .SH SYNOPSIS .B keepassxc-cli .I command -.RI [ options ] +.B [ +-I options +.B ] .SH DESCRIPTION \fBkeepassxc-cli\fP is the command line interface for the \fBKeePassXC\fP password manager. It provides the ability to query and modify the entries of a KeePass database, directly from the command line. diff --git a/share/docs/man/keepassxc.1 b/share/docs/man/keepassxc.1 new file mode 100644 index 0000000000..74a9b02a68 --- /dev/null +++ b/share/docs/man/keepassxc.1 @@ -0,0 +1,39 @@ +.TH KEEPASSXC 1 "Oct 25, 2019" +.SH NAME +keepassxc \- password manager + +.SH SYNOPSIS +.B keepassxc +.B [ +.I options +.B ] [ +.I filename(s) +.B ] + +.SH DESCRIPTION +\fBKeePassXC\fP is a free/open-source password manager or safe which helps you to manage your passwords in a secure way. The complete database is always encrypted with the industry-standard AES (alias Rijndael) encryption algorithm using a 256 bit key. KeePassXC uses a database format that is compatible with KeePass Password Safe. Your wallet works offline and requires no Internet connection. + +.SH OPTIONS +.IP "-h, --help" +Displays this help. + +.IP "-v, --version" +Displays version information. + +.IP "--config " +Path to a custom config file + +.IP "--keyfile " +Key file of the database + +.IP "--pw-stdin" +Read password of the database from stdin + +.IP "--pw, --parent-window " +Parent window handle + +.IP "--debug-info" +Displays debugging information. + +.SH AUTHOR +This manual page is maintained by the KeePassXC Team . diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 77acf290ea..0e3bca7af8 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -389,6 +389,10 @@ install(TARGETS ${PROGNAME} BUNDLE DESTINATION . COMPONENT Runtime RUNTIME DESTINATION ${BIN_INSTALL_DIR} COMPONENT Runtime) +if(APPLE OR UNIX) + install(FILES ../share/docs/man/keepassxc.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1/) +endif() + if(MINGW) if(${CMAKE_SIZEOF_VOID_P} EQUAL "8") set(OUTPUT_FILE_POSTFIX "Win64") diff --git a/src/cli/CMakeLists.txt b/src/cli/CMakeLists.txt index 9ae438db21..f5c90df8d1 100644 --- a/src/cli/CMakeLists.txt +++ b/src/cli/CMakeLists.txt @@ -119,5 +119,5 @@ if(APPLE AND WITH_APP_BUNDLE) endif() if(APPLE OR UNIX) - install(FILES keepassxc-cli.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1/) + install(FILES ../../share/docs/man/keepassxc-cli.1 DESTINATION ${CMAKE_INSTALL_MANDIR}/man1/) endif()