nilfs-utils/man/rmcp.8
Ryusuke Konishi d7886f6583 man: update manual pages for device/node argument support
Update the synopsis and description sections of the manual pages for
chcp, dumpseg, lscp, lssu, mkcp, nilfs-clean, and rmcp.

This reflects the recent changes allowing these tools to accept a
filesystem node (file or directory) argument in place of a block device,
automatically resolving the backing device via the library.

Also update the version date and number to "Jan 2026" and "2.3"
respectively.

Signed-off-by: Ryusuke Konishi <konishi.ryusuke@gmail.com>
2026-01-21 20:53:35 +09:00

64 lines
1.7 KiB
Groff

.\" Copyright (C) 2007-2012 Nippon Telegraph and Telephone Corporation.
.\" Written by Ryusuke Konishi <konishi.ryusuke@gmail.com>
.\"
.TH RMCP 8 "Jan 2026" "nilfs-utils version 2.3"
.SH NAME
rmcp \- remove NILFS2 checkpoints
.SH SYNOPSIS
.B rmcp
[\fIoptions\fP] [\fIdevice\fP|\fInode\fP] \fIcheckpoint-range\fP ...
.SH DESCRIPTION
.B rmcp
is a utility for removing checkpoints from the NILFS2 file system
found in \fIdevice\fP. The checkpoints which user wants to remove are
specified with one or more \fIcheckpoint-ranges\fP.
.I device
may be a block device or a filesystem node (file or directory) on the
filesystem.
When \fIdevice\fP
is omitted, rmcp tries to find a NILFS2 file system from
\fI/proc/mounts\fP.
.PP
The \fIcheckpoint-range\fP must be provided with one or two integers
in one of the following way:
.TP
.BR cno
single checkpoint number
.TP
.BR start..end
every checkpoint number between \fBstart\fP and \fBend\fP
.TP
.BR ..end
every checkpoint number equal or younger than \fBend\fP
.TP
.BR start..
every checkpoint number equal or greater than \fBstart\fP
.PP
This command is valid only for mounted NILFS2 file systems, and
will fail if the \fIdevice\fP has no active mounts.
.SH OPTIONS
.TP
\fB\-f\fR, \fB\-\-force\fR
Ignore snapshots or nonexistent checkpoints.
.TP
\fB\-i\fR, \fB\-\-interactive\fR
Prompt before any removal.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display help message and exit.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display version and exit.
.SH AUTHOR
Koji Sato, Ryusuke Konishi <konishi.ryusuke@gmail.com>.
.SH AVAILABILITY
.B rmcp
is part of the nilfs-utils package and is available from
https://nilfs.sourceforge.io.
.SH SEE ALSO
.BR nilfs (8),
.BR lscp (1),
.BR mkcp (8),
.BR chcp (8),
.BR nilfs-tune (8).