Skip to content

Commit 8c86b1b

Browse files
calnanwangweij
authored andcommitted
8375325: add anchors to the options in the security man pages
Reviewed-by: weijun, hchao
1 parent 2a465cb commit 8c86b1b

File tree

5 files changed

+74
-74
lines changed

5 files changed

+74
-74
lines changed

src/java.base/share/man/keytool.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
# Copyright (c) 1998, 2025, Oracle and/or its affiliates. All rights reserved.
2+
# Copyright (c) 1998, 2026, Oracle and/or its affiliates. All rights reserved.
33
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
#
55
# This code is free software; you can redistribute it and/or modify it
@@ -211,7 +211,7 @@ perform.
211211

212212
## Commands for Creating or Adding Data to the Keystore
213213

214-
`-gencert`
214+
[`-gencert`]{#command-gencert}
215215
: The following are the available options for the `-gencert` command:
216216

217217
- {`-rfc`}: Output in RFC (Request For Comment) style
@@ -328,7 +328,7 @@ perform.
328328

329329
> `keytool -alias e1 -certreq | keytool -alias ca2 -gencert > e1.cert`
330330

331-
`-genkeypair`
331+
[`-genkeypair`]{#option-genkeypair}
332332
: The following are the available options for the `-genkeypair` command:
333333

334334
- {`-alias` *alias*}: Alias name of the entry to process
@@ -478,7 +478,7 @@ perform.
478478
specified by `-startdate`, or the current date when `-startdate` isn't
479479
specified) for which the certificate should be considered valid.
480480

481-
`-genseckey`
481+
[`-genseckey`]{#command-genseckey}
482482
: The following are the available options for the `-genseckey` command:
483483

484484
- {`-alias` *alias*}: Alias name of the entry to process
@@ -521,7 +521,7 @@ perform.
521521
the same password that is used for the `-keystore`. The `-keypass` value
522522
must contain at least six characters.
523523

524-
`-importcert`
524+
[`-importcert`]{#command-importcert}
525525
: The following are the available options for the `-importcert` command:
526526

527527
- {`-noprompt`}: Do not prompt
@@ -586,7 +586,7 @@ perform.
586586
entry, then the `keytool` command assumes that you're importing a
587587
certificate reply.
588588

589-
`-importpass`
589+
[`-importpass`]{#command-importpass}
590590
: The following are the available options for the `-importpass` command:
591591

592592
- {`-alias` *alias*}: Alias name of the entry to process
@@ -629,7 +629,7 @@ perform.
629629

630630
## Commands for Importing Contents from Another Keystore
631631

632-
`-importkeystore`
632+
[`-importkeystore`]{#command-importkeystore}
633633
: The following are the available options for the `-importkeystore` command:
634634

635635
- `-srckeystore` *keystore*: Source keystore name
@@ -724,7 +724,7 @@ perform.
724724

725725
## Commands for Generating a Certificate Request
726726

727-
`-certreq`
727+
[`-certreq`]{#command-certreq}
728728
: The following are the available options for the `-certreq` command:
729729

730730
- {`-alias` *alias*}: Alias name of the entry to process
@@ -786,7 +786,7 @@ perform.
786786

787787
## Commands for Exporting Data
788788

789-
`-exportcert`
789+
[`-exportcert`]{#command-exportcert}
790790
: The following are the available options for the `-exportcert` command:
791791

792792
- {`-rfc`}: Output in RFC style
@@ -834,7 +834,7 @@ perform.
834834

835835
## Commands for Displaying Data
836836

837-
`-list`
837+
[`-list`]{#command-list}
838838
: The following are the available options for the `-list` command:
839839

840840
- {`-rfc`}: Output in RFC style
@@ -881,7 +881,7 @@ perform.
881881
You can't specify both `-v` and `-rfc` in the same command. Otherwise, an
882882
error is reported.
883883

884-
`-printcert`
884+
[`-printcert`]{#command-printcert}
885885
: The following are the available options for the `-printcert` command:
886886

887887
- {`-rfc`}: Output in RFC style
@@ -946,7 +946,7 @@ perform.
946946
trusted certificate in the user keystore (specified by `-keystore`) or in
947947
the `cacerts` keystore (if `-trustcacerts` is specified).
948948

949-
`-printcertreq`
949+
[`-printcertreq`]{#command-printcertreq}
950950
: The following are the available options for the `-printcertreq` command:
951951

952952
- {`-file` *file*}: Input file name
@@ -958,7 +958,7 @@ perform.
958958
command. The command reads the request from file. If there is no file, then
959959
the request is read from the standard input.
960960

961-
`-printcrl`
961+
[`-printcrl`]{#command-printcrl}
962962
: The following are the available options for the `-printcrl` command:
963963

964964
- {`-file crl`}: Input file name
@@ -999,7 +999,7 @@ perform.
999999

10001000
## Commands for Managing the Keystore
10011001

1002-
`-storepasswd`
1002+
[`-storepasswd`]{#command-storepasswd}
10031003
: The following are the available options for the `-storepasswd` command:
10041004

10051005
- \[`-new` *arg*\]: New password
@@ -1029,7 +1029,7 @@ perform.
10291029
integrity of the keystore contents. The new password is set by `-new` *arg*
10301030
and must contain at least six characters.
10311031

1032-
`-keypasswd`
1032+
[`-keypasswd`]{#command-keypasswd}
10331033
: The following are the available options for the `-keypasswd` command:
10341034

10351035
- {`-alias` *alias*}: Alias name of the entry to process
@@ -1069,7 +1069,7 @@ perform.
10691069
If the `-new` option isn't provided at the command line, then the user is
10701070
prompted for it.
10711071

1072-
`-delete`
1072+
[`-delete`]{#command-delete}
10731073
: The following are the available options for the `-delete` command:
10741074

10751075
- \[`-alias` *alias*\]: Alias name of the entry to process
@@ -1101,7 +1101,7 @@ perform.
11011101
keystore. When not provided at the command line, the user is prompted for
11021102
the `alias`.
11031103

1104-
`-changealias`
1104+
[`-changealias`]{#command-changealias}
11051105
: The following are the available options for the `-changealias` command:
11061106

11071107
- {`-alias` *alias*}: Alias name of the entry to process
@@ -1143,7 +1143,7 @@ perform.
11431143

11441144
## Commands for Displaying Security-related Information
11451145

1146-
`-showinfo`
1146+
[`-showinfo`]{#command-showinfo}
11471147
: The following are the available options for the `-showinfo` command:
11481148

11491149
- {`-tls`}: Displays TLS configuration information
@@ -1185,10 +1185,10 @@ environment or memory usage. For a list of possible interpreter options, enter
11851185

11861186
These options can appear for all commands operating on a keystore:
11871187

1188-
`-storetype` *storetype*
1188+
[`-storetype`]{#option-storetype} *storetype*
11891189
: This qualifier specifies the type of keystore to be instantiated.
11901190

1191-
`-keystore` *keystore*
1191+
[`-keystore`]{#option-keystore} *keystore*
11921192
: The keystore location.
11931193

11941194
If the JKS `storetype` is used and a keystore file doesn't yet exist, then
@@ -1206,13 +1206,13 @@ These options can appear for all commands operating on a keystore:
12061206
if the keystore isn't file-based. For example, when the keystore resides on
12071207
a hardware token device.
12081208

1209-
`-cacerts` *cacerts*
1209+
[`-cacerts`]{#option-cacerts} *cacerts*
12101210
: Operates on the *cacerts* keystore . This option is equivalent to
12111211
`-keystore` *path\_to\_cacerts* `-storetype` *type\_of\_cacerts*. An error
12121212
is reported if the `-keystore` or `-storetype` option is used with the
12131213
`-cacerts` option.
12141214

1215-
`-storepass` \[`:env` \| `:file` \] *argument*
1215+
[`-storepass`]{#option-storepass} \[`:env` \| `:file` \] *argument*
12161216
: The password that is used to protect the integrity of the keystore.
12171217

12181218
If the modifier `env` or `file` isn't specified, then the password has the
@@ -1237,22 +1237,22 @@ These options can appear for all commands operating on a keystore:
12371237
a password is not specified, then the integrity of the retrieved
12381238
information can't be verified and a warning is displayed.
12391239

1240-
`-providername` *name*
1240+
[`-providername`]{#option-providername} *name*
12411241
: Used to identify a cryptographic service provider's name when listed in the
12421242
security properties file.
12431243

1244-
`-addprovider` *name*
1244+
[`-addprovider`]{#option-addprovider} *name*
12451245
: Used to add a security provider by name (such as SunPKCS11) .
12461246

1247-
`-providerclass` *class*
1247+
[`-providerclass`]{#option-providerclass} *class*
12481248
: Used to specify the name of a cryptographic service provider's master class
12491249
file when the service provider isn't listed in the security properties
12501250
file.
12511251

1252-
`-providerpath` *list*
1252+
[`-providerpath`]{#option-providerpath} *list*
12531253
: Used to specify the provider classpath.
12541254

1255-
`-providerarg` *arg*
1255+
[`-providerarg`]{#option-providerarg} *arg*
12561256
: Used with the `-addprovider` or `-providerclass` option to represent an
12571257
optional string input argument for the constructor of *class* name.
12581258

@@ -1263,7 +1263,7 @@ These options can appear for all commands operating on a keystore:
12631263
following two options, `-srcprotected` and `-destprotected`, are provided
12641264
for the source keystore and the destination keystore respectively.
12651265

1266-
`-ext` {*name*{`:critical`} {`=`*value*}}
1266+
[`-ext`]{#option-ext} {*name*{`:critical`} {`=`*value*}}
12671267
: Denotes an X.509 certificate extension. The option can be used in
12681268
`-genkeypair` and `-gencert` to embed extensions into the generated
12691269
certificate, or in `-certreq` to show what extensions are requested in the
@@ -1276,7 +1276,7 @@ These options can appear for all commands operating on a keystore:
12761276
`isCritical` attribute is `true`; otherwise, it is `false`. You can use
12771277
`:c` in place of `:critical`.
12781278

1279-
`-conf` *file*
1279+
[`-conf`]{#option-conf} *file*
12801280
: Specifies a pre-configured options file.
12811281

12821282
## Pre-configured options file

src/java.security.jgss/windows/man/kinit.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
# Copyright (c) 2005, 2024, Oracle and/or its affiliates. All rights reserved.
2+
# Copyright (c) 2005, 2026, Oracle and/or its affiliates. All rights reserved.
33
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
#
55
# This code is free software; you can redistribute it and/or modify it
@@ -79,34 +79,34 @@ will compromise your password.
7979
You can specify one of the following commands. After the command, specify the
8080
options for it.
8181

82-
`-A`
82+
[`-A`]{#option-A}
8383
: Doesn't include addresses.
8484

85-
`-f`
85+
[`-f`]{#option-f}
8686
: Issues a forwardable ticket.
8787

88-
`-p`
88+
[`-p`]{#option-p}
8989
: Issues a proxiable ticket.
9090

91-
`-c` *cache\_name*
91+
[`-c`]{#option-c} *cache\_name*
9292
: The cache name (for example, `FILE:D:\temp\mykrb5cc`).
9393

94-
`-l` *lifetime*
94+
[`-l`]{#option-l} *lifetime*
9595
: Sets the lifetime of a ticket. The value can be one of "h:m[:s]",
9696
"NdNhNmNs", and "N". See the [MIT krb5 Time Duration definition](
9797
http://web.mit.edu/kerberos/krb5-1.17/doc/basic/date_format.html#duration)
9898
for more information.
9999

100-
`-r` *renewable\_time*
100+
[`-r`]{#option-r} *renewable\_time*
101101
: Sets the total lifetime that a ticket can be renewed.
102102

103-
`-R`
103+
[`-R`]{#option-R}
104104
: Renews a ticket.
105105

106-
`-k`
106+
[`-k`]{#option-k}
107107
: Uses keytab
108108

109-
`-t` *keytab\_filename*
109+
[`-t`]{#option-t} *keytab\_filename*
110110
: The keytab name (for example, `D:\winnt\profiles\duke\krb5.keytab`).
111111

112112
*principal*

src/java.security.jgss/windows/man/klist.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
# Copyright (c) 2005, 2024, Oracle and/or its affiliates. All rights reserved.
2+
# Copyright (c) 2005, 2026, Oracle and/or its affiliates. All rights reserved.
33
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
#
55
# This code is free software; you can redistribute it and/or modify it
@@ -45,7 +45,7 @@ the contents of the credentials cache or keytab using the `klist` tool. The
4545

4646
## Commands
4747

48-
`-c`
48+
[`-c`]{#option-c}
4949
: Specifies that the credential cache is to be listed.
5050

5151
The following are the options for credential cache entries:
@@ -62,7 +62,7 @@ the contents of the credentials cache or keytab using the `klist` tool. The
6262
`-n`
6363
: If the `-a` option is specified, don't reverse resolve addresses.
6464

65-
`-k`
65+
[`-k`]{#option-k}
6666
: Specifies that key tab is to be listed.
6767

6868
List the keytab entries. The following are the options for keytab entries:

src/java.security.jgss/windows/man/ktab.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
# Copyright (c) 2005, 2024, Oracle and/or its affiliates. All rights reserved.
2+
# Copyright (c) 2005, 2026, Oracle and/or its affiliates. All rights reserved.
33
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
#
55
# This code is free software; you can redistribute it and/or modify it
@@ -72,12 +72,12 @@ send a keytab file over a network in the clear.
7272

7373
## Commands and Options
7474

75-
`-l` \[`-e`\] \[`-t`\]
75+
[`-l`]{#command-l} \[`-e`\] \[`-t`\]
7676
: Lists the keytab name and entries. When `-e` is specified, the encryption
7777
type for each entry is displayed. When `-t` is specified, the timestamp for
7878
each entry is displayed.
7979

80-
`-a` *principal\_name* \[*password*\] \[`-n` *kvno*\] \[`-s` *salt* \| `-f`\] \[`-append`\]
80+
[`-a`]{#command-a} *principal\_name* \[*password*\] \[`-n` *kvno*\] \[`-s` *salt* \| `-f`\] \[`-append`\]
8181
: Adds new key entries to the keytab for the given principal name with an
8282
optional *password*. If a *kvno* is specified, new keys' Key Version
8383
Numbers equal to the value, otherwise, automatically incrementing the Key
@@ -90,7 +90,7 @@ send a keytab file over a network in the clear.
9090
on the command line or in a script.** This tool will prompt for a password
9191
if it isn't specified.
9292

93-
`-d` *principal\_name* \[`-f`\] \[`-e` *etype*\] \[*kvno* \| `all`\| `old`\]
93+
[`-d`]{#command-d} *principal\_name* \[`-f`\] \[`-e` *etype*\] \[*kvno* \| `all`\| `old`\]
9494
: Deletes key entries from the keytab for the specified principal. No changes
9595
are made to the Kerberos database.
9696

@@ -115,7 +115,7 @@ send a keytab file over a network in the clear.
115115

116116
This option can be used with the `-l`, `-a` or `-d` commands.
117117

118-
`-k` *keytab name*
118+
[`-k`]{#option-k} *keytab name*
119119
: Specifies the keytab name and path with the `FILE:` prefix.
120120

121121
## Examples

0 commit comments

Comments
 (0)