aboutsummaryrefslogtreecommitdiff
path: root/bin/grun
diff options
context:
space:
mode:
authorEuAndreh <eu@euandre.org>2023-04-12 08:15:20 -0300
committerEuAndreh <eu@euandre.org>2023-04-12 08:15:20 -0300
commitc6188975d2da6c1696c4433f6fce8ae4c9a6ac38 (patch)
tree613545634bc999385d13ecb107d2cce113ba11c4 /bin/grun
parentbin/: Add trailing semicolor to Perl heredocs (diff)
downloaddotfiles-c6188975d2da6c1696c4433f6fce8ae4c9a6ac38.tar.gz
dotfiles-c6188975d2da6c1696c4433f6fce8ae4c9a6ac38.tar.xz
bin/: Make help string more consistent across several executables
Diffstat (limited to 'bin/grun')
-rwxr-xr-xbin/grun11
1 files changed, 8 insertions, 3 deletions
diff --git a/bin/grun b/bin/grun
index e9cfebe..5bae057 100755
--- a/bin/grun
+++ b/bin/grun
@@ -12,6 +12,7 @@ usage() {
help() {
cat <<-'EOF'
+
Options:
-r RECIPIENT the recipient to encrypt to. Can be provided
multiple times for multiple recipients.
@@ -23,18 +24,22 @@ help() {
FILENAME The GPG-encrypted file to be processed. If it
doesn't exist yet, it will be created.
+
+ Edit the encripted FILENAME in a pipeline, using COMMAND to
+ modify the content. If COMMAND emits a non-zero return code,
+ the file is left unmodified.
+
+
Examples:
Edit "secrets.txt.gpg" using `vipe` and the default recipient:
$ grun secrets.txt.gpg -- vipe
+
Delete lines containing "TODO" in todos.gpg for specific keys:
$ grun -r ABC123DEF321 todos.gpg -- sed '/TODO/d'
-
- If COMMAND emits a non-zero return code, the file is left
- unmodified.
EOF
}