RESTIC-FEATURES(1)

πŸ“¦
version 0.19.1 Β· 3 versions
, in arch rolling, epel 10, epel 9, fedora 43, fedora 44, nixpkgs unstable, ubuntu stonking

πŸ’– restic-features(1) πŸ’–

okay bestie, so this is a page from the restic backup(1) manual β€” yes the whole thing lives under that header, we don't make the rules πŸ’… β€” and it's all about the restic-features command. pull up a chair, we're gonna read it together 🫢


✨ NAME ✨

restic-features β€” print list of feature flags πŸŽ€


🌸 SYNOPSIS 🌸

restic features [flags]

πŸ¦‹ DESCRIPTION πŸ¦‹

so the features command literally just prints out a list of all the supported feature flags. that's it. that's the job. iconic behaviour honestly πŸ‘‘

to actually pass feature flags to restic, you set the RESTIC_FEATURES environment variable to something like featureA=true,featureB=false. and listen β€” if you specify a feature flag that doesn't exist? that's an error. no cap. ❌

now here's the part you actually need to know, because feature flags come in four whole states and they are NOT the same vibe:

  • alpha β€” disabled by default, and it may change in arbitrary ways between restic versions, or get removed entirely. chaotic. unstable. living its truth. πŸ™ˆ
  • beta β€” enabled by default, but it can still change in minor ways or be removed. it's giving "we're pretty sure but don't quote us" 😌
  • stable β€” always enabled and it cannot be disabled. the flag itself will be removed in a future restic version. it's settled, periodt ✨
  • deprecated β€” always disabled and it cannot be enabled. this flag will also be removed in a future restic version. it's over, we're moving on πŸ’€

πŸ”₯ EXIT STATUS πŸ”₯

  • exit status is 0 if the command was successful πŸ’–
  • exit status is 1 if there was any error 😭

πŸ’… OPTIONS πŸ’…

  • -h, --help[=false] β€” help for features πŸŽ€

πŸ‘‘ OPTIONS INHERITED FROM PARENT COMMANDS πŸ‘‘

these are the ones you get for free from the parent command, bestie. they're all here, every single one:

  • --cacert=[] β€” file to load root certificates from (default: use system certificates or $RESTIC_CACERT) 🌈
  • --cache-dir="" β€” set the cache directory. (default: use system default cache directory) πŸ“
  • --cleanup-cache[=false] β€” auto remove old cache directories 🧚
  • --compression=auto β€” compression mode (only available for repository format version 2), one of (auto|off|fastest|better|max) (default: $RESTIC_COMPRESSION) πŸ’œ
  • --http-user-agent="" β€” set a http user agent for outgoing http requests ✨
  • --insecure-no-password[=false] β€” use an empty password for the repository, must be passed to every restic command (insecure) ⚠️
  • --insecure-tls[=false] β€” skip TLS certificate verification when connecting to the repository (insecure) ⚠️
  • --json[=false] β€” set output mode to JSON for commands that support it 🌸
  • --key-hint="" β€” key ID of key to try decrypting first (default: $RESTIC_KEY_HINT) πŸ”‘
  • --limit-download=0 β€” limits downloads to a maximum rate in KiB/s. (default: unlimited) πŸ¦‹
  • --limit-upload=0 β€” limits uploads to a maximum rate in KiB/s. (default: unlimited) πŸ¦‹
  • --no-cache[=false] β€” do not use a local cache πŸ™…
  • --no-extra-verify[=false] β€” skip additional verification of data before upload (see documentation) πŸ‘€
  • --no-lock[=false] β€” do not lock the repository, this allows some operations on read-only repositories πŸ”“
  • -o, --option=[] β€” set extended option (key=value, can be specified multiple times) πŸ’«
  • --pack-size=0 β€” set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE) πŸ“¦
  • --password-command="" β€” shell command to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND) 🀫
  • -p, --password-file="" β€” file to read the repository password from (default: $RESTIC_PASSWORD_FILE) πŸ”
  • -q, --quiet[=false] β€” do not output comprehensive progress report 🀐
  • -r, --repo="" β€” repository to backup to or restore from (default: $RESTIC_REPOSITORY) πŸ—‚οΈ
  • --repository-file="" β€” file to read the repository location from (default: $RESTIC_REPOSITORY_FILE) πŸ“
  • --retry-lock=0s β€” retry to lock the repository if it is already locked, takes a value like 5m or 2h (default: no retries) ⏰
  • --stuck-request-timeout=5m0s β€” duration after which to retry stuck requests ⏳
  • --tls-client-cert="" β€” path to a file containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT) πŸͺͺ
  • -v, --verbose[=0] β€” be verbose (specify multiple times or a level using --verbose=n, max level/times is 2) πŸ—£οΈ

🌟 SEE ALSO 🌟


and that's the whole page, bestie!! you ate that. go forth and feature-flag responsibly 🫢✨

this lil masterpiece was generated by restic generate, and the date on it is Jan 2017 β€” vintage, honestly. the source/version line and the date, mentioned here at the end like a cute sign-off, because that's where the footer lived. mwah πŸ’‹

πŸ“¦ where this page comes from