debugfs/debugfs.8.in

   1 .\" -*- nroff -*-
   2 .\" Copyright 1993, 1994, 1995 by Theodore Ts'o.  All Rights Reserved.
   3 .\" This file may be copied under the terms of the GNU Public License.
   4 .\"
   5 .TH DEBUGFS 8 "@E2FSPROGS_MONTH@ @E2FSPROGS_YEAR@" "E2fsprogs version @E2FSPROGS_VERSION@"
   6 .SH NAME
   7 debugfs \- ext2/ext3/ext4 file system debugger
   8 .SH SYNOPSIS
   9 .B debugfs
  10 [
  11 .B \-DVwci
  12 ]
  13 [
  14 .B \-b
  15 blocksize
  16 ]
  17 [
  18 .B \-s
  19 superblock
  20 ]
  21 [
  22 .B \-f
  23 cmd_file
  24 ]
  25 [
  26 .B \-R
  27 request
  28 ]
  29 [
  30 .B \-d
  31 data_source_device
  32 ]
  33 [
  34 device
  35 ]
  36 .SH DESCRIPTION
  37 The
  38 .B debugfs
  39 program is an interactive file system debugger. It can be used to
  40 examine and change the state of an ext2, ext3, or ext4 file system.
  41 .br
  42 .I device
  43 is the special file corresponding to the device containing the
  44 file system (e.g /dev/hdXX).
  45 .SH OPTIONS
  46 .TP
  47 .I \-w
  48 Specifies that the file system should be opened in read-write mode.
  49 Without this option, the file system is opened in read-only mode.
  50 .TP
  51 .I \-c
  52 Specifies that the file system should be opened in catastrophic mode, in
  53 which the inode and group bitmaps are not read initially.  This can be
  54 useful for filesystems with significant corruption, but because of this,
  55 catastrophic mode forces the filesystem to be opened read-only.
  56 .TP
  57 .I \-i
  58 Specifies that
  59 .I device
  60 represents an ext2 image file created by the
  61 .B e2image
  62 program.  Since the ext2 image file only contains the superblock, block
  63 group descriptor, block and inode allocation bitmaps, and
  64 the inode table, many
  65 .B debugfs
  66 commands will not function properly.
  67 .B Warning:
  68 no safety checks are in place, and
  69 .B debugfs
  70 may fail in interesting ways if commands such as
  71 .IR ls ", " dump ", "
  72 etc. are tried without specifying the
  73 .I data_source_device
  74 using the
  75 .I \-d
  76 option.
  77 .B debugfs
  78 is a debugging tool.  It has rough edges!
  79 .TP
  80 .I -d data_source_device
  81 Used with the
  82 .I \-i
  83 option, specifies that
  84 .I data_source_device
  85 should be used when reading blocks not found in the ext2 image file.
  86 This includes data, directory, and indirect blocks.
  87 .TP
  88 .I -b blocksize
  89 Forces the use of the given block size for the file system, rather than
  90 detecting the correct block size as normal.
  91 .TP
  92 .I -s superblock
  93 Causes the file system superblock to be read from the given block
  94 number, instead of using the primary superblock (located at an offset of
  95 1024 bytes from the beginning of the filesystem).  If you specify the
  96 .I -s
  97 option, you must also provide the blocksize of the filesystem via the
  98 .I -b
  99 option.
 100 .TP
 101 .I -f cmd_file
 102 Causes
 103 .B debugfs
 104 to read in commands from
 105 .IR cmd_file ,
 106 and execute them.  When
 107 .B debugfs
 108 is finished executing those commands, it will exit.
 109 .TP
 110 .I -D
 111 Causes
 112 .B debugfs
 113 to open the device using Direct I/O, bypassing the buffer cache.  Note
 114 that some Linux devices, notably device mapper as of this writing, do
 115 not support Direct I/O.
 116 .TP
 117 .I -R request
 118 Causes
 119 .B debugfs
 120 to execute the single command
 121 .IR request ,
 122 and then exit.
 123 .TP
 124 .I -V
 125 print the version number of
 126 .B debugfs
 127 and exit.
 128 .SH SPECIFYING FILES
 129 Many
 130 .B debugfs
 131 commands take a
 132 .I filespec
 133 as an argument to specify an inode (as opposed to a pathname)
 134 in the filesystem which is currently opened by
 135 .BR debugfs .
 136 The
 137 .I filespec
 138 argument may be specified in two forms.  The first form is an inode
 139 number surrounded by angle brackets, e.g.,
 140 .IR <2> .
 141 The second form is a pathname; if the pathname is prefixed by a forward slash
 142 ('/'), then it is interpreted relative to the root of the filesystem
 143 which is currently opened by
 144 .BR debugfs .
 145 If not, the pathname is
 146 interpreted relative to the current working directory as maintained by
 147 .BR debugfs .
 148 This may be modified by using the
 149 .B debugfs
 150 command
 151 .IR cd .
 152 .\"
 153 .\"
 154 .\"
 155 .SH COMMANDS
 156 This is a list of the commands which
 157 .B debugfs
 158 supports.
 159 .TP
 160 .I bmap filespec logical_block
 161 Print the physical block number corresponding to the logical block number
 162 .I logical_block
 163 in the inode
 164 .IR filespec .
 165 .TP
 166 .I cat filespec
 167 Dump the contents of the inode
 168 .I filespec
 169 to stdout.
 170 .TP
 171 .I cd filespec
 172 Change the current working directory to
 173 .IR filespec .
 174 .TP
 175 .I chroot filespec
 176 Change the root directory to be the directory
 177 .IR filespec .
 178 .TP
 179 .I close [-a]
 180 Close the currently open file system.  If the
 181 .I -a
 182 option is specified, write out any changes to the superblock and block
 183 group descriptors to all of the backup superblocks, not just to the
 184 master superblock.
 185 .TP
 186 .I clri file
 187 Clear the contents of the inode
 188 .IR file .
 189 .TP
 190 .I dump [-p] filespec out_file
 191 Dump the contents of the inode
 192 .I filespec
 193 to the output file
 194 .IR out_file .
 195 If the
 196 .I -p
 197 option is given set the owner, group and permissions information on
 198 .I out_file
 199 to match
 200 .IR filespec .
 201 .TP
 202 .I dump_extents [-n] [-l] filespec
 203 Dump the the extent tree of the inode
 204 .IR filespec .
 205 The
 206 .I -n
 207 flag will cause
 208 .I dump_extents
 209 to only display the interior nodes in the extent tree.   The
 210 .I  -l
 211 flag cause
 212 .I dump_extents
 213 to only display the leaf nodes in the extent tree.
 214 .IP
 215 (Please note that the length and range of blocks for the last extent in
 216 an interior node is an estimate by the extents library functions, and is
 217 not stored in filesystem data structures.   Hence, the values displayed
 218 may not necessarily by accurate and does not indicate a problem or
 219 corruption in the file system.)
 220 .TP
 221 .I expand_dir filespec
 222 Expand the directory
 223 .IR filespec .
 224 .TP
 225 .I feature [fs_feature] [-fs_feature] ...
 226 Set or clear various filesystem features in the superblock.  After setting
 227 or clearing any filesystem features that were requested, print the current
 228 state of the filesystem feature set.
 229 .TP
 230 .I find_free_block [count [goal]]
 231 Find the first
 232 .I count
 233 free blocks, starting from
 234 .I goal
 235 and allocate it.
 236 .TP
 237 .I find_free_inode [dir [mode]]
 238 Find a free inode and allocate it.  If present,
 239 .I dir
 240 specifies the inode number of the directory
 241 which the inode is to be located.  The second
 242 optional argument
 243 .I mode
 244 specifies the permissions of the new inode.  (If the directory bit is set
 245 on the mode, the allocation routine will function differently.)
 246 .TP
 247 .I freeb block [count]
 248 Mark the block number
 249 .I block
 250 as not allocated.
 251 If the optional argument
 252 .I count
 253 is present, then
 254 .I count
 255 blocks starting at block number
 256 .I block
 257 will be marked as not allocated.
 258 .TP
 259 .I freei filespec
 260 Free the inode specified by
 261 .IR filespec .
 262 .TP
 263 .I help
 264 Print a list of commands understood by
 265 .BR debugfs .
 266 .TP
 267 .I icheck block ...
 268 Print a listing of the inodes which use the one or more blocks specified
 269 on the command line.
 270 .TP
 271 .I imap filespec
 272 Print the location of the inode data structure (in the inode table)
 273 of the inode
 274 .IR filespec .
 275 .TP
 276 .I init_filesys device blocksize
 277 Create an ext2 file system on
 278 .I device
 279 with device size
 280 .IR blocksize .
 281 Note that this does not fully initialize all of the data structures;
 282 to do this, use the
 283 .BR mke2fs (8)
 284 program.  This is just a call to the low-level library, which sets up
 285 the superblock and block descriptors.
 286 .TP
 287 .I kill_file filespec
 288 Deallocate the inode
 289 .I filespec
 290 and its blocks.  Note that this does not remove any directory
 291 entries (if any) to this inode.  See the
 292 .BR rm (1)
 293 command if you wish to unlink a file.
 294 .TP
 295 .I lcd directory
 296 Change the current working directory of the
 297 .B debugfs
 298 process to
 299 .I directory
 300 on the native filesystem.
 301 .TP
 302 .I ln filespec dest_file
 303 Create a link named
 304 .I dest_file
 305 which is a link to
 306 .IR filespec .
 307 Note this does not adjust the inode reference counts.
 308 .TP
 309 .I logdump [-acs] [-b<block>] [-i<filespec>] [-f<journal_file>] [output_file]
 310 Dump the contents of the ext3 journal.  By default, the journal inode as
 311 specified in the superblock.  However, this can be overridden with the
 312 .I \-i
 313 option, which uses an inode specifier to specify the journal to be
 314 used.  A file containing journal data can be specified using the
 315 .I \-f
 316 option.   Finally, the
 317 .I \-s
 318 option utilizes the backup information in the superblock to locate the
 319 journal.
 320 .IP
 321 The
 322 .I \-a
 323 option causes the
 324 .I logdump
 325 program to print the contents of all of the descriptor blocks.
 326 The
 327 .I \-b
 328 option causes
 329 .I logdump
 330 to print all journal records that are refer to the specified block.
 331 The
 332 .I \-c
 333 option will print out the contents of all of the data blocks selected by
 334 the
 335 .I \-a
 336 and
 337 .I \-b
 338 options.
 339 .TP
 340 .I ls [-l] [-d] [-p] filespec
 341 Print a listing of the files in the directory
 342 .IR filespec .
 343 The
 344 .I \-l
 345 flag will list files using a more verbose format.
 346 The
 347 .I \-d
 348 flag will list deleted entries in the directory.
 349 The
 350 .I \-p
 351 flag will list the files in a format which is more easily parsable by
 352 scripts, as well as making it more clear when there are spaces or other
 353 non-printing characters at the end of filenames.
 354 .TP
 355 .I modify_inode filespec
 356 Modify the contents of the inode structure in the inode
 357 .IR filespec .
 358 .TP
 359 .I mkdir filespec
 360 Make a directory.
 361 .TP
 362 .I mknod filespec [p|[[c|b] major minor]]
 363 Create a special device file (a named pipe, character or block device).
 364 If a character or block device is to be made, the
 365 .I major
 366 and
 367 .I minor
 368 device numbers must be specified.
 369 .TP
 370 .I ncheck inode_num ...
 371 Take the requested list of inode numbers, and print a listing of pathnames
 372 to those inodes.
 373 .TP
 374 .I open [-w] [-e] [-f] [-i] [-c] [-D] [-b blocksize] [-s superblock] device
 375 Open a filesystem for editing.  The
 376 .I -f
 377 flag forces the filesystem to be opened even if there are some unknown
 378 or incompatible filesystem features which would normally
 379 prevent the filesystem from being opened.  The
 380 .I -e
 381 flag causes the filesystem to be opened in exclusive mode.  The
 382 .IR -b ", " -c ", " -i ", " -s ", " -w ", and " -D
 383 options behave the same as the command-line options to
 384 .BR debugfs .
 385 .TP
 386 .I punch filespec start_blk [end_blk]
 387 Delete the blocks in the inode ranging from
 388 .I start_blk
 389 to
 390 .IR end_blk .
 391 If
 392 .I end_blk
 393 is omitted then this command will function as a truncate command; that
 394 is, all of the blocks starting at
 395 .I start_blk
 396 through to the end of the file will be deallocated.
 397 .TP
 398 .I pwd
 399 Print the current working directory.
 400 .TP
 401 .I quit
 402 Quit
 403 .B debugfs
 404 .TP
 405 .I rdump directory destination
 406 Recursively dump
 407 .I directory
 408 and all its contents (including regular files, symbolic links, and other
 409 directories) into the named
 410 .I destination
 411 which should be an existing directory on the native filesystem.
 412 .TP
 413 .I rm pathname
 414 Unlink
 415 .IR pathname .
 416 If this causes the inode pointed to by
 417 .I pathname
 418 to have no other references, deallocate the file.  This command functions
 419 as the unlink() system call.
 420 .I
 421 .TP
 422 .I rmdir filespec
 423 Remove the directory
 424 .IR filespec .
 425 .TP
 426 .I setb block [count]
 427 Mark the block number
 428 .I block
 429 as allocated.
 430 If the optional argument
 431 .I count
 432 is present, then
 433 .I count
 434 blocks starting at block number
 435 .I block
 436 will be marked as allocated.
 437 .TP
 438 .I set_block_group bgnum field value
 439 Modify the block group descriptor specified by
 440 .I bgnum
 441 so that the block group descriptor field
 442 .I field
 443 has value
 444 .I value.
 445 .TP
 446 .I seti filespec
 447 Mark inode
 448 .I filespec
 449 as in use in the inode bitmap.
 450 .TP
 451 .I set_inode_field filespec field value
 452 Modify the inode specified by
 453 .I filespec
 454 so that the inode field
 455 .I field
 456 has value
 457 .I value.
 458 The list of valid inode fields which can be set via this command
 459 can be displayed by using the command:
 460 .B set_inode_field -l
 461 .TP
 462 .I set_super_value field value
 463 Set the superblock field
 464 .I field
 465 to
 466 .I value.
 467 The list of valid superblock fields which can be set via this command
 468 can be displayed by using the command:
 469 .B set_super_value -l
 470 .TP
 471 .I show_super_stats [-h]
 472 List the contents of the super block and the block group descriptors.  If the
 473 .I -h
 474 flag is given, only print out the superblock contents.
 475 .TP
 476 .I stat filespec
 477 Display the contents of the inode structure of the inode
 478 .IR filespec .
 479 .TP
 480 .I testb block [count]
 481 Test if the block number
 482 .I block
 483 is marked as allocated in the block bitmap.
 484 If the optional argument
 485 .I count
 486 is present, then
 487 .I count
 488 blocks starting at block number
 489 .I block
 490 will be tested.
 491 .TP
 492 .I testi filespec
 493 Test if the inode
 494 .I filespec
 495 is marked as allocated in the inode bitmap.
 496 .TP
 497 .I undel <inode num> [pathname]
 498 Undelete the specified inode number (which must be surrounded by angle
 499 brackets) so that it and its blocks are marked in use, and optionally
 500 link the recovered inode to the specified pathname.  The
 501 .B e2fsck
 502 command should always be run after using the
 503 .B undel
 504 command to recover deleted files.
 505 .IP
 506 Note that if you are recovering a large number of deleted files, linking
 507 the inode to a directory may require the directory to be expanded, which
 508 could allocate a block that had been used by one of the
 509 yet-to-be-undeleted files.  So it is safer to undelete all of the
 510 inodes without specifying a destination pathname, and then in a separate
 511 pass, use the debugfs
 512 .B link
 513 command to link the inode to the destination pathname, or use
 514 .B e2fsck
 515 to check the filesystem and link all of the recovered inodes to the
 516 lost+found directory.
 517 .TP
 518 .I unlink pathname
 519 Remove the link specified by
 520 .I pathname
 521 to an inode.  Note this does not adjust the inode reference counts.
 522 .TP
 523 .I write source_file out_file
 524 Create a file in the filesystem named
 525 .IR out_file ,
 526 and copy the contents of
 527 .I source_file
 528 into the destination file.
 529 .SH ENVIRONMENT VARIABLES
 530 .TP
 531 .B DEBUGFS_PAGER, PAGER
 532 The
 533 .B debugfs
 534 program always pipes the output of the some commands through a
 535 pager program.  These commands include:
 536 .IR show_super_stats ,
 537 .IR list_directory ,
 538 .IR show_inode_info ,
 539 .IR list_deleted_inodes ,
 540 and
 541 .IR htree_dump .
 542 The specific pager can explicitly specified by the
 543 .B DEBUGFS_PAGER
 544 environment variable, and if it is not set, by the
 545 .B PAGER
 546 environment variable.
 547 .IP
 548 Note that since a pager is always used, the
 549 .BR less (1)
 550 pager is not particularly appropriate, since it clears the screen before
 551 displaying the output of the command and clears the output the screen
 552 when the pager is exited.  Many users prefer to use the
 553 .BR less (1)
 554 pager for most purposes, which is why the
 555 .B DEBUGFS_PAGER
 556 environment variable is available to override the more general
 557 .B PAGER
 558 environment variable.
 559 .SH AUTHOR
 560 .B debugfs
 561 was written by Theodore Ts'o <tytso@mit.edu>.
 562 .SH SEE ALSO
 563 .BR dumpe2fs (8),
 564 .BR tune2fs (8),
 565 .BR e2fsck (8),
 566 .BR mke2fs (8)