Merge pull request #588 from smallstep/max/arg-consistency

consistency for <crt-file> positional arg in cert subcommand

command/certificate/bundle.go

@@ -18,19 +18,19 @@ func bundleCommand() cli.Command {
 		Name:      "bundle",
 		Action:    command.ActionFunc(bundleAction),
 		Usage:     `bundle a certificate with intermediate certificate(s) needed for certificate path validation`,
-		UsageText: `**step certificate bundle** <crt_file> <ca> <bundle_file>`,
+		UsageText: `**step certificate bundle** <crt-file> <ca> <bundle-file>`,
 		Description: `**step certificate bundle** bundles a certificate
 		with any intermediates necessary to validate the certificate.
 
 ## POSITIONAL ARGUMENTS
 
-<crt_file>
+<crt-file>
 : The path to a leaf certificate to bundle with issuing certificate(s).
 
 <ca>
 : The path to the Certificate Authority issusing certificate.
 
-<bundle_file>
+<bundle-file>
 : The path to write the bundle.
 
 ## EXIT CODES

command/certificate/create.go

@@ -59,10 +59,10 @@ you need something else, you can customize the output using templates. See **TEM
 <subject>
 : The subject of the certificate. Typically this is a hostname for services or an email address for people.
 
-<crt_file>
+<crt-file>
 : File to write CRT or CSR to (PEM format)
 
-<key_file>
+<key-file>
 : File to write private key to (PEM format). This argument is optional if **--key** is passed.
 
 ## EXIT CODES

command/certificate/format.go

@@ -20,15 +20,15 @@ func formatCommand() cli.Command {
 		Name:      "format",
 		Action:    command.ActionFunc(formatAction),
 		Usage:     `reformat certificate`,
-		UsageText: `**step certificate format** <crt_file> [**--out**=<file>]`,
+		UsageText: `**step certificate format** <crt-file> [**--out**=<file>]`,
 		Description: `**step certificate format** prints the certificate or CSR in a different format.
 
 Only 2 formats are currently supported; PEM and ASN.1 DER. This tool will convert
 a certificate or CSR in one format to the other.
 
 ## POSITIONAL ARGUMENTS
 
-<crt_file>
+<crt-file>
 :  Path to a certificate or CSR file.
 
 ## EXIT CODES

command/certificate/inspect.go

@@ -23,7 +23,7 @@ func inspectCommand() cli.Command {
 		Name:   "inspect",
 		Action: cli.ActionFunc(inspectAction),
 		Usage:  `print certificate or CSR details in human readable format`,
-		UsageText: `**step certificate inspect** <crt_file>
+		UsageText: `**step certificate inspect** <crt-file>
 [**--bundle**] [**--short**] [**--format**=<format>] [**--roots**=<root-bundle>]
 [**--servername**=<servername>]`,
 		Description: `**step certificate inspect** prints the details of a certificate
@@ -32,14 +32,14 @@ STDERR instead of STDOUT. This is an intentional barrier to accidental
 misuse: scripts should never rely on the contents of an unvalidated certificate.
 For scripting purposes, use **step certificate verify**.
 
-If crt_file contains multiple certificates (i.e., it is a certificate "bundle")
+If crt-file contains multiple certificates (i.e., it is a certificate "bundle")
 the first certificate in the bundle will be output. Pass the --bundle option to
 print all certificates in the order in which they appear in the bundle.
 
 ## POSITIONAL ARGUMENTS
 
-<crt_file>
-:  Path to a certificate or certificate signing request (CSR) to inspect. A hyphen ("-") indicates STDIN as <crt_file>.
+<crt-file>
+:  Path to a certificate or certificate signing request (CSR) to inspect. A hyphen ("-") indicates STDIN as <crt-file>.
 
 ## EXIT CODES
 

command/certificate/lint.go

@@ -18,14 +18,14 @@ func lintCommand() cli.Command {
 		Name:   "lint",
 		Action: cli.ActionFunc(lintAction),
 		Usage:  `lint certificate details`,
-		UsageText: `**step certificate lint** <crt_file> [**--roots**=<root-bundle>]
+		UsageText: `**step certificate lint** <crt-file> [**--roots**=<root-bundle>]
 [**--servername**=<servername>]`,
 		Description: `**step certificate lint** checks a certificate for common
 errors and outputs the result in JSON format.
 
 ## POSITIONAL ARGUMENTS
 
-<crt_file>
+<crt-file>
 :  Path to a certificate or certificate signing request (CSR) to lint.
 
 ## EXIT CODES

command/certificate/sign.go

@@ -36,7 +36,7 @@ func signCommand() cli.Command {
 		Name:   "sign",
 		Action: cli.ActionFunc(signAction),
 		Usage:  "sign a certificate signing request (CSR)",
-		UsageText: `**step certificate sign** <csr_file> <crt_file> <key_file>
+		UsageText: `**step certificate sign** <csr-file> <crt-file> <key-file>
 [**--profile**=<profile>] [**--template**=<file>]
 [**--password-file**=<file>] [**--path-len**=<maximum>]
 [**--not-before**=<time|duration>] [**--not-after**=<time|duration>]
@@ -46,13 +46,13 @@ certificate from a certificate signing request (CSR).
 
 ## POSITIONAL ARGUMENTS
 
-<csr_file>
+<csr-file>
 : The path to a certificate signing request (CSR) to be signed.
 
-<crt_file>
+<crt-file>
 : The path to an issuing certificate.
 
-<key_file>
+<key-file>
 : The path to a private key for signing the CSR.
 
 ## EXIT CODES

command/certificate/verify.go

@@ -17,7 +17,7 @@ func verifyCommand() cli.Command {
 		Name:   "verify",
 		Action: cli.ActionFunc(verifyAction),
 		Usage:  `verify a certificate`,
-		UsageText: `**step certificate verify** <crt_file> [**--host**=<host>]
+		UsageText: `**step certificate verify** <crt-file> [**--host**=<host>]
 [**--roots**=<root-bundle>] [**--servername**=<servername>]`,
 		Description: `**step certificate verify** executes the certificate path
 validation algorithm for x.509 certificates defined in RFC 5280. If the
@@ -26,7 +26,7 @@ an error occurs, this command will produce a non-zero return value.
 
 ## POSITIONAL ARGUMENTS
 
-<crt_file>
+<crt-file>
 : The path to a certificate to validate.
 
 ## EXIT CODES