diff options
author | Richard Levitte <levitte@openssl.org> | 2019-10-01 19:43:36 +0200 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2019-10-09 10:44:32 +0200 |
commit | 35a810bb1d6af5a71170c5c4b506f7665d573a3e (patch) | |
tree | cc1b6aff27a2680f956ace2adf5331367970be52 /doc/man1/openssl-tsget.pod | |
parent | 2f0ea9365806895c313b6d8e2ce33428260e856c (diff) |
Command docs: fix up command references
Almost all OpenSSL commands are in reality 'openssl cmd', so make sure
they are refered to like that and not just as the sub-command.
Self-references are avoided as much as is possible, and replaced with
"this command". In some cases, we even avoid that with a slight
rewrite of the sentence or paragrah they were in. However, in the few
cases where a self-reference is still admissible, they are done in
bold, i.e. openssl-speed.pod references itself like this:
B<openssl speed>
References to other commands are done as manual links, i.e. CA.pl.pod
references 'openssl req' like this: L<openssl-req(1)>
Some commands are examples rather than references; we enclose those in
C<>.
While we are it, we abolish "utility", replacing it with "command", or
remove it entirely in some cases.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10065)
Diffstat (limited to 'doc/man1/openssl-tsget.pod')
-rw-r--r-- | doc/man1/openssl-tsget.pod | 26 |
1 files changed, 12 insertions, 14 deletions
diff --git a/doc/man1/openssl-tsget.pod b/doc/man1/openssl-tsget.pod index 2806762926..10595db07c 100644 --- a/doc/man1/openssl-tsget.pod +++ b/doc/man1/openssl-tsget.pod @@ -23,15 +23,14 @@ B<-h> server_url =head1 DESCRIPTION -The B<tsget> command can be used for sending a timestamp request, as -specified in B<RFC 3161>, to a timestamp server over HTTP or HTTPS and storing -the timestamp response in a file. This tool cannot be used for creating the -requests and verifying responses, you can use the OpenSSL B<ts(1)> command to -do that. B<tsget> can send several requests to the server without closing -the TCP connection if more than one requests are specified on the command -line. +This command can be used for sending a timestamp request, as specified +in B<RFC 3161>, to a timestamp server over HTTP or HTTPS and storing the +timestamp response in a file. It cannot be used for creating the requests +and verifying responses, you have to use L<openssl-ts(1)> to do that. This +command can send several requests to the server without closing the TCP +connection if more than one requests are specified on the command line. -The tool sends the following HTTP request for each timestamp request: +This command sends the following HTTP request for each timestamp request: POST url HTTP/1.1 User-Agent: OpenTSA tsget.pl/<version> @@ -43,7 +42,7 @@ The tool sends the following HTTP request for each timestamp request: ...binary request specified by the user... -B<tsget> expects a response of type application/timestamp-reply, which is +It expects a response of type application/timestamp-reply, which is written to a file without any interpretation. =head1 OPTIONS @@ -88,8 +87,8 @@ be specified. (Optional) =item B<-p> key_password (HTTPS) Specifies the passphrase for the private key specified by the B<-k> -argument. If this option is omitted and the key is passphrase protected B<tsget> -will ask for it. (Optional) +argument. If this option is omitted and the key is passphrase protected, +it will be prompted for. (Optional) =item B<-c> client_cert.pem @@ -107,9 +106,8 @@ Either option B<-C> or option B<-P> must be given in case of HTTPS. (Optional) =item B<-P> CA_path (HTTPS) The path containing the trusted CA certificates to verify the peer's -certificate. The directory must be prepared with the B<c_rehash> -OpenSSL utility. Either option B<-C> or option B<-P> must be given in case of -HTTPS. (Optional) +certificate. The directory must be prepared with L<openssl-rehash(1)>. Either +option B<-C> or option B<-P> must be given in case of HTTPS. (Optional) =item B<-rand> file:file... |