From 6a6898a2ea2e8ed2667cace13456b00540a5a269 Mon Sep 17 00:00:00 2001 From: Peter Marschall Date: Sun, 21 Aug 2011 13:30:26 +0200 Subject: [PATCH] pkcs11-tool.1.xml: sort options alphabetically --- doc/tools/pkcs11-tool.1.xml | 347 ++++++++++++++++++------------------ 1 file changed, 174 insertions(+), 173 deletions(-) diff --git a/doc/tools/pkcs11-tool.1.xml b/doc/tools/pkcs11-tool.1.xml index 529329fc..56c8e61d 100644 --- a/doc/tools/pkcs11-tool.1.xml +++ b/doc/tools/pkcs11-tool.1.xml @@ -35,6 +35,110 @@ Options + + + path + + Extract information from path + (DER-encoded certificate file) and create the corresponding + attributes when writing an object to the token. Example: the + certificate subject name is used to create the CKA_SUBJECT + attribute. + + + + + , + + + Change the user PIN on the token + + + + + , + + + Hash some data. + + + + + id, + id + + Specify the id of the object to operate on. + + + + + + + Initializes the user PIN. This option + differs from --change-pin in that it sets the user PIN + for the first time. Once set, the user PIN can be changed + using . + + + + + + + Initialize a token: set the token label as + well as a Security Officer PIN (the label must be specified + using ). + + + + + path, + path + + Specify the path to a file for input. + + + + + , + + + Generate a new key pair (public and private pair.) + + + + + name, + name + + Specify the name of the object to operate on + (or the token label when + is used). + + + + + , + + + Display a list of mechanisms supported by the token. + + + + + , + + + Display a list of objects. + + + + + , + + + Display a list of available slots on the token. + + , @@ -45,6 +149,42 @@ provided on the command line. + + + mechanism, + mechanism + + Use the specified mechanism + for token operations. See for a list + of mechanisms supported by your token. + + + + + mod + + Specify a PKCS#11 module (or library) to + load. + + + + + path, + path + + Test a Mozilla-like keypair generation + and certificate request. Specify the path + to the certificate file. + + + + + path, + path + + Specify the path to a file for output. + + pin, @@ -60,49 +200,10 @@ - pin + id, + id - Use the given pin as the - Security Officer PIN for some token operations (token - initialization, user PIN initialization, etc). The same - warning as also applies here. - - - - - - - Initializes a token: set the token label as - well as a Security Officer PIN (the label must be specified - using ). - - - - - - - Initializes the user PIN. This option - differs from --change-pin in that it sets the user PIN - for the first time. Once set, the user PIN can be changed - using . - - - - - , - - - Change the user PIN on the token - - - - - , - - - Performs some tests on the token. This - option is most useful when used with either - or . + Set the CKA_ID of the object. @@ -110,31 +211,7 @@ , - Displays general token information. - - - - - , - - - Displays a list of available slots on the token. - - - - - , - - - Displays a list of mechanisms supported by the token. - - - - - , - - - Displays a list of objects. + Display general token information. @@ -145,70 +222,6 @@ Sign some data. - - - , - - - Hash some data. - - - - - mechanism, - mechanism - - Use the specified mechanism - for token operations. See for a list - of mechanisms supported by your token. - - - - - , - - - Generate a new key pair (public and private pair.) - - - - - id, - path - - Write a key or certificate object to the token. - path points to the DER-encoded certificate or key file. - - - - - - type, - type - - Specify the type of object to operate on. - Examples are cert, privkey - and pubkey. - - - - - id, - id - - Specify the id of the object to operate on. - - - - - name, - name - - Specify the name of the object to operate on - (or the token label when - is used). - - id @@ -234,74 +247,62 @@ label - Specify the label of token. Will be used the first slot, that has the - inserted token with this label. + Specify the label of token. + Will be used the first slot, that has the inserted token with this + label. - id, - id + pin - Set the CKA_ID of the object. + Use the given pin as the + Security Officer PIN for some token operations (token + initialization, user PIN initialization, etc). The same + warning as also applies here. - path + , + - Extract information from path - (DER-encoded certificate file) and create the corresponding - attributes when writing an object to the token. Example: the - certificate subject name is used to create the CKA_SUBJECT - attribute. + Perform some tests on the token. This + option is most useful when used with either + or . - path, - path + type, + type - Specify the path to a file for input. - - - - - path, - path - - Specify the path to a file for output. - - - - - mod - - Specify a PKCS#11 module (or library) to - load. - - - - - path, - path - - Tests a Mozilla-like keypair generation - and certificate request. Specify the path - to the certificate file. + Specify the type of object to operate on. + Examples are cert, privkey + and pubkey. , - Causes pkcs11-tool to be + Cause pkcs11-tool to be more verbose.NB! This does not affect OpenSC debugging level! To set OpenSC PKCS#11 module into debug - mode, set the OPENSC_DEBUG environment variable to a + mode, set the OPENSC_DEBUG environment variable to a non-zero number. + + + id, + path + + Write a key or certificate object to the token. + path points to the DER-encoded certificate or key file. + + +