tss2_list(1)

📦
version 5.8 · 8 versions
, in arch rolling

✨ tss2_list(1) — the manual page, bestie ✨

Okay so literally, this is the manual for tss2_list, a General Commands Manual page. Let me break it down for you, no cap.

🌸 NAME 🌸

tss2_list(1) — the tool that lists stuff in your FAPI metadata store, fr fr.

✨ SYNOPSIS ✨

tss2_list [OPTIONS]

That's it. Just the command and whatever options you're feeling.

🦋 SEE ALSO 🦋

  • fapi-config(5) — use this to adjust Fapi parameters, like the cryptographic profile it's using, the TCTI, or the directories for the Fapi metadata storages. Super handy, iykyk.
  • fapi-profile(5) — this one helps you set the cryptographic algorithms and parameters for all keys and operations of a specific TPM interaction. Think: name hash algorithm, asymmetric signature algorithm, scheme and parameters, and PCR bank selection. It's giving very config-heavy main character energy.

🎀 DESCRIPTION 🎀

tss2_list(1) — okay so basically, this command enumerates (that means lists, bestie) all the objects in the FAPI metadata store for whatever path you give it. Lowkey useful for seeing what's in there.

💅 OPTIONS 💅

These are the options you can use. Iconic.

  • -f, --force — forces overwriting of the output file. Like, it's gonna write over whatever's already there, whether you like it or not. No cap, be careful with this one.
  • -p, --searchPath=STRING — this is the path that identifies the root of the search. It's optional! If you don't include it, it'll search all the entities. The way that it just defaults to everything is wild.
  • -o, --pathList=FILENAME or - (for stdout) — this returns the colon-separated list of paths. Also optional. If you omit it, the results will be printed to - (which means stdout, you know this). Slay.

🌈 COMMON OPTIONS 🌈

These are the options that are common to all tss2 programs. They provide info that many users might expect to have handy. Obsessed with consistency.

  • -h, --help [man|no-man] — displays the tool's manpage. By default, it tries to invoke the manpager for the tool. But if that fails, it'll output a short tool summary instead. That's the same behavior if you specify the "man" option argument, but if you explicitly ask for "man", the tool will provide errors from man on stderr. If you specify --help none or "no-man", or if the manpager fails, the short options will be printed to stdout.
To actually use the manpages feature, you need the manpages installed or on your MANPATH. Check out man(1) for more details, k?
  • -v, --version — displays version information for this tool, including supported tctis, and then exits. Periodt.

🫶 EXAMPLES 🫶

List all entities and print results to stdout

tss2_list

Literally just that. No extra flags needed. So clean.

List all entities under the HS path and print results to file

tss2_list --searchPath=HS --pathList=output.file

See how we used --searchPath=HS to only look under the HS path? And --pathList=output.file to send the colon-separated list to a file called output.file? Iconic behavior, truly.

💀 RETURNS 💀

  • 0 on success
  • 1 on failure

That's it. Simple. If it worked, zero. If it didn't, one. No in-between, bestie.

🙈 BUGS 🙈

Github Issues. That's where the bugs live. Go check 'em out if something's giving you grief.

💜 HELP 💜

See the Mailing List. That's the move for help.

👑 License 👑

This work is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0). So like, you can share it, just give credit. Slay.

tpm2-tools · APRIL 2019 · tss2_list(1) — that's the source/version and date, bestie. Now go forth and list those entities. 🎀✨
📦 where this page comes from