[thirdparty/openssl.git] / doc / man1 / openssl-cmds.pod

=pod

=head1 NAME

asn1parse,
ca,
ciphers,
cms,
crl,
crl2pkcs7,
dgst,
dhparam,
dsa,
dsaparam,
ec,
ecparam,
enc,
engine,
errstr,
gendsa,
genpkey,
genrsa,
info,
kdf,
mac,
nseq,
ocsp,
passwd,
pkcs12,
pkcs7,
pkcs8,
pkey,
pkeyparam,
pkeyutl,
prime,
rand,
rehash,
req,
rsa,
rsautl,
s_client,
s_server,
s_time,
sess_id,
smime,
speed,
spkac,
srp,
storeutl,
ts,
verify,
version,
x509
- OpenSSL application commands

=for comment foreign manuals: apropos(1)

=head1 SYNOPSIS

=for openssl generic

B<openssl> I<cmd> B<-help> | [I<-option> | I<-option> I<arg>] ... [I<arg>] ...

=head1 DESCRIPTION

Every I<cmd> listed above is a (sub-)command of the L<openssl(1)> application.
It has its own detailed manual page at B<openssl-I<cmd>>(1). For example, to
view the manual page for the B<openssl dgst> command, type C<man openssl-dgst>.

=head1 OPTIONS

Among others, every subcommand has a help option.

=over 4

=item B<-help>

Print out a usage message for the subcommand.

=back

=head1 SEE ALSO

L<openssl(1)>,
L<openssl-asn1parse(1)>,
L<openssl-ca(1)>,
L<openssl-ciphers(1)>,
L<openssl-cms(1)>,
L<openssl-crl(1)>,
L<openssl-crl2pkcs7(1)>,
L<openssl-dgst(1)>,
L<openssl-dhparam(1)>,
L<openssl-dsa(1)>,
L<openssl-dsaparam(1)>,
L<openssl-ec(1)>,
L<openssl-ecparam(1)>,
L<openssl-enc(1)>,
L<openssl-engine(1)>,
L<openssl-errstr(1)>,
L<openssl-gendsa(1)>,
L<openssl-genpkey(1)>,
L<openssl-genrsa(1)>,
L<openssl-info(1)>,
L<openssl-kdf(1)>,
L<openssl-mac(1)>,
L<openssl-nseq(1)>,
L<openssl-ocsp(1)>,
L<openssl-passwd(1)>,
L<openssl-pkcs12(1)>,
L<openssl-pkcs7(1)>,
L<openssl-pkcs8(1)>,
L<openssl-pkey(1)>,
L<openssl-pkeyparam(1)>,
L<openssl-pkeyutl(1)>,
L<openssl-prime(1)>,
L<openssl-rand(1)>,
L<openssl-rehash(1)>,
L<openssl-req(1)>,
L<openssl-rsa(1)>,
L<openssl-rsautl(1)>,
L<openssl-s_client(1)>,
L<openssl-s_server(1)>,
L<openssl-s_time(1)>,
L<openssl-sess_id(1)>,
L<openssl-smime(1)>,
L<openssl-speed(1)>,
L<openssl-spkac(1)>,
L<openssl-srp(1)>,
L<openssl-storeutl(1)>,
L<openssl-ts(1)>,
L<openssl-verify(1)>,
L<openssl-version(1)>,
L<openssl-x509(1)>,

=head1 HISTORY

Initially, the manual page entry for the C<openssl I<cmd>> command used
to be available at I<cmd>(1). Later, the alias B<openssl-I<cmd>>(1) was
introduced, which made it easier to group the openssl commands using
the L<apropos(1)> command or the shell's tab completion.

In order to reduce cluttering of the global manual page namespace,
the manual page entries without the 'openssl-' prefix have been
deprecated in OpenSSL 3.0 and will be removed in OpenSSL 4.0.

=head1 COPYRIGHT

Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut
Commit	Line	Data
b6b66573 DMSP	1	=pod
	2
	3	=head1 NAME
	4
	5	asn1parse,
	6	ca,
	7	ciphers,
	8	cms,
	9	crl,
	10	crl2pkcs7,
	11	dgst,
	12	dhparam,
	13	dsa,
	14	dsaparam,
	15	ec,
	16	ecparam,
	17	enc,
	18	engine,
	19	errstr,
	20	gendsa,
	21	genpkey,
	22	genrsa,
	23	info,
	24	kdf,
	25	mac,
	26	nseq,
	27	ocsp,
	28	passwd,
	29	pkcs12,
	30	pkcs7,
	31	pkcs8,
	32	pkey,
	33	pkeyparam,
	34	pkeyutl,
	35	prime,
	36	rand,
	37	rehash,
	38	req,
	39	rsa,
	40	rsautl,
	41	s_client,
	42	s_server,
	43	s_time,
	44	sess_id,
	45	smime,
	46	speed,
	47	spkac,
	48	srp,
	49	storeutl,
	50	ts,
	51	verify,
	52	version,
	53	x509
	54	- OpenSSL application commands
	55
