mirror of
https://github.com/kdave/btrfs-progs
synced 2024-12-12 01:16:13 +00:00
002d021c5f
Hi all,
the patch below deprecates the following programs
* btrfsctl
* btrfs-vol
* btrfs-show
the reason is simple, these programs are superseded by the btrfs utility,
both in terms of documentation, usability and bug. The goal is to avoid
to duplicate codes and avoid update two programs.
The patch adds a warning in the man pages, in the INSTALL file and in the
programs.
$ ./btrfsctl
**
** WARNING: this program is considered deprecated
** Please consider to switch to the btrfs utility
**
no valid commands given
usage: btrfsctl [ -d file|dir] [ -s snap_name subvol|tree ]
[-r size] [-A device] [-a] [-c] [-D dir .]
-d filename: defragments one file
-d directory: defragments the entire Btree
-s snap_name dir: creates a new snapshot of dir
-S subvol_name dir: creates a new subvolume
-r [+-]size[gkm]: resize the FS by size amount
-A device: scans the device file for a Btrfs filesystem
-a: scans all devices for Btrfs filesystems
-c: forces a single FS sync
-D: delete snapshot
-m [tree id] directory: set the default mounted subvolume to the [tree
id] or the
directory
Below the patch, but it is possible to pull the changes from:
http://cassiopea.homelinux.net/git/btrfs-progs-unstable.git
branch
btrfs-deprecated
Comments are welcome.
G.Baroncelli
INSTALL | 5 +++++
btrfs-show.c | 5 +++++
btrfs-vol.c | 5 +++++
btrfsctl.c | 5 +++++
man/btrfs-show.8.in | 3 +++
man/btrfsctl.8.in | 3 +++
6 files changed, 26 insertions(+), 0 deletions(-)
the tool to create a new snapshot for the filesystem.
Signed-off-by: Chris Mason <chris.mason@oracle.com>
49 lines
1.6 KiB
Groff
49 lines
1.6 KiB
Groff
.TH BTRFSCTL 8
|
|
.SH NAME
|
|
btrfsctl \- control a btrfs filesystem
|
|
.SH SYNOPSIS
|
|
.B btrfsctl
|
|
[ \fB\-d\fP\fI file|directory \fP ]
|
|
[ \fB\-s\fP\fI snapshot-name directory\fP ]
|
|
[ \fB \-S\fP\fI subvolume-name directory\fP ]
|
|
[ \fB \-r\fP\fI [+-]size\fP ]
|
|
[ \fB \-A\fP\fI device\fP ]
|
|
[ \fB \-a\fP ]
|
|
[ \fB \-c\fP ]
|
|
.SH NOTE
|
|
B btrfsctl
|
|
is deprecated. Please consider to switch to the btrfs utility.
|
|
.SH DESCRIPTION
|
|
.B btrfsctl
|
|
is used to control the filesystem and the files and directories stored. It is the tool to create a new snapshot for the filesystem.
|
|
.SH OPTIONS
|
|
.TP
|
|
\fB\-d\fR \fIfile|directory\fR
|
|
Defragment a file or a directory. If the argument is a directory, the entire b-tree under the directory is defragged.
|
|
.TP
|
|
\fB\-s\fR \fIsnapshot-name directory\fR
|
|
Creates a new \fIsnapshot\fP of the \fIdirectory\fP specified.
|
|
.TP
|
|
\fB\-S\fR \fIsubvolume-name directory\fR
|
|
Creates a new subvolume.
|
|
.TP
|
|
\fB\-r\fR \fI[+|-]size\fR
|
|
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.
|
|
.TP
|
|
\fB\-A\fR \fIdevice\fR
|
|
Scans the \fIdevice\fR for btrfs filesystem.
|
|
.TP
|
|
\fB\-a\fR
|
|
Scans all devices present in the system for btrfs filesystem.
|
|
.TP
|
|
\fB\-c\fR
|
|
Forces a filesystem sync.
|
|
.SH AVAILABILITY
|
|
.B btrfsctl
|
|
is part of btrfs-progs. Btrfs is currently under heavy development,
|
|
and not suitable for any uses other than benchmarking and review.
|
|
Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
|
|
further details.
|
|
.SH SEE ALSO
|
|
.BR mkfs.btrfs (8)
|