summaryrefslogtreecommitdiff
path: root/share
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2014-02-20 11:10:23 -0300
committerSilvio Rhatto <rhatto@riseup.net>2014-02-20 11:10:23 -0300
commitefaacc68a2539cf57fdba395598f708d366cabc9 (patch)
tree3235b55b52df00c14ab99be9eb2255e3110b860b /share
parent10ec7a4f87812576f6bf3543282b49030ba77e64 (diff)
parent4b4aff2edac956224849d36fe83f826303d25efd (diff)
downloadkeyringer-efaacc68a2539cf57fdba395598f708d366cabc9.tar.gz
keyringer-efaacc68a2539cf57fdba395598f708d366cabc9.tar.bz2
Merge tag 'upstream_keyringer_0.3' into debian
Upstream version 0.3
Diffstat (limited to 'share')
-rw-r--r--share/man/keyringer.155
-rw-r--r--share/man/keyringer.1.mdwn35
2 files changed, 90 insertions, 0 deletions
diff --git a/share/man/keyringer.1 b/share/man/keyringer.1
index c0fed1c..8402b9c 100644
--- a/share/man/keyringer.1
+++ b/share/man/keyringer.1
@@ -31,6 +31,11 @@ and other read/write operations on secrets.
Configuration actions, handling repository metadata.
.SH REPOSITORY LOOKUP AND MANIPULATION ACTIONS
.TP
+.B find <\f[I]expression\f[]>
+Find secrets in the repository.
+.RS
+.RE
+.TP
.B init <\f[I]path\f[]> [\f[I]remote\f[]]
Initialize a new keyringer repository.
If a \f[I]remote\f[] URL is specified, keyringer will clone an existing
@@ -60,6 +65,16 @@ command.
.RS
.RE
.TP
+.B mkdir <\f[I]path\f[]>
+Create a directory inside the repository \f[I]keys\f[] folder.
+.RS
+.RE
+.TP
+.B :rmdir <\f[I]path\f[]>
+Remove an empty folder inside the repository \f[I]keys\f[] folder.
+.RS
+.RE
+.TP
.B tree <\f[I]path\f[]>
List contents from the toplevel repository \f[I]keys\f[] folder or from
relative paths if \f[I]path\f[] is specified using a tree-like format.
@@ -67,6 +82,25 @@ Like the ls wrapper, this is a wrapper around the \f[I]TREE(1)\f[]
command.
.RS
.RE
+.TP
+.B shell
+Run keyringer on interactive mode from a built-in command-line prompt
+where all other actions can be called and are operated from the current
+selected keyring.
+.RS
+.PP
+An additional "cd" internal command is available for directory
+navigation.
+.PP
+All <\f[I]secret\f[]> parameters from actions invoked from the shell are
+called relatively from the current selected directory.
+.RE
+.TP
+.B teardown
+Remove permanently a local copy of a repository, very dangerous if you
+have just a single copy.
+.RS
+.RE
.SH SECRET MANIPULATION ACTIONS
.PP
All secret manipulation actions operate upon a \f[I]secret\f[] which is
@@ -115,6 +149,11 @@ Alias for \f[I]del\f[] action.
.RS
.RE
.TP
+.B mv <\f[I]secret\f[]> <\f[I]dest\f[]>
+Rename a secret.
+.RS
+.RE
+.TP
.B edit <\f[I]secret\f[]>
Edit a secret by temporarily decrypting it, opening the decrypted copy
into the text editor defined by the \f[I]$EDITOR\f[] environment
@@ -162,6 +201,17 @@ If no \f[I]secret\f[] is given, all secrets in the repository are
re-encrypted.
.RS
.RE
+.TP
+.B clip <\f[I]secret\f[]>
+Copy the first line of a secret to the clipboard, following
+password-store convention.
+.RS
+.RE
+.TP
+.B xclip <\f[I]secret\f[]>
+Alis to clip action.
+.RS
+.RE
.SH CONFIGURATION ACTIONS
.TP
.B commands
@@ -200,6 +250,11 @@ Show keyringer usage information.
.RS
.RE
.TP
+.B help
+Alias for usage action.
+.RS
+.RE
+.TP
.B recipients <\f[I]ls\f[]|\f[I]edit\f[]> <\f[I]recipients-file\f[]>
List, create or edit recipients configuration.
.RS
diff --git a/share/man/keyringer.1.mdwn b/share/man/keyringer.1.mdwn
index d4b71e3..e8df829 100644
--- a/share/man/keyringer.1.mdwn
+++ b/share/man/keyringer.1.mdwn
@@ -37,6 +37,9 @@ Keyringer has three types of actions:
# REPOSITORY LOOKUP AND MANIPULATION ACTIONS
+find <*expression*>
+: Find secrets in the repository.
+
init <*path*> [*remote*]
: Initialize a new keyringer repository. If a *remote* URL is specified, keyringer will
clone an existing repository.
@@ -56,11 +59,31 @@ ls <*path*>
if *path* is specified. Like the git wrapper, this is a wrapper around the *LS(1)*
command.
+mkdir <*path*>
+: Create a directory inside the repository *keys* folder.
+
+:rmdir <*path*>
+: Remove an empty folder inside the repository *keys* folder.
+
tree <*path*>
: List contents from the toplevel repository *keys* folder or from relative paths
if *path* is specified using a tree-like format. Like the ls wrapper, this is a
wrapper around the *TREE(1)* command.
+shell
+: Run keyringer on interactive mode from a built-in command-line prompt where
+ all other actions can be called and are operated from the current selected
+ keyring.
+
+ An additional "cd" internal command is available for directory navigation.
+
+ All <*secret*> parameters from actions invoked from the shell are called
+ relatively from the current selected directory.
+
+teardown
+: Remove permanently a local copy of a repository, very dangerous if you
+ have just a single copy.
+
# SECRET MANIPULATION ACTIONS
All secret manipulation actions operate upon a *secret* which is the pathname
@@ -96,6 +119,9 @@ del <*secret*>
rm <*secret*>
: Alias for *del* action.
+mv <*secret*> <*dest*>
+: Rename a secret.
+
edit <*secret*>
: Edit a secret by temporarily decrypting it, opening the decrypted copy into the
text editor defined by the *$EDITOR* environment variable and then re-encrypting it.
@@ -124,6 +150,12 @@ recrypt <*secret*>
into the recipient configuration. If no *secret* is given, all secrets in the repository
are re-encrypted.
+clip <*secret*>
+: Copy the first line of a secret to the clipboard, following password-store convention.
+
+xclip <*secret*>
+: Alis to clip action.
+
# CONFIGURATION ACTIONS
commands
@@ -151,6 +183,9 @@ preferences <*ls*|*edit*|*add*>
usage
: Show keyringer usage information.
+help
+: Alias for usage action.
+
recipients <*ls*|*edit*> <*recipients-file*>
: List, create or edit recipients configuration.