1tss2_setdescription(1)      General Commands Manual     tss2_setdescription(1)
2
3
4

NAME

6       tss2_setdescription(1)
7

SYNOPSIS

9       tss2_setdescription [OPTIONS]
10

DESCRIPTION

12       tss2_setdescription(1) - This command allows an application to assign a
13       human readable description to an object in the metadata store.  The da‐
14       ta  is stored and can be returned with tss2_getdescription.  Previously
15       stored data is overwritten by this function.  If an  empty  description
16       is passed in, the stored data is deleted.
17

OPTIONS

19       These are the available options:
20
21       · -i, --description STRING:
22
23         The data to be stored as description for the object.  Optional param‐
24         eter.  Previously stored descriptions are overwritten by  this  func‐
25         tion.  If omitted any stored description is deleted.
26
27       · -p, --path STRING:
28
29         The path of the object for which the description will be stored.
30

COMMON OPTIONS

32       This  collection of options are common to all tss2 programs and provide
33       information that many users may expect.
34
35       · -h, --help [man|no-man]: Display the tools manpage.  By  default,  it
36         attempts  to  invoke  the  manpager for the tool, however, on failure
37         will output a short tool summary.  This is the same behavior  if  the
38         “man”  option argument is specified, however if explicit “man” is re‐
39         quested, the tool will provide errors from man  on  stderr.   If  the
40         “no-man”  option  if  specified, or the manpager fails, the short op‐
41         tions will be output to stdout.
42
43         To successfully use the manpages feature requires the manpages to  be
44         installed or on MANPATH, See man(1) for more details.
45
46       · -v,  --version:  Display version information for this tool, supported
47         tctis and exit.
48

EXAMPLE

50              tss2_setdescription --path HS/SRK --description description
51

RETURNS

53       0 on success or 1 on failure.
54

BUGS

56       Github Issues (https://github.com/tpm2-software/tpm2-tools/issues)
57

HELP

59       See the Mailing List (https://lists.01.org/mailman/listinfo/tpm2)
60
61
62
63tpm2-tools                        APRIL 2019            tss2_setdescription(1)
Impressum