summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNikos Mavrogiannopoulos <nmav@gnutls.org>2015-09-12 11:47:09 +0200
committerNikos Mavrogiannopoulos <nmav@gnutls.org>2015-09-12 11:47:09 +0200
commit1bfa61caa217e351d775e0e84612272fc11c1fec (patch)
tree2edb595099f425dc8df32dcab4c778ce0f9e6835 /doc
parentfb2d6e86104408a58823519d2fd0ee3ab049108c (diff)
downloadgnutls-1bfa61caa217e351d775e0e84612272fc11c1fec.tar.gz
tpmtool.1: updated
Diffstat (limited to 'doc')
-rw-r--r--doc/manpages/tpmtool.1104
1 files changed, 66 insertions, 38 deletions
diff --git a/doc/manpages/tpmtool.1 b/doc/manpages/tpmtool.1
index 3b34351263..2c36118de0 100644
--- a/doc/manpages/tpmtool.1
+++ b/doc/manpages/tpmtool.1
@@ -1,28 +1,48 @@
-.TH tpmtool 1 "09 Nov 2013" "@VERSION@" "User Commands"
+.de1 NOP
+. it 1 an-trap
+. if \\n[.$] \,\\$*\/
+..
+.ie t \
+.ds B-Font [CB]
+.ds I-Font [CI]
+.ds R-Font [CR]
+.el \
+.ds B-Font B
+.ds I-Font I
+.ds R-Font R
+.TH tpmtool 1 "10 Aug 2015" "@VERSION@" "User Commands"
.\"
-.\" DO NOT EDIT THIS FILE (tpmtool-args.man)
-.\"
-.\" It has been AutoGen-ed November 9, 2013 at 01:03:34 PM by AutoGen 5.18
-.\" From the definitions ../../src/tpmtool-args.def.tmp
-.\" and the template file agman-cmd.tpl
+.\" DO NOT EDIT THIS FILE (in-mem file)
.\"
+.\" It has been AutoGen-ed
+.\" From the definitions ../../src/tpmtool-args.def.tmp
+.\" and the template file agman-cmd.tpl
.SH NAME
-tpmtool \- GnuTLS TPM tool
+\f\*[B-Font]tpmtool\fP
+\- GnuTLS TPM tool
.SH SYNOPSIS
-.B tpmtool
+\f\*[B-Font]tpmtool\fP
.\" Mixture of short (flag) options and long options
-.RB [ \-\fIflag\fP " [\fIvalue\fP]]... [" \-\-\fIopt\-name\fP "[[=| ]\fIvalue\fP]]..."
-.PP
+[\f\*[B-Font]\-flags\f[]]
+[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
+[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
+.sp \n(Ppu
+.ne 2
+
All arguments must be options.
-.PP
+.sp \n(Ppu
+.ne 2
+
.SH "DESCRIPTION"
Program that allows handling cryptographic data from the TPM chip.
.SH "OPTIONS"
.TP
-.BR \-d " \fInumber\fP, " \-\-debug "=" \fInumber\fP
+.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]number\f[]
Enable debugging.
This option takes an integer number as its argument.
-The value of \fInumber\fP is constrained to being:
+The value of
+\f\*[I-Font]number\f[]
+is constrained to being:
.in +4
.nf
.na
@@ -32,28 +52,28 @@ in the range 0 through 9999
.sp
Specifies the debug level.
.TP
-.BR \-\-infile "=\fIfile\fP"
+.NOP \f\*[B-Font]\-\-infile\f[]=\f\*[I-Font]file\f[]
Input file.
.sp
.TP
-.BR \-\-outfile "=\fIstring\fP"
+.NOP \f\*[B-Font]\-\-outfile\f[]=\f\*[I-Font]string\f[]
Output file.
.sp
.TP
-.BR \-\-generate\-rsa
+.NOP \f\*[B-Font]\-\-generate\-rsa\f[]
Generate an RSA private-public key pair.
.sp
Generates an RSA private-public key pair in the TPM chip.
The key may be stored in filesystem and protected by a PIN, or stored (registered)
in the TPM chip flash.
.TP
-.BR \-\-register
+.NOP \f\*[B-Font]\-\-register\f[]
Any generated key will be registered in the TPM.
This option must appear in combination with the following options:
generate-rsa.
.sp
.TP
-.BR \-\-signing
+.NOP \f\*[B-Font]\-\-signing\f[]
Any generated key will be a signing key.
This option must appear in combination with the following options:
generate-rsa.
@@ -61,7 +81,7 @@ This option must not appear in combination with any of the following options:
legacy.
.sp
.TP
-.BR \-\-legacy
+.NOP \f\*[B-Font]\-\-legacy\f[]
Any generated key will be a legacy key.
This option must appear in combination with the following options:
generate-rsa.
@@ -69,7 +89,7 @@ This option must not appear in combination with any of the following options:
signing.
.sp
.TP
-.BR \-\-user
+.NOP \f\*[B-Font]\-\-user\f[]
Any registered key will be a user key.
This option must appear in combination with the following options:
register.
@@ -78,7 +98,7 @@ system.
.sp
The generated key will be stored in a user specific persistent storage.
.TP
-.BR \-\-system
+.NOP \f\*[B-Font]\-\-system\f[]
Any registred key will be a system key.
This option must appear in combination with the following options:
register.
@@ -87,30 +107,36 @@ user.
.sp
The generated key will be stored in system persistent storage.
.TP
-.BR \-\-pubkey "=\fIurl\fP"
+.NOP \f\*[B-Font]\-\-pubkey\f[]=\f\*[I-Font]url\f[]
Prints the public key of the provided key.
.sp
.TP
-.BR \-\-list
+.NOP \f\*[B-Font]\-\-list\f[]
Lists all stored keys in the TPM.
.sp
.TP
-.BR \-\-delete "=\fIurl\fP"
+.NOP \f\*[B-Font]\-\-delete\f[]=\f\*[I-Font]url\f[]
Delete the key identified by the given URL (UUID)..
.sp
.TP
-.BR \-\-sec\-param "=\fIsecurity parameter\fP"
-Specify the security level [low, legacy, normal, high, ultra]..
+.NOP \f\*[B-Font]\-\-test\-sign\f[]=\f\*[I-Font]url\f[]
+Tests the signature operation of the provided object.
+.sp
+It can be used to test the correct operation of the signature operation.
+This operation will sign and verify the signed data.
+.TP
+.NOP \f\*[B-Font]\-\-sec\-param\f[]=\f\*[I-Font]security\f[] \f\*[I-Font]parameter\f[]
+Specify the security level [low, legacy, medium, high, ultra]..
.sp
This is alternative to the bits option. Note however that the
values allowed by the TPM chip are quantized and given values may be rounded up.
.TP
-.BR \-\-bits "=\fInumber\fP"
+.NOP \f\*[B-Font]\-\-bits\f[]=\f\*[I-Font]number\f[]
Specify the number of bits for key generate.
This option takes an integer number as its argument.
.sp
.TP
-.BR \-\-inder, " \fB\-\-no\-inder\fP"
+.NOP \f\*[B-Font]\-\-inder\f[], \f\*[B-Font]\- Fl \-no\-inder\f[]
Use the DER format for keys..
The \fIno\-inder\fP form will disable the option.
.sp
@@ -118,22 +144,23 @@ The input files will be assumed to be in the portable
DER format of TPM. The default format is a custom format used by various
TPM tools
.TP
-.BR \-\-outder, " \fB\-\-no\-outder\fP"
+.NOP \f\*[B-Font]\-\-outder\f[], \f\*[B-Font]\- Fl \-no\-outder\f[]
Use DER format for output keys.
The \fIno\-outder\fP form will disable the option.
.sp
The output will be in the TPM portable DER format.
.TP
-.BR \-h , " \-\-help"
+.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[]
Display usage information and exit.
.TP
-.BR \-! , " \-\-more-help"
+.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
Pass the extended usage information through a pager.
.TP
-.BR \-v " [{\fIv|c|n\fP}]," " \-\-version" "[={\fIv|c|n\fP}]"
+.NOP \f\*[B-Font]\-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\f[]}]}]
Output version of program and exit. The default mode is `v', a simple
version. The `c' mode will print copyright information and `n' will
print the full copyright notice.
+.PP
.SH EXAMPLES
To generate a key that is to be stored in filesystem use:
.br
@@ -178,24 +205,25 @@ $ tpmtool \-\-list
.SH "EXIT STATUS"
One of the following exit values will be returned:
.TP
-.BR 0 " (EXIT_SUCCESS)"
+.NOP 0 " (EXIT_SUCCESS)"
Successful program execution.
.TP
-.BR 1 " (EXIT_FAILURE)"
+.NOP 1 " (EXIT_FAILURE)"
The operation failed or the command syntax was not valid.
.TP
-.BR 70 " (EX_SOFTWARE)"
+.NOP 70 " (EX_SOFTWARE)"
libopts had an internal operational error. Please report
it to autogen-users@lists.sourceforge.net. Thank you.
+.PP
.SH "SEE ALSO"
p11tool (1), certtool (1)
.SH "AUTHORS"
-Nikos Mavrogiannopoulos, Simon Josefsson and others; see /usr/share/doc/gnutls-bin/AUTHORS for a complete list.
+Nikos Mavrogiannopoulos, Simon Josefsson and others; see /usr/share/doc/gnutls/AUTHORS for a complete list.
.SH "COPYRIGHT"
-Copyright (C) 2000-2012 Free Software Foundation all rights reserved.
+Copyright (C) 2000-@YEAR@ Free Software Foundation, and others all rights reserved.
This program is released under the terms of the GNU General Public License, version 3 or later.
.SH "BUGS"
-Please send bug reports to: bug-gnutls@gnu.org
+Please send bug reports to: @PACKAGE_BUGREPORT@
.SH "NOTES"
This manual page was \fIAutoGen\fP-erated from the \fBtpmtool\fP
option definitions.