projects / thirdparty / util-linux.git / blame
| Commit | Line | Data |
|---|---|---|
| f0bef3ca HT |
1 | .\" -*- nroff -*- |
| 2 | .TH FSFREEZE 8 "May 2010" | |
| 3 | .SH NAME | |
| 4 | fsfreeze \- suspend access to an filesystem (Linux Ext3/4, ReiserFS, JFS, XFS). | |
| 5 | .SH SYNOPSIS | |
| 6 | .B fsfreeze | |
| 7 | .RB \-f | |
| 8 | .I mountpoint | |
| 9 | ||
| 10 | .B fsfreeze | |
| 11 | .RB \-u | |
| 12 | .I mountpoint | |
| 13 | ||
| 14 | .SH DESCRIPTION | |
| 15 | .B fsfreeze | |
| 16 | suspends and resumes access to an filesystem | |
| 17 | .PP | |
| 18 | .B fsfreeze | |
| 19 | halts new access to the filesystem and creates a stable image on disk. | |
| 20 | .B fsfreeze | |
| 21 | is intended to be used with hardware RAID devices that support the creation | |
| 22 | of snapshots. | |
| 23 | .PP | |
| 24 | .B fsfreeze | |
| 25 | is unncessary for | |
| 26 | .B device-mapper | |
| 27 | devices. The device-mapper (and LVM) | |
| 28 | automatically freezes filesystem on the device when a snapshot creation is requested. | |
| 29 | For more details see the | |
| 30 | .BR dmsetup (8) | |
| 31 | man page. | |
| 32 | .PP | |
| 33 | The | |
| 34 | .I mount-point | |
| 35 | argument is the pathname of the directory where the filesystem | |
| 36 | is mounted. | |
| 37 | The filesystem must be mounted to be frozen (see | |
| 38 | .BR mount (8)). | |
| 39 | .SH OPTIONS | |
| 40 | .IP "\fB\-h, \-\-help\fP" | |
| 41 | Print help and exit. | |
| 42 | .IP "\fB\-f, \-\-freeze\fP" | |
| 43 | This option requests the specified a filesystem to be frozen from new | |
| 44 | modifications. When this is selected, all ongoing transactions in the | |
| 45 | filesystem are allowed to complete, new write system calls are halted, other | |
| 46 | calls which modify the filesystem are halted, and all dirty data, metadata, and | |
| 47 | log information are written to disk. Any process attempting to write to the | |
| 48 | frozen filesystem will block waiting for the filesystem to be unfrozen. | |
| 49 | ||
| 50 | Note that even after freezing, the on-disk filesystem can contain | |
| 51 | information on files that are still in the process of unlinking. | |
| 52 | These files will not be unlinked until the filesystem is unfrozen | |
| 53 | or a clean mount of the snapshot is complete. | |
| 54 | .IP "\fB\-u, \-\-unfreeze\fP | |
| 55 | This option is used to un-freeze the filesystem and allow operations to | |
| 56 | continue. Any filesystem modifications that were blocked by the freeze are | |
| 57 | unblocked and allowed to complete. | |
| 58 | .SH AUTHOR | |
| 59 | .PP | |
| 60 | Written by Hajime Taira. | |
| 61 | .SH NOTES | |
| 62 | .PP | |
| 63 | This man page based on xfs_freeze. | |
| 64 | One of | |
| 65 | .B \-f | |
| 66 | or | |
| 67 | .B \-u | |
| 68 | must be supplied to | |
| 69 | .BR fsfreeze . | |
| 70 | .SH SEE ALSO | |
| 71 | .BR mount (8) | |
| 72 | .SH AVAILABILITY | |
| 73 | The fsfreeze command is part of the util-linux-ng package and is available from | |
| 74 | ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/. | |
| 75 |