.TH BOOKMARKCTL 1 "Dec 01, 2024" 0.1.0 "BookmarkFS User Manual"
.
.SH NAME
bookmarkctl - manage a mounted BookmarkFS filesystem
.
.SH SYNOPSIS
.B bookmarkctl
.I subcmd
.RI [ args ]
.PP
.B "bookmarkctl permd"
.I pathname
.I op
.I name1
.I name2
.PP
.B "bookmarkctl fsck"
.I pathname
.I op
.PP
.B "bookmarkctl help"
.PP
.B "bookmarkctl version"
.
.SH DESCRIPTION
The
.B bookmarkctl
program is a command-line wrapper for various I/O controls of a BookmarkFS
filesystem.
.SS Permute directory entries
The
.B permd
sub-command re-arranges the order of the directory entries returned from
.BR readdir (3)
calls.
.PP
The
.I pathname
argument is the path to the directory.
The
.I name1
and
.I name2
arguments are filenames under that directory.
.PP
The
.I op
argument is the operation to perform on the directory:
.TP
.B swap
Exchange the positions of the directory entries represented by
.I name1
and
.IR name2 .
.TP
.BR move\-before | move\-after
Move the directory entry represented by
.I name1
to the position just before/after the one represented by
.IR name2 .
.SS Filesystem check
The
.B fsck
sub-command checks for errors within a BookmarkFS filesystem.
.PP
The
.I pathname
argument is the path to the directory to perform checks on.
.PP
The
.I op
argument is the operation to perform on the directory:
.TP
.B list
Display a list of errors found under the given directory.
Will not recurse into subdirectories.
.PP
For the full fsck functionalities, use
.BR fsck.bookmarkfs (1).
.
.SH EXIT STATUS
.TP
0
The operation completed successfully.
.TP
1
An error occurred.
.
.SH NOTES
.SS Availability on FreeBSD
By the time this manual is written, this program is not available on
stable releases of FreeBSD, since the latter does not yet support
.BR ioctl (2)
in its
.BR fusefs (5)
implementation.
.
.SH SEE ALSO
.BR fsck.bookmarkfs (1),
.BR mount.bookmarkfs (1),
.BR ioctl (2),
.BR readdir (3),
.BR fusefs (5)
.PP
The full BookmarkFS User Manual is maintained as a Texinfo document.
To read it locally, run:
.PP
.in +4n
.EX
.B info bookmarkfs
.EE
.in
.
.SH COPYRIGHT
Copyright (C) 2024  CismonX <admin@cismon.net>
.PP
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.PP
You should have received a copy of the license along with this document.
If not, see <https://www.gnu.org/licenses/fdl-1.3.html>.