mirror of
https://git.sr.ht/~cismonx/bookmarkfs
synced 2025-06-07 19:58:50 +00:00
doc: misc update (mostly style improvements)
This commit is contained in:
parent
f6e3b743d1
commit
402cc1a304
5 changed files with 32 additions and 19 deletions
|
@ -8,18 +8,22 @@ bookmarkctl - manage a mounted BookmarkFS filesystem
|
||||||
.I subcmd
|
.I subcmd
|
||||||
.RI [ args ]
|
.RI [ args ]
|
||||||
.PP
|
.PP
|
||||||
.B "bookmarkctl permd"
|
.B bookmarkctl
|
||||||
|
.B permd
|
||||||
.RI [ options ]
|
.RI [ options ]
|
||||||
.I name1
|
.I name1
|
||||||
.I name2
|
.I name2
|
||||||
.I pathname
|
.I pathname
|
||||||
.PP
|
.PP
|
||||||
.B "bookmarkctl fsck"
|
.B bookmarkctl
|
||||||
|
.B fsck
|
||||||
.I pathname
|
.I pathname
|
||||||
.PP
|
.PP
|
||||||
.B "bookmarkctl help"
|
.B bookmarkctl
|
||||||
|
.B help
|
||||||
.PP
|
.PP
|
||||||
.B "bookmarkctl version"
|
.B bookmarkctl
|
||||||
|
.B version
|
||||||
.
|
.
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
The
|
The
|
||||||
|
@ -117,4 +121,6 @@ or any later version published by the Free Software Foundation;
|
||||||
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
||||||
.PP
|
.PP
|
||||||
You should have received a copy of the license along with this document.
|
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>.
|
If not, see
|
||||||
|
.UR https://www.gnu.org/licenses/fdl-1.3.html
|
||||||
|
.UE .
|
||||||
|
|
|
@ -238,7 +238,7 @@ This option can be provided multiple times.
|
||||||
|
|
||||||
@item -o accmode=@var{mode}
|
@item -o accmode=@var{mode}
|
||||||
File access mode.
|
File access mode.
|
||||||
Defaults to @t{0700}.
|
Defaults to @samp{0700}.
|
||||||
|
|
||||||
This option applies to both directories and regular files.
|
This option applies to both directories and regular files.
|
||||||
Execution bits on regular files are masked off.
|
Execution bits on regular files are masked off.
|
||||||
|
@ -285,7 +285,7 @@ a trailing newline is automatically removed (if one exists).
|
||||||
|
|
||||||
@item -o file_max=@var{bytes}
|
@item -o file_max=@var{bytes}
|
||||||
Max file size limit.
|
Max file size limit.
|
||||||
Defaults to @t{32768}.
|
Defaults to @samp{32768}.
|
||||||
|
|
||||||
This limit also applies to extended attribute values.
|
This limit also applies to extended attribute values.
|
||||||
|
|
||||||
|
@ -3788,7 +3788,8 @@ typedef unsigned long (hashmap_hash_func) (
|
||||||
);
|
);
|
||||||
@end example
|
@end example
|
||||||
|
|
||||||
This function is only called during rehashing and @code{hashmap_entry_delete}.
|
This function is only called during rehashing,
|
||||||
|
and during @code{hashmap_delete} with a negative @code{entry_id}.
|
||||||
@end table
|
@end table
|
||||||
|
|
||||||
Returns an opaque pointer referring to the new hash table.
|
Returns an opaque pointer referring to the new hash table.
|
||||||
|
|
|
@ -69,7 +69,7 @@ is empty, a built-in handler will be used.
|
||||||
A handler-specific option.
|
A handler-specific option.
|
||||||
This option can be provided multiple times.
|
This option can be provided multiple times.
|
||||||
.TP
|
.TP
|
||||||
.B "\-o repair"
|
.B \-o repair
|
||||||
Attempt to repair errors found during fsck.
|
Attempt to repair errors found during fsck.
|
||||||
.TP
|
.TP
|
||||||
\fB\-o rl_app=\fIname\fR
|
\fB\-o rl_app=\fIname\fR
|
||||||
|
@ -90,10 +90,10 @@ Perform fsck on subdirectories recursively.
|
||||||
.IP
|
.IP
|
||||||
This option is ignored when performing fsck on tags or keywords.
|
This option is ignored when performing fsck on tags or keywords.
|
||||||
.TP
|
.TP
|
||||||
.B "\-o no_sandbox"
|
.B \-o no_sandbox
|
||||||
Do not enable sandboxing features.
|
Do not enable sandboxing features.
|
||||||
.TP
|
.TP
|
||||||
.B "\-o no_landlock"
|
.B \-o no_landlock
|
||||||
Do not use
|
Do not use
|
||||||
.BR landlock (7)
|
.BR landlock (7)
|
||||||
for sandboxing.
|
for sandboxing.
|
||||||
|
@ -158,4 +158,6 @@ or any later version published by the Free Software Foundation;
|
||||||
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
||||||
.PP
|
.PP
|
||||||
You should have received a copy of the license along with this document.
|
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>.
|
If not, see
|
||||||
|
.UR https://www.gnu.org/licenses/fdl-1.3.html
|
||||||
|
.UE .
|
||||||
|
|
|
@ -24,7 +24,7 @@ This option is mandatory.
|
||||||
A backend-specific option.
|
A backend-specific option.
|
||||||
This option can be provided multiple times.
|
This option can be provided multiple times.
|
||||||
.TP
|
.TP
|
||||||
.B "\-o force"
|
.B \-o force
|
||||||
Overwrite existing files when creating the filesystem.
|
Overwrite existing files when creating the filesystem.
|
||||||
.TP
|
.TP
|
||||||
.B \-h
|
.B \-h
|
||||||
|
@ -68,4 +68,6 @@ or any later version published by the Free Software Foundation;
|
||||||
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
||||||
.PP
|
.PP
|
||||||
You should have received a copy of the license along with this document.
|
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>.
|
If not, see
|
||||||
|
.UR https://www.gnu.org/licenses/fdl-1.3.html
|
||||||
|
.UE .
|
||||||
|
|
|
@ -44,22 +44,22 @@ Defaults to 0700.
|
||||||
This option applies to both directories and regular files.
|
This option applies to both directories and regular files.
|
||||||
Execution bits on regular files are masked off.
|
Execution bits on regular files are masked off.
|
||||||
.TP
|
.TP
|
||||||
.B "\-o ctime"
|
.B \-o ctime
|
||||||
Maintain last status change time instead of last modification time.
|
Maintain last status change time instead of last modification time.
|
||||||
.IP
|
.IP
|
||||||
See the full user manual for the rationale behind this option.
|
See the full user manual for the rationale behind this option.
|
||||||
.TP
|
.TP
|
||||||
.B "\-o eol"
|
.B \-o eol
|
||||||
Add a newline (ASCII LF character) to the end of each file.
|
Add a newline (ASCII LF character) to the end of each file.
|
||||||
.TP
|
.TP
|
||||||
\fB\-o file_max=\fIbytes\fR
|
\fB\-o file_max=\fIbytes\fR
|
||||||
Max file size limit.
|
Max file size limit.
|
||||||
Defaults to 32768.
|
Defaults to 32768.
|
||||||
.TP
|
.TP
|
||||||
.B "\-o no_sandbox"
|
.B \-o no_sandbox
|
||||||
Do not enable sandboxing features.
|
Do not enable sandboxing features.
|
||||||
.TP
|
.TP
|
||||||
.B "\-o no_landlock"
|
.B \-o no_landlock
|
||||||
Do not use
|
Do not use
|
||||||
.BR landlock (7)
|
.BR landlock (7)
|
||||||
for sandboxing.
|
for sandboxing.
|
||||||
|
@ -139,4 +139,6 @@ or any later version published by the Free Software Foundation;
|
||||||
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
|
||||||
.PP
|
.PP
|
||||||
You should have received a copy of the license along with this document.
|
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>.
|
If not, see
|
||||||
|
.UR https://www.gnu.org/licenses/fdl-1.3.html
|
||||||
|
.UE .
|
||||||
|
|
Loading…
Add table
Reference in a new issue