From 7626bd19cfd6d6d0ec7215b6c0ab318d293db307 Mon Sep 17 00:00:00 2001 From: Rich Salz Date: Wed, 18 Oct 2017 15:33:56 -0400 Subject: [PATCH] Additional name for all commands Add openssl-foo as a name for the openssl "foo" command. Addresses an issue found by a usability study to be published. Reviewed-by: Richard Levitte (Merged from https://github.com/openssl/openssl/pull/4553) (cherry picked from commit 3f2181e6fadea9e7ad8810b3f170fd0b2154e8b8) --- doc/apps/asn1parse.pod | 1 + doc/apps/ca.pod | 1 + doc/apps/ciphers.pod | 1 + doc/apps/cms.pod | 1 + doc/apps/crl.pod | 1 + doc/apps/crl2pkcs7.pod | 1 + doc/apps/dgst.pod | 1 + doc/apps/dhparam.pod | 1 + doc/apps/dsa.pod | 1 + doc/apps/dsaparam.pod | 1 + doc/apps/ec.pod | 1 + doc/apps/ecparam.pod | 1 + doc/apps/enc.pod | 1 + doc/apps/engine.pod | 1 + doc/apps/errstr.pod | 1 + doc/apps/gendsa.pod | 1 + doc/apps/genpkey.pod | 1 + doc/apps/genrsa.pod | 1 + doc/apps/list.pod | 1 + doc/apps/nseq.pod | 1 + doc/apps/ocsp.pod | 1 + doc/apps/passwd.pod | 1 + doc/apps/pkcs12.pod | 1 + doc/apps/pkcs7.pod | 1 + doc/apps/pkcs8.pod | 1 + doc/apps/pkey.pod | 1 + doc/apps/pkeyparam.pod | 1 + doc/apps/pkeyutl.pod | 1 + doc/apps/rand.pod | 1 + doc/apps/rehash.pod | 1 + doc/apps/req.pod | 1 + doc/apps/rsa.pod | 1 + doc/apps/rsautl.pod | 1 + doc/apps/s_client.pod | 1 + doc/apps/s_server.pod | 1 + doc/apps/s_time.pod | 1 + doc/apps/sess_id.pod | 1 + doc/apps/smime.pod | 1 + doc/apps/speed.pod | 1 + doc/apps/spkac.pod | 1 + doc/apps/ts.pod | 1 + doc/apps/tsget.pod | 1 + doc/apps/verify.pod | 1 + doc/apps/version.pod | 1 + doc/apps/x509.pod | 1 + util/process_docs.pl | 0 46 files changed, 45 insertions(+) mode change 100644 => 100755 util/process_docs.pl diff --git a/doc/apps/asn1parse.pod b/doc/apps/asn1parse.pod index 10a5aba51d..3c607e8ac5 100644 --- a/doc/apps/asn1parse.pod +++ b/doc/apps/asn1parse.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-asn1parse, asn1parse - ASN.1 parsing tool =head1 SYNOPSIS diff --git a/doc/apps/ca.pod b/doc/apps/ca.pod index c09db826ec..944e57723d 100644 --- a/doc/apps/ca.pod +++ b/doc/apps/ca.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-ca, ca - sample minimal CA application =head1 SYNOPSIS diff --git a/doc/apps/ciphers.pod b/doc/apps/ciphers.pod index 03cac2f1c1..def3bdc301 100644 --- a/doc/apps/ciphers.pod +++ b/doc/apps/ciphers.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-ciphers, ciphers - SSL cipher display and cipher list tool =head1 SYNOPSIS diff --git a/doc/apps/cms.pod b/doc/apps/cms.pod index b97120a0e4..15e5e41976 100644 --- a/doc/apps/cms.pod +++ b/doc/apps/cms.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-cms, cms - CMS utility =head1 SYNOPSIS diff --git a/doc/apps/crl.pod b/doc/apps/crl.pod index 2fad2101ee..fded3972dd 100644 --- a/doc/apps/crl.pod +++ b/doc/apps/crl.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-crl, crl - CRL utility =head1 SYNOPSIS diff --git a/doc/apps/crl2pkcs7.pod b/doc/apps/crl2pkcs7.pod index 8c679ea8fd..933750ada3 100644 --- a/doc/apps/crl2pkcs7.pod +++ b/doc/apps/crl2pkcs7.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-crl2pkcs7, crl2pkcs7 - Create a PKCS#7 structure from a CRL and certificates =head1 SYNOPSIS diff --git a/doc/apps/dgst.pod b/doc/apps/dgst.pod index 677f2b21ef..59919c32f4 100644 --- a/doc/apps/dgst.pod +++ b/doc/apps/dgst.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-dgst, dgst, sha, sha1, mdc2, ripemd160, sha224, sha256, sha384, sha512, md4, md5, blake2b, blake2s - message digests =head1 SYNOPSIS diff --git a/doc/apps/dhparam.pod b/doc/apps/dhparam.pod index addd88a540..52fc0df368 100644 --- a/doc/apps/dhparam.pod +++ b/doc/apps/dhparam.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-dhparam, dhparam - DH parameter manipulation and generation =head1 SYNOPSIS diff --git a/doc/apps/dsa.pod b/doc/apps/dsa.pod index 0e4f508fab..37358044fa 100644 --- a/doc/apps/dsa.pod +++ b/doc/apps/dsa.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-dsa, dsa - DSA key processing =head1 SYNOPSIS diff --git a/doc/apps/dsaparam.pod b/doc/apps/dsaparam.pod index 08ad47faa6..0dfda660ed 100644 --- a/doc/apps/dsaparam.pod +++ b/doc/apps/dsaparam.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-dsaparam, dsaparam - DSA parameter manipulation and generation =head1 SYNOPSIS diff --git a/doc/apps/ec.pod b/doc/apps/ec.pod index a5f920e841..c06005d823 100644 --- a/doc/apps/ec.pod +++ b/doc/apps/ec.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-ec, ec - EC key processing =head1 SYNOPSIS diff --git a/doc/apps/ecparam.pod b/doc/apps/ecparam.pod index 5167896403..9c279e0e36 100644 --- a/doc/apps/ecparam.pod +++ b/doc/apps/ecparam.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-ecparam, ecparam - EC parameter manipulation and generation =head1 SYNOPSIS diff --git a/doc/apps/enc.pod b/doc/apps/enc.pod index b3bf82adc2..6338d6c8e0 100644 --- a/doc/apps/enc.pod +++ b/doc/apps/enc.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-enc, enc - symmetric cipher routines =head1 SYNOPSIS diff --git a/doc/apps/engine.pod b/doc/apps/engine.pod index 674ab565d2..5f805c1325 100644 --- a/doc/apps/engine.pod +++ b/doc/apps/engine.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-engine, engine - load and query engines =head1 SYNOPSIS diff --git a/doc/apps/errstr.pod b/doc/apps/errstr.pod index 8dfe49a5e4..3c89b8f5cf 100644 --- a/doc/apps/errstr.pod +++ b/doc/apps/errstr.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-errstr, errstr - lookup error codes =head1 SYNOPSIS diff --git a/doc/apps/gendsa.pod b/doc/apps/gendsa.pod index 4fd1714792..36c810a909 100644 --- a/doc/apps/gendsa.pod +++ b/doc/apps/gendsa.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-gendsa, gendsa - generate a DSA private key from a set of parameters =head1 SYNOPSIS diff --git a/doc/apps/genpkey.pod b/doc/apps/genpkey.pod index e77fc7ef4e..d48695200b 100644 --- a/doc/apps/genpkey.pod +++ b/doc/apps/genpkey.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-genpkey, genpkey - generate a private key =head1 SYNOPSIS diff --git a/doc/apps/genrsa.pod b/doc/apps/genrsa.pod index f4ed9593ae..8be06834f5 100644 --- a/doc/apps/genrsa.pod +++ b/doc/apps/genrsa.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-genrsa, genrsa - generate an RSA private key =head1 SYNOPSIS diff --git a/doc/apps/list.pod b/doc/apps/list.pod index e6e1f17617..1088762693 100644 --- a/doc/apps/list.pod +++ b/doc/apps/list.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-list, list - list algorithms and features =head1 SYNOPSIS diff --git a/doc/apps/nseq.pod b/doc/apps/nseq.pod index a90f8a0026..6b25e221a4 100644 --- a/doc/apps/nseq.pod +++ b/doc/apps/nseq.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-nseq, nseq - create or examine a Netscape certificate sequence =head1 SYNOPSIS diff --git a/doc/apps/ocsp.pod b/doc/apps/ocsp.pod index ec82088fae..5e273cfe47 100644 --- a/doc/apps/ocsp.pod +++ b/doc/apps/ocsp.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-ocsp, ocsp - Online Certificate Status Protocol utility =head1 SYNOPSIS diff --git a/doc/apps/passwd.pod b/doc/apps/passwd.pod index 87dd8d868c..4663201440 100644 --- a/doc/apps/passwd.pod +++ b/doc/apps/passwd.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-passwd, passwd - compute password hashes =head1 SYNOPSIS diff --git a/doc/apps/pkcs12.pod b/doc/apps/pkcs12.pod index 2df477699e..44ee3d4ec4 100644 --- a/doc/apps/pkcs12.pod +++ b/doc/apps/pkcs12.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-pkcs12, pkcs12 - PKCS#12 file utility =head1 SYNOPSIS diff --git a/doc/apps/pkcs7.pod b/doc/apps/pkcs7.pod index d238946b34..340b72daa5 100644 --- a/doc/apps/pkcs7.pod +++ b/doc/apps/pkcs7.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-pkcs7, pkcs7 - PKCS#7 utility =head1 SYNOPSIS diff --git a/doc/apps/pkcs8.pod b/doc/apps/pkcs8.pod index dee64a0019..402e7b2b59 100644 --- a/doc/apps/pkcs8.pod +++ b/doc/apps/pkcs8.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-pkcs8, pkcs8 - PKCS#8 format private key conversion tool =head1 SYNOPSIS diff --git a/doc/apps/pkey.pod b/doc/apps/pkey.pod index 2119c70c7a..ef2e463367 100644 --- a/doc/apps/pkey.pod +++ b/doc/apps/pkey.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-pkey, pkey - public or private key processing tool =head1 SYNOPSIS diff --git a/doc/apps/pkeyparam.pod b/doc/apps/pkeyparam.pod index 755915ff9b..309e2495e3 100644 --- a/doc/apps/pkeyparam.pod +++ b/doc/apps/pkeyparam.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-pkeyparam, pkeyparam - public key algorithm parameter processing tool =head1 SYNOPSIS diff --git a/doc/apps/pkeyutl.pod b/doc/apps/pkeyutl.pod index ceb9de34b4..e72486defc 100644 --- a/doc/apps/pkeyutl.pod +++ b/doc/apps/pkeyutl.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-pkeyutl, pkeyutl - public key algorithm utility =head1 SYNOPSIS diff --git a/doc/apps/rand.pod b/doc/apps/rand.pod index 0faf6872a2..4cdb370518 100644 --- a/doc/apps/rand.pod +++ b/doc/apps/rand.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-rand, rand - generate pseudo-random bytes =head1 SYNOPSIS diff --git a/doc/apps/rehash.pod b/doc/apps/rehash.pod index 1dca9b5341..79268d4792 100644 --- a/doc/apps/rehash.pod +++ b/doc/apps/rehash.pod @@ -5,6 +5,7 @@ Original text by James Westby, contributed under the OpenSSL license. =head1 NAME +openssl-c_rehash, openssl-rehash, c_rehash, rehash - Create symbolic links to files named by the hash values =head1 SYNOPSIS diff --git a/doc/apps/req.pod b/doc/apps/req.pod index 8cfe2bc5fa..c5b5260c20 100644 --- a/doc/apps/req.pod +++ b/doc/apps/req.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-req, req - PKCS#10 certificate request and certificate generating utility =head1 SYNOPSIS diff --git a/doc/apps/rsa.pod b/doc/apps/rsa.pod index 8e9943fe58..dcbf5142b6 100644 --- a/doc/apps/rsa.pod +++ b/doc/apps/rsa.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-rsa, rsa - RSA key processing tool =head1 SYNOPSIS diff --git a/doc/apps/rsautl.pod b/doc/apps/rsautl.pod index cd21206faa..c07d60aee7 100644 --- a/doc/apps/rsautl.pod +++ b/doc/apps/rsautl.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-rsautl, rsautl - RSA utility =head1 SYNOPSIS diff --git a/doc/apps/s_client.pod b/doc/apps/s_client.pod index b0d8814395..01a6c5f7fc 100644 --- a/doc/apps/s_client.pod +++ b/doc/apps/s_client.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-s_client, s_client - SSL/TLS client program =head1 SYNOPSIS diff --git a/doc/apps/s_server.pod b/doc/apps/s_server.pod index 01c3942ae0..e8ec91b4e5 100644 --- a/doc/apps/s_server.pod +++ b/doc/apps/s_server.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-s_server, s_server - SSL/TLS server program =head1 SYNOPSIS diff --git a/doc/apps/s_time.pod b/doc/apps/s_time.pod index acadd30025..d44dd9353b 100644 --- a/doc/apps/s_time.pod +++ b/doc/apps/s_time.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-s_time, s_time - SSL/TLS performance timing program =head1 SYNOPSIS diff --git a/doc/apps/sess_id.pod b/doc/apps/sess_id.pod index 19ac9a75b1..7766c71edc 100644 --- a/doc/apps/sess_id.pod +++ b/doc/apps/sess_id.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-sess_id, sess_id - SSL/TLS session handling utility =head1 SYNOPSIS diff --git a/doc/apps/smime.pod b/doc/apps/smime.pod index d3e0214665..753e2757bf 100644 --- a/doc/apps/smime.pod +++ b/doc/apps/smime.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-smime, smime - S/MIME utility =head1 SYNOPSIS diff --git a/doc/apps/speed.pod b/doc/apps/speed.pod index ad81bfbc74..4379319d78 100644 --- a/doc/apps/speed.pod +++ b/doc/apps/speed.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-speed, speed - test library performance =head1 SYNOPSIS diff --git a/doc/apps/spkac.pod b/doc/apps/spkac.pod index 8955bc445d..e337e4e7c6 100644 --- a/doc/apps/spkac.pod +++ b/doc/apps/spkac.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-spkac, spkac - SPKAC printing and generating utility =head1 SYNOPSIS diff --git a/doc/apps/ts.pod b/doc/apps/ts.pod index cf30947d35..0c949bfb7c 100644 --- a/doc/apps/ts.pod +++ b/doc/apps/ts.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-ts, ts - Time Stamping Authority tool (client/server) =head1 SYNOPSIS diff --git a/doc/apps/tsget.pod b/doc/apps/tsget.pod index cf7817a0e7..f566f3a4bf 100644 --- a/doc/apps/tsget.pod +++ b/doc/apps/tsget.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-tsget, tsget - Time Stamping HTTP/HTTPS client =head1 SYNOPSIS diff --git a/doc/apps/verify.pod b/doc/apps/verify.pod index 8ba5ff67e4..38fa346f54 100644 --- a/doc/apps/verify.pod +++ b/doc/apps/verify.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-verify, verify - Utility to verify certificates =head1 SYNOPSIS diff --git a/doc/apps/version.pod b/doc/apps/version.pod index a97ed20445..305a1b7482 100644 --- a/doc/apps/version.pod +++ b/doc/apps/version.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-version, version - print OpenSSL version information =head1 SYNOPSIS diff --git a/doc/apps/x509.pod b/doc/apps/x509.pod index cddfc8ce4a..62520b309c 100644 --- a/doc/apps/x509.pod +++ b/doc/apps/x509.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-x509, x509 - Certificate display and signing utility =head1 SYNOPSIS diff --git a/util/process_docs.pl b/util/process_docs.pl old mode 100644 new mode 100755 -- 2.25.1