Merge pull request #888 from louib/feature_keepassxc_cli_manpage

Adding manpage for keepassxc-cli

src/cli/CMakeLists.txt

@@ -47,3 +47,8 @@ target_link_libraries(keepassxc-cli
 install(TARGETS keepassxc-cli
         BUNDLE DESTINATION . COMPONENT Runtime
         RUNTIME DESTINATION ${CLI_INSTALL_DIR} COMPONENT Runtime)
+
+if(APPLE OR UNIX)
+    install(FILES keepassxc-cli.1 DESTINATION /usr/local/share/man/man1/)
+    execute_process(COMMAND mandb -q)
+endif()

src/cli/keepassxc-cli.1

@@ -0,0 +1,58 @@
+.TH KEEPASSXC-CLI 1 "Aug 22, 2017"
+
+.SH NAME
+keepassxc-cli \- command line interface for the \fBKeePassXC\fP password manager.
+
+.SH SYNOPSIS
+.B keepassxc-cli
+.RI [ options ]
+.I command
+
+.SH DESCRIPTION
+\fBkeepassxc-cli\fP is the command line interface for the \fBKeePassXC\fP password manager. It provides the ability of listing the entries of a database, displaying the contents of an entry and many more, directly from the command line.
+
+.SH COMMANDS
+
+.IP "clip [options] <database> <entry> [timeout]"
+Copies the password of a database entry to the clipboard. If multiple entries with the same name exist in different groups, only the password for the first one is going to be copied. For copying the password of an entry in a specific group, the group path to the entry should be specified as well, instead of just the name. Optionally, a timeout in seconds can be specified to automatically clear the clipboard.
+
+.IP "entropy-meter [-a pwd1 pwd2 ...]"
+Calculates the entropy of a single, or multiple passwords specified using the \fI-a\fP option. If no passwords are specified, the program will run in interactive mode and prompt the user to enter a password.
+
+.IP "extract [options] <database>"
+Extracts and prints the contents of a database to standard output in XML format.
+
+.IP "locate [options] <database> <term>"
+Locates all the entries that match a specific search term in a database.
+
+.IP "ls [options] <database> [group]"
+Lists the contents of a group in a database. If no group is specified, it will default to the root group.
+
+.IP "merge [options] <database1> <database2>"
+Merges two databases together. The first database file is going to be replaced by the result of the merge, for that reason it is advisable to keep a backup of the two database files before attempting a merge. In the case that both databases make use of the same credentials, the \fI--same-credentials\fP or \fI-s\fP option can be used.
+
+.IP "show [options] <database> <entry>"
+Shows the title, username, password, URL and notes of a database entry. Regarding the occurrence of multiple entries with the same name in different groups, everything stated in the \fIclip\fP command section also applies here.
+
+.SH OPTIONS
+
+.IP "-k, --key-file <path>"
+Specifies a path to a key file for unlocking the database. In a merge operation this option is used to specify the key file path for the first database.
+
+.IP "-f, --key-file-from <path>"
+Specifies a path to a key file for the second database in a merge operation.
+
+.IP "-s, --same-credentials"
+Tells the program to use the same credentials for unlocking both of the database files in a merge operation.
+
+.IP "-h, --help"
+Displays help information.
+
+.IP "-v, --version"
+Shows the program version.
+
+.SH REPORTING BUGS
+Bugs and feature requests can be reported on GitHub at https://github.com/keepassxreboot/keepassxc/issues.
+
+.SH AUTHOR
+This manual page was written by Manolis Agkopian <m.agkopian@gmail.com>.