btrfs-progs: restore: document updates
authorWang Shilong <wangsl.fnst@cn.fujitsu.com>
Thu, 19 Jun 2014 01:27:09 +0000 (09:27 +0800)
committerDavid Sterba <dsterba@suse.cz>
Fri, 22 Aug 2014 12:43:10 +0000 (14:43 +0200)
Add some missing options, also improve some confusing
expressions.

Signed-off-by: Wang Shilong <wangsl.fnst@cn.fujitsu.com>
Signed-off-by: David Sterba <dsterba@suse.cz>
Documentation/btrfs-restore.txt
cmds-restore.c

index d774343..2fa2801 100644 (file)
@@ -24,7 +24,7 @@ https://btrfs.wiki.kernel.org/index.php/Restore
 OPTIONS
 -------
 -s::
-get snapshots.
+get snapshots, btrfs restore skips snapshots in default.
 
 -x::
 get extended attributes.
@@ -38,17 +38,17 @@ ignore errors.
 -o::
 overwrite directories/files in <path>.
 
--t <location>::
-use <location> to read root tree.
+-t <bytenr>::
+use <bytenr> to read root tree.
 
--f <offset>::
-use <offset> to read fs tree.
+-f <bytenr>::
+only restore files that are under specified root whose root bytenr is <bytenr>.
 
--u <block>::
-use given superblock mirror identified by <block>.
+-u <mirror>::
+use given superblock mirror identified by <mirror>, it can be 0,1,2.
 
 -r <rootid>::
-use <rootid> as root objectid.
+only restore files that are under specified root whose objectid is <rootid>.
 
 -d::
 find dir.
@@ -56,6 +56,16 @@ find dir.
 -l::
 list tree roots.
 
+-D|--dry-run::
+dry run (only list files that would be recovered).
+
+--path-regex <regex>::
+restore only filenames matching regex, you have to use following syntax (possibly quoted):
+^/(|home(|/username(|/Desktop(|/.*))))$
+
+-c::
+ignore case (--path-regrex only).
+
 EXIT STATUS
 -----------
 *btrfs restore* returns a zero exist status if it succeeds. Non zero is
index 310a84e..3465f84 100644 (file)
@@ -1117,9 +1117,9 @@ const char * const cmd_restore_usage[] = {
        "-v              verbose",
        "-i              ignore errors",
        "-o              overwrite",
-       "-t <location>   tree location",
-       "-f <offset>     filesystem location",
-       "-u <block>      super mirror",
+       "-t <bytenr>     tree location",
+       "-f <bytenr>     filesystem location",
+       "-u <mirror>     super mirror",
        "-r <rootid>     root objectid",
        "-d              find dir",
        "-l              list tree roots",
@@ -1128,6 +1128,7 @@ const char * const cmd_restore_usage[] = {
        "                restore only filenames matching regex,",
        "                you have to use following syntax (possibly quoted):",
        "                ^/(|home(|/username(|/Desktop(|/.*))))$",
+       "-c              ignore case (--path-regrex only)",
        NULL
 };