aboutsummaryrefslogtreecommitdiffstats
path: root/dec.go
diff options
context:
space:
mode:
authorRose Hogenson <rosehogenson@posteo.net>2025-10-24 17:18:35 -0700
committerRose Hogenson <rosehogenson@posteo.net>2025-10-24 17:18:35 -0700
commit22300a4ed7e0d36c2fd749df2e70ed3f3bfff1c7 (patch)
treeee18d1b611804ec9ab379b75333191384ffdf78e /dec.go
parent0cd822566776eddf8e47e61b7279aff4fa5481d7 (diff)
downloadsym-22300a4ed7e0d36c2fd749df2e70ed3f3bfff1c7.tar.zst
Add in-tool documentation
Diffstat (limited to 'dec.go')
-rw-r--r--dec.go17
1 files changed, 17 insertions, 0 deletions
diff --git a/dec.go b/dec.go
index e67f4b3..d1404b7 100644
--- a/dec.go
+++ b/dec.go
@@ -22,6 +22,23 @@ type decryptFlags struct {
func (f *decryptFlags) registerFlags(fs *flag.FlagSet) {
fs.StringVar(&f.password, "p", "", "use the specified password; if not provided, dec will prompt for a password")
fs.BoolVar(&f.force, "f", false, "overwrite output files even if they already exist")
+ fs.Usage = func() {
+ fmt.Fprintf(fs.Output(), `usage: %s [OPTION]... [FILE]...
+Decrypt files, or stdin if no files are provided.
+
+`,
+ fs.Name())
+ fs.PrintDefaults()
+ fmt.Fprintf(fs.Output(), `-p is required when reading from stdin.
+
+For example,
+ %s my-encrypted-file.txt.enc
+would decrypt my-encrypted-file.txt.enc and write the result to
+my-encrypted-file.txt. If a filename does not end with .enc, the name
+will be appended with a .dec extension.
+`,
+ fs.Name())
+ }
}
type decryptOptions struct {