RESTIC-PRUNE(1)

πŸ’… restic-prune(1) β€” the glow-up edition

okay bestie, so this is a page from the restic backup manual, and today's main character is restic-prune πŸŽ€


✨ NAME ✨

restic-prune β€” Remove unneeded data from the repository πŸ§ΉπŸ¦‹


🌸 SYNOPSIS 🌸

restic prune [flags]

πŸ’– DESCRIPTION πŸ’–

The "prune" command checks the repository and removes data that is not referenced and therefore not needed any more. it's giving "spring cleaning but make it a garbage collector" βœ¨πŸ—‘οΈ


πŸ”₯ EXIT STATUS πŸ”₯

the vibe check results, fr fr:

  • Exit status is 0 if the command was successful πŸ‘‘
  • Exit status is 1 if there was any error 😭
  • Exit status is 10 if the repository does not exist πŸ’€
  • Exit status is 11 if the repository is already locked πŸ”’
  • Exit status is 12 if the password is incorrect πŸ™ˆ

πŸŽ€ OPTIONS πŸŽ€

  • -n, --dry-run[=false] β€” do not modify the repository, just print what would be done πŸ‘€ (window shopping, no spending)
  • -h, --help[=false] β€” help for prune 🫢
  • --max-repack-size="" β€” stop after repacking this much data in total (allowed suffixes for size: k/K, m/M, g/G, t/T) 🧺
  • --max-unused="5%" β€” tolerate given limit of unused data (absolute value in bytes with suffixes k/K, m/M, g/G, t/T, a value in % or the word 'unlimited') 🌈
  • --repack-cacheable-only[=false] β€” only repack packs which are cacheable ✨
  • --repack-smaller-than="" β€” pack below-limit packfiles (allowed suffixes: m/M) πŸ“
  • --repack-uncompressed[=false] β€” repack all uncompressed data πŸ’œ
  • --unsafe-recover-no-free-space="" β€” UNSAFE, READ THE DOCUMENTATION BEFORE USING! Try to recover a repository stuck with no free space. Do not use without trying out 'prune --max-repack-size 0' first. 🚨
bestie. i am holding your hand when i say this: that last one literally says UNSAFE in all caps, and it tells you to read the docs and to try 'prune --max-repack-size 0' first. do not freestyle it. πŸ’€

πŸ¦‹ OPTIONS INHERITED FROM PARENT COMMANDS πŸ¦‹

  • --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 πŸ‘‘

  • restic(1) β€” go read the parent, it's iconic 🫢

that's the whole page, no notes, every flag accounted for πŸ’–

this lil' page was generated by restic generate, dated Jan 2017, and it lives in the restic backup(1) manual. mwah, slay, periodt πŸ’…βœ¨πŸŒΈ

πŸ“¦ where this page comes from