d2b194d7 RS	56	=for comment foreign manuals: apropos(1)
d2b194d7 RS	57
b6b66573 DMSP	58	=head1 SYNOPSIS
b6b66573 DMSP	59
bb82531f	60	=for openssl generic
b6b66573	61
2f0ea936	62	B<openssl> I<cmd> B<-help> \| [I<-option> \| I<-option> I<arg>] ... [I<arg>] ...
b6b66573 DMSP	63
	64	=head1 DESCRIPTION
	65
2f0ea936 RL	66	Every I<cmd> listed above is a (sub-)command of the L<openssl(1)> application.
	67	It has its own detailed manual page at B<openssl-I<cmd>>(1). For example, to
	68	view the manual page for the B<openssl dgst> command, type C<man openssl-dgst>.
b6b66573 DMSP	69
	70	=head1 OPTIONS
	71
	72	Among others, every subcommand has a help option.
	73
	74	=over 4
	75
	76	=item B<-help>
	77
	78	Print out a usage message for the subcommand.
	79
	80	=back
	81
	82	=head1 SEE ALSO
	83
	84	L<openssl(1)>,
	85	L<openssl-asn1parse(1)>,
	86	L<openssl-ca(1)>,
	87	L<openssl-ciphers(1)>,
	88	L<openssl-cms(1)>,
	89	L<openssl-crl(1)>,
	90	L<openssl-crl2pkcs7(1)>,
	91	L<openssl-dgst(1)>,
	92	L<openssl-dhparam(1)>,
	93	L<openssl-dsa(1)>,
	94	L<openssl-dsaparam(1)>,
	95	L<openssl-ec(1)>,
	96	L<openssl-ecparam(1)>,
	97	L<openssl-enc(1)>,
	98	L<openssl-engine(1)>,
	99	L<openssl-errstr(1)>,
	100	L<openssl-gendsa(1)>,
	101	L<openssl-genpkey(1)>,
	102	L<openssl-genrsa(1)>,
	103	L<openssl-info(1)>,
	104	L<openssl-kdf(1)>,
	105	L<openssl-mac(1)>,
	106	L<openssl-nseq(1)>,
	107	L<openssl-ocsp(1)>,
	108	L<openssl-passwd(1)>,
	109	L<openssl-pkcs12(1)>,
	110	L<openssl-pkcs7(1)>,
	111	L<openssl-pkcs8(1)>,
	112	L<openssl-pkey(1)>,
	113	L<openssl-pkeyparam(1)>,
	114	L<openssl-pkeyutl(1)>,
	115	L<openssl-prime(1)>,
	116	L<openssl-rand(1)>,
	117	L<openssl-rehash(1)>,
	118	L<openssl-req(1)>,
	119	L<openssl-rsa(1)>,
	120	L<openssl-rsautl(1)>,
	121	L<openssl-s_client(1)>,
	122	L<openssl-s_server(1)>,
	123	L<openssl-s_time(1)>,
	124	L<openssl-sess_id(1)>,
	125	L<openssl-smime(1)>,
	126	L<openssl-speed(1)>,
	127	L<openssl-spkac(1)>,
	128	L<openssl-srp(1)>,
	129	L<openssl-storeutl(1)>,
	130	L<openssl-ts(1)>,
	131	L<openssl-verify(1)>,
	132	L<openssl-version(1)>,
133	L<openssl-x509(1)>,
134
135	=head1 HISTORY
136
2f0ea936 RL	137	Initially, the manual page entry for the C<openssl I<cmd>> command used
2f0ea936 RL	138	to be available at I<cmd>(1). Later, the alias B<openssl-I<cmd>>(1) was
b6b66573 DMSP	139	introduced, which made it easier to group the openssl commands using
	140	the L<apropos(1)> command or the shell's tab completion.
	141
	142	In order to reduce cluttering of the global manual page namespace,
	143	the manual page entries without the 'openssl-' prefix have been
	144	deprecated in OpenSSL 3.0 and will be removed in OpenSSL 4.0.
	145
	146	=head1 COPYRIGHT
	147
	148	Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
	149
	150	Licensed under the Apache License 2.0 (the "License"). You may not use
	151	this file except in compliance with the License. You can obtain a copy
	152	in the file LICENSE in the source distribution or at
	153	L<https://www.openssl.org/source/license.html>.
	154
	155	=cut