man/btrfsctl.8.in

   1 .TH BTRFSCTL 8
   2 .SH NAME
   3 btrfsctl \- control a btrfs filesystem
   4 .SH SYNOPSIS
   5 .B btrfsctl
   6 [ \fB\-d\fP\fI file|directory \fP ]
   7 [ \fB\-s\fP\fI snapshot-name directory\fP ]
   8 [ \fB \-S\fP\fI subvolume-name directory\fP ]
   9 [ \fB \-r\fP\fI [+-]size\fP ]
  10 [ \fB \-A\fP\fI device\fP ]
  11 [ \fB \-a\fP ]
  12 [ \fB \-c\fP ]
  13 .SH NOTE
  14 B btrfsctl
  15 is deprecated. Please consider to switch to the btrfs utility.
  16 .SH DESCRIPTION
  17 .B btrfsctl
  18 is used to control the filesystem and the files and directories stored. It is the tool to create a new snapshot for the filesystem.
  19 .SH OPTIONS
  20 .TP
  21 \fB\-d\fR \fIfile|directory\fR
  22 Defragment a file or a directory. If the argument is a directory, the entire b-tree under the directory is defragged.
  23 .TP
  24 \fB\-s\fR \fIsnapshot-name directory\fR
  25 Creates a new \fIsnapshot\fP of the \fIdirectory\fP specified.
  26 .TP
  27 \fB\-S\fR \fIsubvolume-name directory\fR
  28 Creates a new subvolume.
  29 .TP
  30 \fB\-r\fR \fI[+|-]size\fR
  31 Resizes the filesystem with the \fIsize\fP specified. If the value is preceded with a signed symbol, the filesystem is resized with respect to the current filesystem size. \fIsize\fP can be suffixed by k,m or g to represent kilobytes, megabytes, or gigabytes respectively.
  32 .TP
  33 \fB\-A\fR \fIdevice\fR
  34 Scans the \fIdevice\fR for btrfs filesystem.
  35 .TP
  36 \fB\-a\fR
  37 Scans all devices present in the system for btrfs filesystem.
  38 .TP
  39 \fB\-c\fR
  40 Forces a filesystem sync.
  41 .SH AVAILABILITY
  42 .B btrfsctl
  43 is part of btrfs-progs. Btrfs is currently under heavy development,
  44 and not suitable for any uses other than benchmarking and review.
  45 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
  46 further details.
  47 .SH SEE ALSO
  48 .BR mkfs.btrfs (8)