Improve README and show_usage
This commit is contained in:
parent
5f27702f17
commit
047c6e334a
|
@ -67,7 +67,7 @@ Usage: shellpki <subcommand> [options] [CommonName]
|
|||
Initialize PKI (create CA key and self-signed certificate) :
|
||||
|
||||
~~~
|
||||
shellpki init <commonName_for_CA>
|
||||
shellpki init [options] <commonName_for_CA>
|
||||
|
||||
Options
|
||||
--non-interactive do not prompt the user, and exit if an error occurs
|
||||
|
@ -76,14 +76,14 @@ Options
|
|||
Create a client certificate with key and CSR directly generated on server :
|
||||
|
||||
~~~
|
||||
shellpki create <commonName>
|
||||
shellpki create [options] <commonName>
|
||||
|
||||
Options
|
||||
-f, --file, --csr-file create a client certificate from a CSR (doesn't need key)
|
||||
-p, --password prompt the user for a password to set on the client key
|
||||
--password-file if provided with a path to a readable file, the first line is read and set as password on the client key
|
||||
--days specify how many days the certificate should be valid
|
||||
--end-date specify until which date the certificate should be valid, in MM/DD/[YY]YY [hh:mm:ss] format
|
||||
--end-date specify until which date the certificate should be valid, in MM/DD/YYYY hh:mm:ss format
|
||||
--non-interactive do not prompt the user, and exit if an error occurs
|
||||
--replace-existing if the certificate already exists, revoke it before creating a new one
|
||||
~~~
|
||||
|
@ -91,7 +91,7 @@ Options
|
|||
Revoke a client certificate :
|
||||
|
||||
~~~
|
||||
shellpki revoke <commonName>
|
||||
shellpki revoke [options] <commonName>
|
||||
|
||||
Options
|
||||
--non-interactive do not prompt the user, and exit if an error occurs
|
||||
|
|
7
shellpki
7
shellpki
|
@ -31,17 +31,18 @@ END
|
|||
show_usage() {
|
||||
cat <<EOF
|
||||
Usage: ${0} <subcommand> [options] [CommonName]
|
||||
Warning: [options] always must be before [CommonName] and after <subcommand>
|
||||
|
||||
Initialize PKI (create CA key and self-signed certificate) :
|
||||
|
||||
${0} init <commonName_for_CA>
|
||||
${0} init [options] <commonName_for_CA>
|
||||
|
||||
Options
|
||||
--non-interactive do not prompt the user, and exit if an error occurs
|
||||
|
||||
Create a client certificate with key and CSR directly generated on server :
|
||||
|
||||
${0} create <commonName>
|
||||
${0} create [options] <commonName>
|
||||
|
||||
Options
|
||||
-f, --file, --csr-file create a client certificate from a CSR (doesn't need key)
|
||||
|
@ -54,7 +55,7 @@ Create a client certificate with key and CSR directly generated on server :
|
|||
|
||||
Revoke a client certificate :
|
||||
|
||||
${0} revoke <commonName>
|
||||
${0} revoke [options] <commonName>
|
||||
|
||||
Options
|
||||
--non-interactive do not prompt the user, and exit if an error occurs
|
||||
|
|
Loading…
Reference in New Issue