]> gitweb.fluxo.info Git - keyringer.git/commitdiff
Feat: docs: man page update with new actions and improvements
authorSilvio Rhatto <rhatto@riseup.net>
Sat, 25 Oct 2025 16:25:33 +0000 (13:25 -0300)
committerSilvio Rhatto <rhatto@riseup.net>
Sat, 25 Oct 2025 16:25:33 +0000 (13:25 -0300)
share/man/keyringer.1.md

index 8acd7474bb04533aff80ea45303b2446afabeac6..082999be2da5b08ad6b5c8c3ea6e83b57632ced0 100644 (file)
@@ -178,20 +178,34 @@ pwgen <*secret*> [*size*]
 
 recrypt <*secret*>
 :   Re-encrypts a secret by decrypting it and encrypting it again. Useful when users are added
-    into the recipient configuration. If no *secret* is given, all secrets in the repository
-    are re-encrypted.
+    into the recipient configuration.
 
-clip <*secret*>
+    If no *secret* is given, all secrets in the repository are re-encrypted.
+
+clip [*query*]
 :   Copy the first line of a secret to the clipboard, following password-store convention.
 
-xclip <*secret*>
-:   Alias to clip action.
+    If the query does not exactly match an existing secret, a interactive
+    prompt menu is shown, helping selecting the secret.
+
+xclip [*query*]
+:   Alias to the clip action.
+
+sclip [*query*]
+:   Invokes the clip action, sleeps five seconds, overwrite clipboard and exit.
+
+    If xdotool is available, it also switches to the next window using the
+    alt+Tab shortcut. This action is useful to be invoked by a custom key combo
+    in a window manager so it becomes easy to provide keyringer managed
+    passphrases to other applications such as a web browser.
+
+search [*query*]
+:   Similar to the clip action, but without showing the initial selection menu:
+    instead, it just shows a prompt if the query does not exactly match an
+    existing single.
 
-sclip <*secret*>
-:   Same as clip action, but sleeps five seconds, overwrite clipboard and exit. If xdotool
-    is available, it also switches to the next window using the alt+Tab shortcut. This action
-    is useful to be invoked by a custom key combo in a window manager so it becomes easy to
-    provide keyringer managed passphrases to other applications such as a web browser.
+ssearch [*query*]
+:   Like the the sclip action, but invokes the search instead of the clip action.
 
 # CONFIGURATION ACTIONS