From 65ef8c266c97bf5480e89f5cee49346078f99d4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20H=C3=B6ltje?= Date: Thu, 2 Nov 2017 15:17:02 -0400 Subject: [PATCH] readme: fix formatting of listing --- govc/README.md | 52 ++++++++++++++++++++++++++++---------------------- 1 file changed, 29 insertions(+), 23 deletions(-) diff --git a/govc/README.md b/govc/README.md index 8dc08dc2a..a1b27d808 100644 --- a/govc/README.md +++ b/govc/README.md @@ -54,15 +54,15 @@ to set defaults: * `GOVC_URL`: URL of ESXi or vCenter instance to connect to. - > The URL scheme defaults to `https` and the URL path defaults to `/sdk`. - > This means that specifying `user:pass@host` is equivalent to - > `https://user:pass@host/sdk`. + The URL scheme defaults to `https` and the URL path defaults to `/sdk`. + This means that specifying `user:pass@host` is equivalent to + `https://user:pass@host/sdk`. - > If password include special characters like `#` or `:` you can use - > `GOVC_USERNAME` and `GOVC_PASSWORD` to have a simple `GOVC_URL` + If password include special characters like `#` or `:` you can use + `GOVC_USERNAME` and `GOVC_PASSWORD` to have a simple `GOVC_URL` - > When using govc against VMware Workstation, GOVC_URL can be set to "localhost" - > without a user or pass, in which case local ticket based authentication is used. + When using govc against VMware Workstation, GOVC_URL can be set to "localhost" + without a user or pass, in which case local ticket based authentication is used. * `GOVC_USERNAME`: USERNAME to use if not specified in GOVC_URL. @@ -70,30 +70,36 @@ to set defaults: * `GOVC_TLS_CA_CERTS`: Override system root certificate authorities. - > export GOVC_TLS_CA_CERTS=~/.govc_ca.crt - > Use path separator to specify multiple files: - > export GOVC_TLS_CA_CERTS=~/ca-certificates/bar.crt:~/ca-certificates/foo.crt + ``` console + $ export GOVC_TLS_CA_CERTS=~/.govc_ca.crt + # Use path separator to specify multiple files: + $ export GOVC_TLS_CA_CERTS=~/ca-certificates/bar.crt:~/ca-certificates/foo.crt + ``` * `GOVC_TLS_KNOWN_HOSTS`: File(s) for thumbprint based certificate verification. - > Thumbprint based verification can be used in addition to or as an alternative to - > GOVC_TLS_CA_CERTS for self-signed certificates. Example: - > export GOVC_TLS_KNOWN_HOSTS=~/.govc_known_hosts - > govc about.cert -u host -k -thumbprint | tee -a $GOVC_TLS_KNOWN_HOSTS - > govc about -u user:pass@host + ``` console + # Thumbprint based verification can be used in addition to or as an alternative to + $ GOVC_TLS_CA_CERTS for self-signed certificates. Example: + $ export GOVC_TLS_KNOWN_HOSTS=~/.govc_known_hosts + $ govc about.cert -u host -k -thumbprint | tee -a $GOVC_TLS_KNOWN_HOSTS + $ govc about -u user:pass@host + ``` * `GOVC_TLS_HANDSHAKE_TIMEOUT`: Limits the time spent performing the TLS handshake. * `GOVC_INSECURE`: Disable certificate verification. - > This option sets Go's tls.Config.InsecureSkipVerify flag and is false by default. - > Quoting https://golang.org/pkg/crypto/tls/#Config: - > > InsecureSkipVerify controls whether a client verifies the - > > server's certificate chain and host name. - > > If InsecureSkipVerify is true, TLS accepts any certificate - > > presented by the server and any host name in that certificate. - > > In this mode, TLS is susceptible to man-in-the-middle attacks. - > > This should be used only for testing. + This option sets Go's `tls.Config.InsecureSkipVerify` flag and is false by default. + Quoting https://golang.org/pkg/crypto/tls/#Config: + > `InsecureSkipVerify` controls whether a client verifies the + > server's certificate chain and host name. + > + > If `InsecureSkipVerify` is true, TLS accepts any certificate + > presented by the server and any host name in that certificate. + > + > In this mode, TLS is susceptible to man-in-the-middle attacks. + > This should be used only for testing. * `GOVC_DATACENTER`