Skip to content

Commit f1bfab8

Browse files
committed
📝 doc: change help message
1 parent 093fef5 commit f1bfab8

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ Usage:
1313
Application Options:
1414

1515
```
16-
-h, --help print help and exit
17-
-v, --version print version and exit
18-
-u, --public=<target> github account, url or file
19-
-k, --private=<id_file> ssh private file
20-
-i, --input=<input_file> the path of the file to read
21-
-o, --output=<output_file> the path of the file to write
22-
-d, --decrypt decryption mode
16+
-h, --help print help and exit.
17+
-v, --version print version and exit.
18+
-u, --public=<target> github account, url or file.
19+
-k, --private=<id_file> ssh private file.
20+
-i, --input=<input_file> the path of the file to read. default: stdin
21+
-o, --output=<output_file> the path of the file to write. default: stdout
22+
-d, --decrypt decryption mode.
2323
```
2424

2525
## Supported algorithms

main.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,14 @@ func getVersion() string {
6868

6969
// ref. https://pkg.go.dev/github.com/jessevdk/go-flags
7070
type Options struct {
71-
Help bool `short:"h" long:"help" description:"print help and exit"`
72-
Version bool `short:"v" long:"version" description:"print version and exit"`
71+
Help bool `short:"h" long:"help" description:"print help and exit."`
72+
Version bool `short:"v" long:"version" description:"print version and exit."`
7373
VersionAll bool `short:"V" long:"version-all" hidden:"yes"`
74-
PublicKey string `short:"u" long:"public" value-name:"<target>" description:"github account, url or file"`
75-
PrivateKey string `short:"k" long:"private" value-name:"<id_file>" description:"ssh private file"`
76-
InputPath string `short:"i" long:"input" value-name:"<input_file>" description:"the path of the file to read"`
77-
OutputPath string `short:"o" long:"output" value-name:"<output_file>" description:"the path of the file to write"`
78-
Decrypt bool `short:"d" long:"decrypt" description:"decryption mode"`
74+
PublicKey string `short:"u" long:"public" value-name:"<target>" description:"github account, url or file."`
75+
PrivateKey string `short:"k" long:"private" value-name:"<id_file>" description:"ssh private file."`
76+
InputPath string `short:"i" long:"input" value-name:"<input_file>" description:"the path of the file to read. default: stdin"`
77+
OutputPath string `short:"o" long:"output" value-name:"<output_file>" description:"the path of the file to write. default: stdout"`
78+
Decrypt bool `short:"d" long:"decrypt" description:"decryption mode."`
7979
}
8080

8181
func getOpts() Options {

0 commit comments

Comments
 (0)