describe-options.txt 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. # Short (less than one line) descriptions of tarsnap options.
  2. #
  3. # Format:
  4. # --option \t+ description [\t+ (MODE|DUP-.*)]
  5. --aggressive-networking use multiple TCP connections
  6. --archive-names read a list of archive names from a file
  7. --cachedir specify cache directory
  8. --check-links warn unless all links to each file are archived
  9. --checkpoint-bytes add a checkpoint after every ARG bytes of uploaded data
  10. --chroot chroot to the current directory after -C options
  11. --configfile add file to the list of configuration files to be read
  12. --creationtime manually specify a creation time for the archive
  13. --csv-file write statistics in CSV format to a file
  14. --disk-pause often pause for ARG ms while creating an archive
  15. --dry-run do not really create an archive; just simulate doing so
  16. --dry-run-metadata do not really create an archive; just simulate the metadata
  17. --dump-config print all config lines
  18. --exclude do not process certain files or directories
  19. --fast-read stop after the first entry which matches the ARG DUP-q
  20. --force-resources force the decryption of a passphrase-encrypted keyfile
  21. --fsck perform some integrity checks and reconstruct cache MODE
  22. --fsck-prune run as --fsck, but prune any corrupt archives MODE
  23. --hashes make --list-archives print hashes
  24. --humanize-numbers use SI prefixes for --print-stats
  25. --include process only certain files or directories
  26. --initialize-cachedir create and initialize the cachedir MODE
  27. --insane-filesystems allow descent into synthetic filesystems such as procfs
  28. --iso-dates print dates as yyyy-mm-dd hh:mm:ss
  29. --keep-going keep going after finding an archive which does not exist
  30. --keep-newer-files keep files which are newer than the extracted files
  31. --keyfile specify key file
  32. --list-archives print the names of archives stored MODE
  33. --lowmem reduce memory usage by not caching small files
  34. --maxbw stop if more than ARG bytes of upstream bw is used
  35. --maxbw-rate limit bandwidth to ARG bytes per second
  36. --maxbw-rate-down limit download bandwidth to ARG bytes per second
  37. --maxbw-rate-up limit upload bandwidth to ARG bytes per second
  38. --newer only add files and dirs newer than the given date
  39. --newer-mtime like --newer, but it uses mtime instead of ctime
  40. --newer-mtime-than like --newer-than, but it uses mtime instead of ctime
  41. --newer-than only include files and dirs newer than the given file
  42. --no-aggressive-networking ignore any aggressive-networking option
  43. --no-config-exclude ignore any exclude option
  44. --no-config-include ignore any include option
  45. --no-default-config do not read the default configuration files
  46. --no-disk-pause ignore any disk-pause option
  47. --no-force-resources ignore any force-resources option
  48. --no-humanize-numbers ignore any humanize-numbers option
  49. --no-insane-filesystems ignore any insane-filesystems option
  50. --no-iso-dates ignore any iso-dates option
  51. --no-maxbw ignore any maximum bandwidth option
  52. --no-maxbw-rate-down ignore any download maximum bandwidth option
  53. --no-maxbw-rate-up ignore any upload maximum bandwidth option
  54. --no-nodump ignore any nodump option
  55. --no-print-stats ignore any print-stats option
  56. --no-progress-bytes ignore any progress-bytes option
  57. --no-quiet ignore any quiet option
  58. --no-retry-forever ignore any retry-forever option
  59. --no-snaptime ignore any snaptime option
  60. --no-store-atime ignore any store-atime option
  61. --no-totals ignore any totals option
  62. --nodump honor the nodump file flag by skipping this file
  63. --noisy-warnings be verbose when warning about network glitches
  64. --normalmem ignore any lowmem or verylowmem option
  65. --nuke delete all of the archives stored MODE
  66. --null filenames or patterns are separated by null characters
  67. --numeric-owner ignore symbolic user and group names when restoring
  68. --one-file-system do not cross mount points
  69. --passphrase read passphrase from ARG instead of /dev/tty
  70. --print-stats print global statistics concerning stored archives MODE
  71. --print-stats print statistics for the archive
  72. --progress-bytes print a progress messsage after each X bytes
  73. --quiet avoid printing some warnings
  74. --recover recover a partial archive from a checkpoint MODE
  75. --resume-extract don't extract files that are already on disk
  76. --retry-forever continue trying to connect to Tarsnap server forever
  77. --snaptime file with mtime prior to snapshot creation time
  78. --store-atime store file access times
  79. --strip-components remove the specified ARG number of leading path elements
  80. --totals print the size of the archive after creating it
  81. --verify-config check the configuration file(s) for syntactic errors MODE
  82. --version print version number of tarsnap and exit MODE
  83. --verylowmem reduce memory usage, by not caching anything
  84. -C change directory before adding files
  85. -H store the targets of a symbolic links
  86. -I read the list of names to be extracted from filename ARG
  87. -L all symbolic links will be followed
  88. -O write files to stdout (-x) or stderr (-t)
  89. -P preserve pathnames
  90. -S extract files as sparse files
  91. -T read the list of files to be extracted from filename ARG
  92. -U unlink files before creating them
  93. -X read a list of exclusion patterns from filename ARG
  94. -c create an archive MODE
  95. -d delete the specified archive MODE
  96. -f specify name of archive to operate on
  97. -h print help
  98. -k do not overwrite existing files
  99. -l warn unless all links to each file are archived
  100. -m do not extract modification time
  101. -n do not recursively archive the contents of directories
  102. -o use the current uid and gid; requires -p
  103. -p preserve file permissions
  104. -q stop after the first entry which matches the ARG
  105. -r extract an archive to a tar stream and write to stdout MODE
  106. -s modify file or archive member names according to pattern
  107. -t list archive contents to stdout MODE
  108. -v produce verbose output
  109. -w ask for confirmation for every action
  110. -x extract to disk from the archive MODE