Whamcloud - gitweb
LU-10638 build: add support for Scientific
[tools/e2fsprogs.git] / e2scan / e2scan.8.in
1 .TH e2scan 1 "2006 Sep 26" Lustre "backup utilities"
2 .SH NAME
3 e2scan \- scan an Ext2-type filesystem for modified inodes
4 .SH SYNOPSIS
5 .br
6 .B e2scan
7 @E2SCAN_MAN@{
8 .B -l
9 @E2SCAN_MAN@|
10 @E2SCAN_MAN@.B -f
11 @E2SCAN_MAN@}
12 [
13 .BI -a " groups"
14 ] [
15 .BI -b " blocks"
16 ] [
17 .BI -C " chdir"
18 ] [
19 @E2SCAN_MAN@.BI -d " database"
20 @E2SCAN_MAN@] [
21 .BI -n " filename"
22 ] [
23 .BI -N " date"
24 ] [
25 .BI -o " outfile"
26 ]
27 .I device
28 .br
29 .SH DESCRIPTION
30 .BR e2scan ,
31 iterates all inodes on
32 .IR device ,
33 find inodes modified since the specified time (default 1 day), and prints
34 their pathnames relative to the root of the filesystem.  This allows the
35 pathnames to be used as input to a backup tool running in the mountpoint, like
36 .BR "tar \-C" ,
37 as the filesystem may be mounted at an arbitrary mountpoint.
38
39 The
40 .B e2scan
41 program is optimized for scanning an entire filesystem for (modified) files,
42 but is not efficient for smaller subdirectory scans.  Use
43 .BR find (1)
44 for that purpose instead.
45 .SH OPTIONS
46 .TP
47 .BI \-a " groups"
48 Set readahead for inode table blocks to get better performance when scanning
49 .IR device .
50 Default is 1 group of readahead.
51 .TP
52 .BI \-b " inode_buffer_blocks"
53 Set number of inode blocks to read from disk at a time.
54 .TP
55 .BI \-C " directory"
56 Specify the working directory (relative to the root of the filesystem
57 being scanned) for the output pathnames.  Only directories underneath
58 the root will be candidates for listing.  For Lustre MDT filesystems the
59 pathname must be prefixed with "/ROOT" to dump the client visible filesystem.
60 @E2SCAN_MAN@.TP
61 @E2SCAN_MAN@.BI \-d " database_file"
62 @E2SCAN_MAN@Specify output file for database when running in
63 @E2SCAN_MAN@.B \-f
64 @E2SCAN_MAN@mode.
65 .TP
66 .B \-D
67 Also include directories in the output.  The default is to only list files,
68 because tools like
69 .BR tar (1)
70 will recurse into directories and files that are also listed therein will be
71 backed up twice.
72 @E2SCAN_MAN@.TP
73 @E2SCAN_MAN@.B \-f
74 @E2SCAN_MAN@List files in the filesystem and insert them into the
75 @E2SCAN_MAN@.BR sqlite3 (1)
76 @E2SCAN_MAN@database named by the
77 @E2SCAN_MAN@.B \-d
78 @E2SCAN_MAN@option.
79 .TP
80 .B \-l
81 List files in the filesystem to standard output, or to the file specified
82 with the
83 .B \-o
84 option.  This is the default mode.
85 .TP
86 .BI \-n " filename"
87 Dump only files newer than the specified
88 .IR filename .
89 .TP
90 .BI \-N " date"
91 Dump only files newer than the specified date.  This supports a wide
92 variety of input formats like "YYYY-MM-DD HH:MM:SS".  Use a date of
93 .R 0
94 to dump all files.
95 .TP
96 .BI \-o " outfile"
97 Record the files found into
98 .I outfile
99 instead of the default standard output.
100 .SH EXAMPLES
101 To dump all of the files in the filesystem into the file
102 .IR myfilelist :
103 .IP
104 e2scan -N 0 -o myfilelist /dev/sdb1
105 .PP
106 To list files and directories newer than Feb 6, 2007 in the /home directory:
107 .IP
108 e2scan -D -N "Feb 6 00:00:00 2007" -C /home /dev/sdb1
109 .PP
110 .SH AUTHOR
111 This version of
112 .B e2scan
113 was originally written by Vladimir Saviliev <vladimir.saviliev@sun.com>
114 and Andreas Dilger <andreas.dilger@intel.com>.
115 .SH SEE ALSO
116 .BR find (1)