nethsm-openpgp(1)

πŸ“¦ version 0.10.0, in arch rolling

✨ nethsm-openpgp(1) ✨

okay bestie, welcome to the General Commands Manual entry for nethsm-openpgp β€” this is the page you want when you're poking at the nethsm openpgp command and you're like "wait what does this even do" 🫢 we gotchu.


🌸 NAME 🌸

nethsm-openpgp β€” literally The nethsm openpgp command. that's the whole vibe. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

nethsm openpgp [-a|--auth-passphrase-file] [-c|--config] [-l|--label]
[-u|--user] [-h|--help] <subcommands>

so you run nethsm openpgp, you sprinkle some optional flags on it, and then you give it a <subcommands> β€” that's where the actual action lives ✨


πŸŽ€ DESCRIPTION πŸŽ€

The nethsm openpgp command. that's it, that's the description, no cap πŸ’€ it's the umbrella command β€” the main character β€” and all the actual work happens in the subcommands listed down below. iykyk.


πŸ’– OPTIONS πŸ’–

  • -a, --auth-passphrase-file <AUTH_PASSPHRASE_FILE> β€” the path to a file holding a passphrase for authentication πŸ”‘

the passphrase in that file must be the one for the user you picked for the command. like, the user, not some random other user, bestie.

this option can be provided multiple times, which you need for commands that require multiple roles at once. and when you pass multiple passphrase files, ordering matters β€” the files get assigned to the respective user given by the --user option. so don't shuffle them like a playlist πŸ™ˆ

may also be specified with the NETHSM_AUTH_PASSPHRASE_FILE environment variable.

  • -c, --config <CONFIG> β€” the path to a custom configuration file πŸ—‚οΈ

if you specify it, that custom configuration file gets used instead of the default configuration file location. no default, all yours. ✨

may also be specified with the NETHSM_CONFIG environment variable.

  • -l, --label <LABEL> β€” a label uniquely identifying a device in the configuration file 🏷️

must be provided if more than one device is set up in the configuration file. so if your config file is serving a whole little friend group of devices, you gotta name names.

may also be specified with the NETHSM_LABEL environment variable.

  • -u, --user <USER> β€” a user name which is used for a command πŸ‘‘

can be provided if no user name is set up in the configuration file for a device. must be provided if several user names of the same target role are set up in the configuration file for a device. so: optional sometimes, mandatory other times, iconic always.

this option can be provided multiple times, which is needed for commands that require multiple roles at once.

may also be specified with the NETHSM_USER environment variable.

  • -h, --help β€” print help (see a summary with -h) 🫢

🌈 SUBCOMMANDS 🌈

ngl if you're ever lost, just hit nethsm-openpgp-help(1) and let the subcommands guide you home 🧚

and that's the whole page, bestie!! πŸ“ this masterpiece lives in the nethsm-openpgp manual as nethsm-openpgp(1) β€” go forth, pass those passphrase files in the right order, and slay πŸ’œπŸ”₯

πŸ“¦ where this page comes from