Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add keepassxc man page and move cli man page to share folder #3665

Merged
merged 1 commit into from Oct 25, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion src/cli/keepassxc-cli.1 → share/docs/man/keepassxc-cli.1
Expand Up @@ -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.
Expand Down
39 changes: 39 additions & 0 deletions 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 <config>"
Path to a custom config file

.IP "--keyfile <keyfile>"
Key file of the database

.IP "--pw-stdin"
Read password of the database from stdin

.IP "--pw, --parent-window <handle>"
Parent window handle

.IP "--debug-info"
Displays debugging information.

.SH AUTHOR
This manual page is maintained by the KeePassXC Team <team@keepassxc.org>.
4 changes: 4 additions & 0 deletions src/CMakeLists.txt
Expand Up @@ -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")
Expand Down
2 changes: 1 addition & 1 deletion src/cli/CMakeLists.txt
Expand Up @@ -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()