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 \-Vwci
  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 -R request
 111 Causes
 112 .B debugfs
 113 to execute the single command
 114 .IR request ,
 115 and then exit.
 116 .TP
 117 .I -V
 118 print the version number of
 119 .B debugfs
 120 and exit.
 121 .SH SPECIFYING FILES
 122 Many
 123 .B debugfs
 124 commands take a
 125 .I filespec
 126 as an argument to specify an inode (as opposed to a pathname)
 127 in the filesystem which is currently opened by
 128 .BR debugfs .
 129 The
 130 .I filespec
 131 argument may be specified in two forms.  The first form is an inode
 132 number surrounded by angle brackets, e.g.,
 133 .IR <2> .
 134 The second form is a pathname; if the pathname is prefixed by a forward slash
 135 ('/'), then it is interpreted relative to the root of the filesystem
 136 which is currently opened by
 137 .BR debugfs .
 138 If not, the pathname is
 139 interpreted relative to the current working directory as maintained by
 140 .BR debugfs .
 141 This may be modified by using the
 142 .B debugfs
 143 command
 144 .IR cd .
 145 .\"
 146 .\"
 147 .\"
 148 .SH COMMANDS
 149 This is a list of the commands which
 150 .B debugfs
 151 supports.
 152 .TP
 153 .I bmap filespec logical_block
 154 Print the physical block number corresponding to the logical block number
 155 .I logical_block
 156 in the inode
 157 .IR filespec .
 158 .TP
 159 .I cat filespec
 160 Dump the contents of the inode
 161 .I filespec
 162 to stdout.
 163 .TP
 164 .I cd filespec
 165 Change the current working directory to
 166 .IR filespec .
 167 .TP
 168 .I chroot filespec
 169 Change the root directory to be the directory
 170 .IR filespec .
 171 .TP
 172 .I close [-a]
 173 Close the currently open file system.  If the
 174 .I -a
 175 option is specified, write out any changes to the superblock and block
 176 group descriptors to all of the backup superblocks, not just to the
 177 master superblock.
 178 .TP
 179 .I clri file
 180 Clear the contents of the inode
 181 .IR file .
 182 .TP
 183 .I dump [-p] filespec out_file
 184 Dump the contents of the inode
 185 .I filespec
 186 to the output file
 187 .IR out_file .
 188 If the
 189 .I -p
 190 option is given set the owner, group and permissions information on
 191 .I out_file
 192 to match
 193 .IR filespec .
 194 .TP
 195 .I expand_dir filespec
 196 Expand the directory
 197 .IR filespec .
 198 .TP
 199 .I feature [fs_feature] [-fs_feature] ...
 200 Set or clear various filesystem features in the superblock.  After setting
 201 or clearing any filesystem features that were requested, print the current
 202 state of the filesystem feature set.
 203 .TP
 204 .I find_free_block [count [goal]]
 205 Find the first
 206 .I count
 207 free blocks, starting from
 208 .I goal
 209 and allocate it.
 210 .TP
 211 .I find_free_inode [dir [mode]]
 212 Find a free inode and allocate it.  If present,
 213 .I dir
 214 specifies the inode number of the directory
 215 which the inode is to be located.  The second
 216 optional argument
 217 .I mode
 218 specifies the permissions of the new inode.  (If the directory bit is set
 219 on the mode, the allocation routine will function differently.)
 220 .TP
 221 .I freeb block [count]
 222 Mark the block number
 223 .I block
 224 as not allocated.
 225 If the optional argument
 226 .I count
 227 is present, then
 228 .I count
 229 blocks starting at block number
 230 .I block
 231 will be marked as not allocated.
 232 .TP
 233 .I freei filespec
 234 Free the inode specified by
 235 .IR filespec .
 236 .TP
 237 .I help
 238 Print a list of commands understood by
 239 .BR debugfs (8).
 240 .TP
 241 .I icheck block ...
 242 Print a listing of the inodes which use the one or more blocks specified
 243 on the command line.
 244 .TP
 245 .I imap filespec
 246 Print the location of the inode data structure (in the inode table)
 247 of the inode
 248 .IR filespec .
 249 .TP
 250 .I init_filesys device blocksize
 251 Create an ext2 file system on
 252 .I device
 253 with device size
 254 .IR blocksize .
 255 Note that this does not fully initialize all of the data structures;
 256 to do this, use the
 257 .BR mke2fs (8)
 258 program.  This is just a call to the low-level library, which sets up
 259 the superblock and block descriptors.
 260 .TP
 261 .I kill_file filespec
 262 Deallocate the inode
 263 .I filespec
 264 and its blocks.  Note that this does not remove any directory
 265 entries (if any) to this inode.  See the
 266 .BR rm (1)
 267 command if you wish to unlink a file.
 268 .TP
 269 .I lcd directory
 270 Change the current working directory of the
 271 .B debugfs
 272 process to
 273 .I directory
 274 on the native filesystem.
 275 .TP
 276 .I ln filespec dest_file
 277 Create a link named
 278 .I dest_file
 279 which is a link to
 280 .IR filespec .
 281 Note this does not adjust the inode reference counts.
 282 .TP
 283 .I logdump [-acs] [-b<block>] [-i<filespec>] [-f<journal_file>] [output_file]
 284 Dump the contents of the ext3 journal.  By default, the journal inode as
 285 specified in the superblock.  However, this can be overridden with the
 286 .I \-i
 287 option, which uses an inode specifier to specify the journal to be
 288 used.  A file containing journal data can be specified using the
 289 .I \-f
 290 option.   Finally, the
 291 .I \-s
 292 option utilizes the backup information in the superblock to locate the
 293 journal.
 294 .IP
 295 The
 296 .I \-a
 297 option causes the
 298 .I logdump
 299 program to print the contents of all of the descriptor blocks.
 300 The
 301 .I \-b
 302 option causes
 303 .I logdump
 304 to print all journal records that are refer to the specified block.
 305 The
 306 .I \-c
 307 option will print out the contents of all of the data blocks selected by
 308 the
 309 .I \-a
 310 and
 311 .I \-b
 312 options.
 313 .TP
 314 .I ls [-l] [-d] [-p] filespec
 315 Print a listing of the files in the directory
 316 .IR filespec .
 317 The
 318 .I \-l
 319 flag will list files using a more verbose format.
 320 The
 321 .I \-d
 322 flag will list deleted entries in the directory.
 323 The
 324 .I \-p
 325 flag will list the files in a format which is more easily parsable by
 326 scripts, as well as making it more clear when there are spaces or other
 327 non-printing characters at the end of filenames.
 328 .TP
 329 .I modify_inode filespec
 330 Modify the contents of the inode structure in the inode
 331 .IR filespec .
 332 .TP
 333 .I mkdir filespec
 334 Make a directory.
 335 .TP
 336 .I mknod filespec [p|[[c|b] major minor]]
 337 Create a special device file (a named pipe, character or block device).
 338 If a character or block device is to be made, the
 339 .I major
 340 and
 341 .I minor
 342 device numbers must be specified.
 343 .TP
 344 .I ncheck inode_num ...
 345 Take the requested list of inode numbers, and print a listing of pathnames
 346 to those inodes.
 347 .TP
 348 .I open [-w] [-e] [-f] [-i] [-c] [-b blocksize] [-s superblock] device
 349 Open a filesystem for editing.  The
 350 .I -f
 351 flag forces the filesystem to be opened even if there are some unknown
 352 or incompatible filesystem features which would normally
 353 prevent the filesystem from being opened.  The
 354 .I -e
 355 flag causes the filesystem to be opened in exclusive mode.  The
 356 .IR -b ", " -c ", " -i ", " -s ", and " -w
 357 options behave the same as the command-line options to
 358 .BR debugfs .
 359 .TP
 360 .I pwd
 361 Print the current working directory.
 362 .TP
 363 .I quit
 364 Quit
 365 .B debugfs
 366 .TP
 367 .I rdump directory destination
 368 Recursively dump
 369 .I directory
 370 and all its contents (including regular files, symbolic links, and other
 371 directories) into the named
 372 .I destination
 373 which should be an existing directory on the native filesystem.
 374 .TP
 375 .I rm pathname
 376 Unlink
 377 .IR pathname .
 378 If this causes the inode pointed to by
 379 .I pathname
 380 to have no other references, deallocate the file.  This command functions
 381 as the unlink() system call.
 382 .I
 383 .TP
 384 .I rmdir filespec
 385 Remove the directory
 386 .IR filespec .
 387 .TP
 388 .I setb block [count]
 389 Mark the block number
 390 .I block
 391 as allocated.
 392 If the optional argument
 393 .I count
 394 is present, then
 395 .I count
 396 blocks starting at block number
 397 .I block
 398 will be marked as allocated.
 399 .TP
 400 .I set_block_group bgnum field value
 401 Modify the block group descriptor specified by
 402 .I bgnum
 403 so that the block group descriptor field
 404 .I field
 405 has value
 406 .I value.
 407 .TP
 408 .I seti filespec
 409 Mark inode
 410 .I filespec
 411 as in use in the inode bitmap.
 412 .TP
 413 .I set_inode_field filespec field value
 414 Modify the inode specified by
 415 .I filespec
 416 so that the inode field
 417 .I field
 418 has value
 419 .I value.
 420 The list of valid inode fields which can be set via this command
 421 can be displayed by using the command:
 422 .B set_inode_field -l
 423 .TP
 424 .I set_super_value field value
 425 Set the superblock field
 426 .I field
 427 to
 428 .I value.
 429 The list of valid superblock fields which can be set via this command
 430 can be displayed by using the command:
 431 .B set_super_value -l
 432 .TP
 433 .I show_super_stats [-h]
 434 List the contents of the super block and the block group descriptors.  If the
 435 .I -h
 436 flag is given, only print out the superblock contents.
 437 .TP
 438 .I stat filespec
 439 Display the contents of the inode structure of the inode
 440 .IR filespec .
 441 .TP
 442 .I testb block [count]
 443 Test if the block number
 444 .I block
 445 is marked as allocated in the block bitmap.
 446 If the optional argument
 447 .I count
 448 is present, then
 449 .I count
 450 blocks starting at block number
 451 .I block
 452 will be tested.
 453 .TP
 454 .I testi filespec
 455 Test if the inode
 456 .I filespec
 457 is marked as allocated in the inode bitmap.
 458 .TP
 459 .I undel <inode num> [pathname]
 460 Undelete the specified inode number (which must be surrounded by angle
 461 brackets) so that it and its blocks are marked in use, and optionally
 462 link the recovered inode to the specified pathname.  The
 463 .B e2fsck
 464 command should always be run after using the
 465 .B undel
 466 command to recover deleted files.
 467 .IP
 468 Note that if you are recovering a large number of deleted files, linking
 469 the inode to a directory may require the directory to be expanded, which
 470 could allocate a block that had been used by one of the
 471 yet-to-be-undeleted files.  So it is safer to undelete all of the
 472 inodes without specifying a destination pathname, and then in a separate
 473 pass, use the debugfs
 474 .B link
 475 command to link the inode to the destination pathname, or use
 476 .B e2fsck
 477 to check the filesystem and link all of the recovered inodes to the
 478 lost+found directory.
 479 .TP
 480 .I unlink pathname
 481 Remove the link specified by
 482 .I pathname
 483 to an inode.  Note this does not adjust the inode reference counts.
 484 .TP
 485 .I write source_file out_file
 486 Create a file in the filesystem named
 487 .IR out_file ,
 488 and copy the contents of
 489 .I source_file
 490 into the destination file.
 491 .SH ENVIRONMENT VARIABLES
 492 .TP
 493 .B DEBUGFS_PAGER, PAGER
 494 The
 495 .BR debugfs (8)
 496 program always pipes the output of the some commands through a
 497 pager program.  These commands include:
 498 .IR show_super_stats ,
 499 .IR list_directory ,
 500 .IR show_inode_info ,
 501 .IR list_deleted_inodes ,
 502 and
 503 .IR htree_dump .
 504 The specific pager can explicitly specified by the
 505 .B DEBUGFS_PAGER
 506 environment variable, and if it is not set, by the
 507 .B PAGER
 508 environment variable.
 509 .IP
 510 Note that since a pager is always used, the
 511 .BR less (1)
 512 pager is not particularly appropriate, since it clears the screen before
 513 displaying the output of the command and clears the output the screen
 514 when the pager is exited.  Many users prefer to use the
 515 .BR less (1)
 516 pager for most purposes, which is why the
 517 .B DEBUGFS_PAGER
 518 environment variable is available to override the more general
 519 .B PAGER
 520 environment variable.
 521 .SH AUTHOR
 522 .B debugfs
 523 was written by Theodore Ts'o <tytso@mit.edu>.
 524 .SH SEE ALSO
 525 .BR dumpe2fs (8),
 526 .BR tune2fs (8),
 527 .BR e2fsck (8),
 528 .BR mke2fs (8)