Commit Graph

57 Commits

Author SHA1 Message Date
Michael Eischer 8abbc3703d doc: update embedded help output and misc typos (#21804) 2026-05-15 20:21:04 +02:00
Michael Eischer 5d70bf9f10 Merge pull request #5643 from kjetilho/doc-restore
Improve documentation for restore
2026-05-14 14:51:45 +02:00
Michael Eischer 6c63c1c244 partially modernize restore command output 2026-05-14 13:43:54 +02:00
Michael Eischer acc95531a4 docs/restore: clarify --path option example, subfolder syntax and --delete option 2026-05-14 13:42:33 +02:00
Michael Eischer 93357440da doc: describe effects of relative paths on snapshot structure 2026-05-10 17:34:42 +02:00
Kjetil Torgrim Homme ee099e4662 doc: restore: simplify restore target name
the suffix "-work" is visually distracting since it copies a part of the
directory path being restored.  this makes it easy to gloss over where
the "work" string actually comes from.  as a bonus, it makes the examples
slightly shorter to read.
2025-12-05 18:07:11 +01:00
Kjetil Torgrim Homme 655e527765 doc: restore: be clearer about resulting filenames in restore 2025-12-05 18:04:46 +01:00
Kjetil Torgrim Homme d34ba9b6bd doc: restore: explain how --delete and --exclude work together 2025-12-05 17:59:56 +01:00
Kjetil Torgrim Homme 0673b58d7c doc: restore: explain explicitly effect of specifying snapshot:subfolder
The effect could be read from the examples, but it was easy to miss.
2025-12-05 17:50:53 +01:00
Luz Paz 794341a494 doc: fix various typos
Found via `codespell -q 3 -L atleast,iinclude,ist,programm,reenable,ser,uptodate`
2025-03-05 20:47:08 -05:00
Tesshu Flower cd84fe0853 xattrs - restore all by default, doc/chglog update
Signed-off-by: Tesshu Flower <tflower@redhat.com>
2025-01-10 15:25:09 -05:00
Tesshu Flower 3ac697d03d linux default restore only user xattrs, doc update
* On Linux restore only user.* xattrs by default
* restore all for other OSs
* Update docs and changelog about the new restore
flags --exclude-xattr and --include-xattr

Signed-off-by: Tesshu Flower <tflower@redhat.com>
2025-01-10 15:13:45 -05:00
Michael Eischer 5838896962 doc: document safety feature for --target / --delete 2024-10-17 19:45:03 +02:00
Michael Eischer f560152627 restore: document how to speed up dry-run 2024-07-10 21:34:10 +02:00
Michael Eischer 569f111cb1 restore: document --delete option 2024-07-05 22:38:39 +02:00
Michael Eischer a90665028f doc: fix syntax error 2024-07-05 20:41:27 +02:00
Michael Eischer 798256ec52 restore: add dry-run docs 2024-07-05 20:41:27 +02:00
Michael Eischer d890bfff7c doc: suggest backup before in-place restore 2024-06-13 21:17:30 +02:00
Michael Eischer 3ec28ff853 update restore --overwrite documentation 2024-06-13 21:17:30 +02:00
Michael Eischer 663151db57 Merge pull request #4837 from MichaelEischer/restore-options
Make restore overwrite behavior configurable
2024-06-12 22:52:55 +02:00
Michael Eischer e1ec60c2ee document restore --overwrite 2024-06-12 22:36:52 +02:00
Michael Eischer f834c1f08a Merge pull request #4825 from MichaelEischer/bump-fuse
mount: support fuse-t on macOS
2024-06-12 20:33:05 +02:00
Michael Eischer 058292700c mount: support fuse-t on macOS 2024-06-11 22:52:08 +02:00
Srigovind Nayak e579dfe72a doc: update documentation for restore command 2024-06-08 13:23:35 +05:30
Michael Eischer a651af70d6 doc: fix warings 2024-05-26 14:32:09 +02:00
aneesh-n 08c6945d61 Fix review comments 2024-04-29 16:21:38 -06:00
Aneesh Nireshwalia c0a1b9ada5 Update docs for security descriptors 2024-02-24 13:28:18 -07:00
Michael Eischer 15d6fa1f83 dump: update docs for --target option 2024-02-10 18:39:06 +01:00
Michael Eischer f5ffa40652 dump: minor cleanups 2024-02-05 20:10:52 +01:00
Srigovind Nayak 175c14b5c9 dump: add --target option 2024-02-05 20:10:52 +01:00
Martin Michlmayr b51fe2fb69 Format option correctly 2023-10-27 18:56:32 +02:00
Michael Eischer 55b440b520 tweak snapshot:subfolder docs 2023-07-22 23:50:17 +02:00
Michael Eischer 184b7616ba document snapshot:subfolder syntax 2023-07-22 19:55:57 +02:00
Daniel Gibson f9dded83b3 doc/050_restore.rst: Mention that restic restore is fastest
Especially with lots of files (like when backing up git repos),
restic mount + cp -r can be really slow.
2023-05-31 22:44:36 +02:00
Michael Eischer b151fa498a doc: add description for restore --sparse 2023-01-10 23:27:42 +01:00
fgma 8e5eb1090c issue2699: restore symlinks on windows when run as admin user 2022-10-29 21:19:33 +02:00
Michael Eischer ec4dfa3c66 Wording: replace further repo occurrences with repository 2022-07-12 20:48:01 +02:00
Leo R. Lundgren 711ceb0109 mount: Improve usage information when mounted 2021-11-01 20:59:20 +01:00
DRON-666 da9053b184 Some gramma fixes in documentation 2020-12-19 01:16:15 +03:00
DRON-666 ef1aeb8724 dump: Update docs and changelog 2020-12-19 01:09:47 +03:00
greatroar 8091151638 doc: Update restic mount availability and requirements
NetBSD doesn't support restic mount either, so it's easier to list the
positive cases. Also noted that FUSE for macOS is required on the Mac.
2020-10-22 09:57:30 +02:00
Martin Michlmayr 5cc1760fdf Fix typos 2020-05-16 14:05:26 +08:00
rawtaz af20015725 Merge pull request #2287 from benchti/patch-1
doc: Correct parameter order in dump example
2020-02-13 01:54:10 +01:00
lbausch 30db8057e4 Docs: Highlight option correctly 2019-10-13 21:19:03 +02:00
Ben 5d272e5c08 Dump : parameter order in sample
Usage:
  restic dump [flags] snapshotID file
2019-05-28 18:20:52 +02:00
Simon Beck cc8b690b52 Restore whole folder to sdtout as tar
With this change it is possible to dump a folder to stdout as a tar. The

It can be used just like the normal dump command:

`./restic dump fa97e6e1 "/data/test/" > test.tar`

Where `/data/test/` is a a folder instead of a file.
2019-04-22 20:44:33 +02:00
Alexander Neumann 3f069ac404 Merge pull request 2153 from dmd/umount-message
more accurate umount help message, for #815
2019-02-10 12:43:48 +01:00
Daniel M. Drucker 29a5bd5b30 more accurate umount help message, for #815 2019-01-28 16:53:35 -05:00
Johannes Hertenstein 8a97bb8661 Add documentation for insensitive includes & excludes 2018-11-25 13:32:16 +01:00
Alexander Neumann 0882aca3a8 Add hint for FUSE on FreeBSD 2018-09-26 21:40:43 +02:00