From 3f2181e6fadea9e7ad8810b3f170fd0b2154e8b8 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) --- doc/man1/asn1parse.pod | 1 + doc/man1/ca.pod | 1 + doc/man1/ciphers.pod | 1 + doc/man1/cms.pod | 1 + doc/man1/crl.pod | 1 + doc/man1/crl2pkcs7.pod | 1 + doc/man1/dgst.pod | 4 ++-- doc/man1/dhparam.pod | 1 + doc/man1/dsa.pod | 1 + doc/man1/dsaparam.pod | 1 + doc/man1/ec.pod | 1 + doc/man1/ecparam.pod | 1 + doc/man1/enc.pod | 1 + doc/man1/engine.pod | 1 + doc/man1/errstr.pod | 1 + doc/man1/gendsa.pod | 1 + doc/man1/genpkey.pod | 1 + doc/man1/genrsa.pod | 1 + doc/man1/list.pod | 1 + doc/man1/nseq.pod | 1 + doc/man1/ocsp.pod | 1 + doc/man1/passwd.pod | 1 + doc/man1/pkcs12.pod | 1 + doc/man1/pkcs7.pod | 1 + doc/man1/pkcs8.pod | 1 + doc/man1/pkey.pod | 1 + doc/man1/pkeyparam.pod | 1 + doc/man1/pkeyutl.pod | 1 + doc/man1/prime.pod | 1 + doc/man1/rand.pod | 1 + doc/man1/rehash.pod | 1 + doc/man1/req.pod | 1 + doc/man1/rsa.pod | 1 + doc/man1/rsautl.pod | 1 + doc/man1/s_client.pod | 1 + doc/man1/s_server.pod | 1 + doc/man1/s_time.pod | 1 + doc/man1/sess_id.pod | 1 + doc/man1/smime.pod | 1 + doc/man1/speed.pod | 1 + doc/man1/spkac.pod | 1 + doc/man1/srp.pod | 1 + doc/man1/storeutl.pod | 1 + doc/man1/ts.pod | 1 + doc/man1/tsget.pod | 1 + doc/man1/verify.pod | 1 + doc/man1/version.pod | 1 + doc/man1/x509.pod | 1 + util/process_docs.pl | 0 49 files changed, 49 insertions(+), 2 deletions(-) mode change 100644 => 100755 util/process_docs.pl diff --git a/doc/man1/asn1parse.pod b/doc/man1/asn1parse.pod index 602754e54d..0e1fcc686f 100644 --- a/doc/man1/asn1parse.pod +++ b/doc/man1/asn1parse.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-asn1parse, asn1parse - ASN.1 parsing tool =head1 SYNOPSIS diff --git a/doc/man1/ca.pod b/doc/man1/ca.pod index 21e692e511..9c5af4a891 100644 --- a/doc/man1/ca.pod +++ b/doc/man1/ca.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-ca, ca - sample minimal CA application =head1 SYNOPSIS diff --git a/doc/man1/ciphers.pod b/doc/man1/ciphers.pod index 14c92bddf4..ce573d788f 100644 --- a/doc/man1/ciphers.pod +++ b/doc/man1/ciphers.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-ciphers, ciphers - SSL cipher display and cipher list tool =head1 SYNOPSIS diff --git a/doc/man1/cms.pod b/doc/man1/cms.pod index 01e93acf1b..7bd1b0d38a 100644 --- a/doc/man1/cms.pod +++ b/doc/man1/cms.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-cms, cms - CMS utility =head1 SYNOPSIS diff --git a/doc/man1/crl.pod b/doc/man1/crl.pod index 9d1dcf4909..9a009675d8 100644 --- a/doc/man1/crl.pod +++ b/doc/man1/crl.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-crl, crl - CRL utility =head1 SYNOPSIS diff --git a/doc/man1/crl2pkcs7.pod b/doc/man1/crl2pkcs7.pod index 3bf1facfec..f58a442b5b 100644 --- a/doc/man1/crl2pkcs7.pod +++ b/doc/man1/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/man1/dgst.pod b/doc/man1/dgst.pod index cde3bb17d3..5cad2438a9 100644 --- a/doc/man1/dgst.pod +++ b/doc/man1/dgst.pod @@ -2,8 +2,8 @@ =head1 NAME -dgst -- perform digest operations +openssl-dgst, +dgst - perform digest operations =head1 SYNOPSIS diff --git a/doc/man1/dhparam.pod b/doc/man1/dhparam.pod index 2395aa1bb6..1b43b32310 100644 --- a/doc/man1/dhparam.pod +++ b/doc/man1/dhparam.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-dhparam, dhparam - DH parameter manipulation and generation =head1 SYNOPSIS diff --git a/doc/man1/dsa.pod b/doc/man1/dsa.pod index 523c533a09..2428879ea2 100644 --- a/doc/man1/dsa.pod +++ b/doc/man1/dsa.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-dsa, dsa - DSA key processing =head1 SYNOPSIS diff --git a/doc/man1/dsaparam.pod b/doc/man1/dsaparam.pod index f97a673471..94ea435cce 100644 --- a/doc/man1/dsaparam.pod +++ b/doc/man1/dsaparam.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-dsaparam, dsaparam - DSA parameter manipulation and generation =head1 SYNOPSIS diff --git a/doc/man1/ec.pod b/doc/man1/ec.pod index f386877b61..0b836603ca 100644 --- a/doc/man1/ec.pod +++ b/doc/man1/ec.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-ec, ec - EC key processing =head1 SYNOPSIS diff --git a/doc/man1/ecparam.pod b/doc/man1/ecparam.pod index ecafedca59..dc07caf4ff 100644 --- a/doc/man1/ecparam.pod +++ b/doc/man1/ecparam.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-ecparam, ecparam - EC parameter manipulation and generation =head1 SYNOPSIS diff --git a/doc/man1/enc.pod b/doc/man1/enc.pod index f7d5e36fdb..1b89fa67e3 100644 --- a/doc/man1/enc.pod +++ b/doc/man1/enc.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-enc, enc - symmetric cipher routines =head1 SYNOPSIS diff --git a/doc/man1/engine.pod b/doc/man1/engine.pod index eb43219209..506c9175b8 100644 --- a/doc/man1/engine.pod +++ b/doc/man1/engine.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-engine, engine - load and query engines =head1 SYNOPSIS diff --git a/doc/man1/errstr.pod b/doc/man1/errstr.pod index 8dfe49a5e4..3c89b8f5cf 100644 --- a/doc/man1/errstr.pod +++ b/doc/man1/errstr.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-errstr, errstr - lookup error codes =head1 SYNOPSIS diff --git a/doc/man1/gendsa.pod b/doc/man1/gendsa.pod index 9cb84dfbeb..7984b74c20 100644 --- a/doc/man1/gendsa.pod +++ b/doc/man1/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/man1/genpkey.pod b/doc/man1/genpkey.pod index 66541d92b0..ddfd04002c 100644 --- a/doc/man1/genpkey.pod +++ b/doc/man1/genpkey.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-genpkey, genpkey - generate a private key =head1 SYNOPSIS diff --git a/doc/man1/genrsa.pod b/doc/man1/genrsa.pod index 57b4cf879b..f6a2d8a7f3 100644 --- a/doc/man1/genrsa.pod +++ b/doc/man1/genrsa.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-genrsa, genrsa - generate an RSA private key =head1 SYNOPSIS diff --git a/doc/man1/list.pod b/doc/man1/list.pod index 976be97344..bed39b0c7c 100644 --- a/doc/man1/list.pod +++ b/doc/man1/list.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-list, list - list algorithms and features =head1 SYNOPSIS diff --git a/doc/man1/nseq.pod b/doc/man1/nseq.pod index 4894f1a8a2..7d5f009aa2 100644 --- a/doc/man1/nseq.pod +++ b/doc/man1/nseq.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-nseq, nseq - create or examine a Netscape certificate sequence =head1 SYNOPSIS diff --git a/doc/man1/ocsp.pod b/doc/man1/ocsp.pod index 281518bf01..46fff32985 100644 --- a/doc/man1/ocsp.pod +++ b/doc/man1/ocsp.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-ocsp, ocsp - Online Certificate Status Protocol utility =head1 SYNOPSIS diff --git a/doc/man1/passwd.pod b/doc/man1/passwd.pod index 3c16946078..6c3d811e59 100644 --- a/doc/man1/passwd.pod +++ b/doc/man1/passwd.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-passwd, passwd - compute password hashes =head1 SYNOPSIS diff --git a/doc/man1/pkcs12.pod b/doc/man1/pkcs12.pod index 2eb6b078a4..3389e595fe 100644 --- a/doc/man1/pkcs12.pod +++ b/doc/man1/pkcs12.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-pkcs12, pkcs12 - PKCS#12 file utility =head1 SYNOPSIS diff --git a/doc/man1/pkcs7.pod b/doc/man1/pkcs7.pod index a5f96ace9c..cf445b3dcd 100644 --- a/doc/man1/pkcs7.pod +++ b/doc/man1/pkcs7.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-pkcs7, pkcs7 - PKCS#7 utility =head1 SYNOPSIS diff --git a/doc/man1/pkcs8.pod b/doc/man1/pkcs8.pod index 9d1dd3130f..84a10e88ac 100644 --- a/doc/man1/pkcs8.pod +++ b/doc/man1/pkcs8.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-pkcs8, pkcs8 - PKCS#8 format private key conversion tool =head1 SYNOPSIS diff --git a/doc/man1/pkey.pod b/doc/man1/pkey.pod index d6b0db4d80..47ffb6649f 100644 --- a/doc/man1/pkey.pod +++ b/doc/man1/pkey.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-pkey, pkey - public or private key processing tool =head1 SYNOPSIS diff --git a/doc/man1/pkeyparam.pod b/doc/man1/pkeyparam.pod index d3440ea7a8..45c053cf43 100644 --- a/doc/man1/pkeyparam.pod +++ b/doc/man1/pkeyparam.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-pkeyparam, pkeyparam - public key algorithm parameter processing tool =head1 SYNOPSIS diff --git a/doc/man1/pkeyutl.pod b/doc/man1/pkeyutl.pod index 5e16bc6e00..4c12f13b08 100644 --- a/doc/man1/pkeyutl.pod +++ b/doc/man1/pkeyutl.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-pkeyutl, pkeyutl - public key algorithm utility =head1 SYNOPSIS diff --git a/doc/man1/prime.pod b/doc/man1/prime.pod index f6f6158581..1d25954af1 100644 --- a/doc/man1/prime.pod +++ b/doc/man1/prime.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-prime, prime - compute prime numbers =head1 SYNOPSIS diff --git a/doc/man1/rand.pod b/doc/man1/rand.pod index 22482033fc..5dd9e8e0a5 100644 --- a/doc/man1/rand.pod +++ b/doc/man1/rand.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-rand, rand - generate pseudo-random bytes =head1 SYNOPSIS diff --git a/doc/man1/rehash.pod b/doc/man1/rehash.pod index 1dca9b5341..79268d4792 100644 --- a/doc/man1/rehash.pod +++ b/doc/man1/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/man1/req.pod b/doc/man1/req.pod index 1930088fe8..7a490983d5 100644 --- a/doc/man1/req.pod +++ b/doc/man1/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/man1/rsa.pod b/doc/man1/rsa.pod index ee504e6525..835f844512 100644 --- a/doc/man1/rsa.pod +++ b/doc/man1/rsa.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-rsa, rsa - RSA key processing tool =head1 SYNOPSIS diff --git a/doc/man1/rsautl.pod b/doc/man1/rsautl.pod index b5e83b598d..fdc67432fb 100644 --- a/doc/man1/rsautl.pod +++ b/doc/man1/rsautl.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-rsautl, rsautl - RSA utility =head1 SYNOPSIS diff --git a/doc/man1/s_client.pod b/doc/man1/s_client.pod index c48ff8c3e2..1d9dd39656 100644 --- a/doc/man1/s_client.pod +++ b/doc/man1/s_client.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-s_client, s_client - SSL/TLS client program =head1 SYNOPSIS diff --git a/doc/man1/s_server.pod b/doc/man1/s_server.pod index 986578937e..0e28e4e2f1 100644 --- a/doc/man1/s_server.pod +++ b/doc/man1/s_server.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-s_server, s_server - SSL/TLS server program =head1 SYNOPSIS diff --git a/doc/man1/s_time.pod b/doc/man1/s_time.pod index b926b6e842..ecdac17cc5 100644 --- a/doc/man1/s_time.pod +++ b/doc/man1/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/man1/sess_id.pod b/doc/man1/sess_id.pod index ca3dd7ed58..0c0e7e8ae9 100644 --- a/doc/man1/sess_id.pod +++ b/doc/man1/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/man1/smime.pod b/doc/man1/smime.pod index 4d8cf7a1ce..0acdd08254 100644 --- a/doc/man1/smime.pod +++ b/doc/man1/smime.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-smime, smime - S/MIME utility =head1 SYNOPSIS diff --git a/doc/man1/speed.pod b/doc/man1/speed.pod index 647c59f399..d8d5f6f22b 100644 --- a/doc/man1/speed.pod +++ b/doc/man1/speed.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-speed, speed - test library performance =head1 SYNOPSIS diff --git a/doc/man1/spkac.pod b/doc/man1/spkac.pod index 14fdd0bcc8..75b12d85df 100644 --- a/doc/man1/spkac.pod +++ b/doc/man1/spkac.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-spkac, spkac - SPKAC printing and generating utility =head1 SYNOPSIS diff --git a/doc/man1/srp.pod b/doc/man1/srp.pod index a5dcf2ec74..e858a22260 100644 --- a/doc/man1/srp.pod +++ b/doc/man1/srp.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-srp, srp - maintain SRP password file =head1 SYNOPSIS diff --git a/doc/man1/storeutl.pod b/doc/man1/storeutl.pod index 1f729662e9..74361a7630 100644 --- a/doc/man1/storeutl.pod +++ b/doc/man1/storeutl.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-storeutl, storeutl - STORE utility =head1 SYNOPSIS diff --git a/doc/man1/ts.pod b/doc/man1/ts.pod index 8886cd6bbd..3ae320f2a1 100644 --- a/doc/man1/ts.pod +++ b/doc/man1/ts.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-ts, ts - Time Stamping Authority tool (client/server) =head1 SYNOPSIS diff --git a/doc/man1/tsget.pod b/doc/man1/tsget.pod index 7812a32ec2..43bf2c7e35 100644 --- a/doc/man1/tsget.pod +++ b/doc/man1/tsget.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-tsget, tsget - Time Stamping HTTP/HTTPS client =head1 SYNOPSIS diff --git a/doc/man1/verify.pod b/doc/man1/verify.pod index 5596e1d8bd..b67890af3c 100644 --- a/doc/man1/verify.pod +++ b/doc/man1/verify.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-verify, verify - Utility to verify certificates =head1 SYNOPSIS diff --git a/doc/man1/version.pod b/doc/man1/version.pod index c14311b726..757b55b55c 100644 --- a/doc/man1/version.pod +++ b/doc/man1/version.pod @@ -2,6 +2,7 @@ =head1 NAME +openssl-version, version - print OpenSSL version information =head1 SYNOPSIS diff --git a/doc/man1/x509.pod b/doc/man1/x509.pod index a2cbd0dda5..e57e18b4ae 100644 --- a/doc/man1/x509.pod +++ b/doc/man1/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