tss2_setdescription(1)

📦
version 5.8 · 8 versions
, in arch rolling

💅 tss2_setdescription — the tss2_setdescription(1) glow-up

okay so bestie, welcome to tss2_setdescription(1), a General Commands Manual situation, and honestly? this one's a little cutie. it's the tool that lets you slap a human-readable description on stuff in the FAPI metadata store. yes, like a little name tag for your object. iconic behavior honestly 🎀

✨ SYNOPSIS ✨

tss2_setdescription [OPTIONS]

that's it. that's the whole vibe. options only, no positional nonsense. we love a clean entry 🫶

🔍 SEE ALSO 🔍

  • fapi-config(5) — this is your go-to when you wanna adjust Fapi parameters, like which cryptographic profile is being used, or the TCTI, or the directories where the Fapi metadata storages live. lowkey essential reading ngl 💜
  • fapi-profile(5) — and this one's for figuring out the cryptographic algorithms and parameters for all keys and operations of a specific TPM interaction. we're talking the name hash algorithm, the asymmetric signature algorithm, scheme and parameters, and PCR bank selection. very "the details matter" energy ✨

🌸 DESCRIPTION 🌸

tss2_setdescription(1) — listen. this command lets an application assign a human readable description to an object in the FAPI metadata store. that's it, that's the whole job, and it does it beautifully 💅

the stored data can be handed back to you later with tss2_getdescription. cute, right? a little set-and-get duo, iykyk.

heads up though: previously stored data is overwritten by this function. like, gone. replaced. no cap. and if an empty description is passed in, the stored data is deleted. so yeah, be normal about it 🙈

🦋 OPTIONS 🦋

these are the available options, bestie, collect them all:

  • -i, --description=STRING — the data to be stored as the description for the object. it's an optional parameter, so no pressure. previously stored descriptions are overwritten by this function (again: overwritten, fr fr). and if you omit it entirely, any stored description gets deleted. vanished. poof 💀
  • -p, --path=STRING — the path of the object you want the description stored for. like, which object are we naming today bestie? 📍

🌈 COMMON OPTIONS 🌈

this little collection of options is common to all tss2 programs, and they provide info that honestly many users just expect to be there. main character energy for shared flags, periodt 👑

  • -h, --help [man|no-man] — displays the tool's manpage. by default, it attempts to invoke the manpager for the tool, however, on failure it will output a short tool summary. same behavior applies if the "man" option argument is specified — except if explicit "man" is requested, the tool will provide errors from man on stderr. if the "no-man" option is specified, or the manpager fails, the short options will be output to stdout. ✨
to successfully use the manpages feature, the manpages need to be installed or on MANPATH. see man(1) for more details. don't skip this part bestie, i'm begging 🫶
  • -v, --version — displays version information for this tool, supported tctis, and exits. simple, clean, slays every time 💖

🍓 EXAMPLE 🍓

here's the moment you've been waiting for, the demo:

tss2_setdescription --path=HS/SRK --description=description

look at her go. path set, description set, done. ate and left no crumbs 🔥

⭐ RETURNS ⭐

  • 0 on success
  • 1 on failure

that's the whole scoring system. binary. no in-between. very "you either slayed or you didn't" of it 💀

💀 BUGS 💀

Github Issues. that's where the bugs live. go bother them there 🙈

🧚 HELP 🧚

See the Mailing List. the community is there, they're lovely, they'll help you out 🫶

👑 License 👑

This work is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0). get you a license that lets you share the love, am i right 💜

okay that's the whole page bestie!! 🌸 this lil beauty comes to you from tpm2-tools, dated APRIL 2019 — yes she's a vintage icon and she still serves 💅✨ bye pookie, go set some descriptions 🎀

📦 where this page comes from