makary/bookmarkfs
1
0
Fork 0
mirror of https://git.sr.ht/~cismonx/bookmarkfs synced 2025-06-07 19:58:50 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: minor update

Browse source
This commit is contained in:
CismonX 2025-01-26 19:39:13 +08:00
parent 3ed11f53e5
commit 579f396e46
No known key found for this signature in database
GPG key ID: 3094873E29A482FB
1 changed files with 14 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
doc/bookmarkfs.texi
View file

@ -57,7 +57,6 @@ is included in the section entitled ``GNU Free Documentation License''.
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@ -430,7 +429,7 @@ Its exact interpretation is equivalent to the first argument for
If this option is not provided, or @var{name} is empty,
a built-in handler will be used.
@xref{Built-in Filesystem-Check Handler}.
@xref{Built-in Handler}.
@item -o %@var{key}[=@var{value}]
A handler-specific option.
@ -1118,7 +1117,7 @@ The common filename extension for shared library files on the current platform
@end table
@node Firefox
@node Firefox Backend
@section Firefox Backend
The Firefox backend provides access to the bookmark data of the web browser
@ -1232,7 +1231,7 @@ the Unix epoch.
@end table
@node Chromium
@node Chromium Backend
@section Chromium Backend
The Chromium backend provides access to the bookmark data of the web browser
@ -1377,7 +1376,7 @@ frontend program (e.g., @command{mount.bookmarkfs}).
@quotation Warning
Currently BookmarkFS is experimental.
Content in this section may change drastically without prior notice.
The Backend API may change drastically without prior notice.
@end quotation
@anchor{Backend Symbol Name Format}
@ -1766,10 +1765,11 @@ The common filename extension for shared library files on the current platform
@end table
@node Built-in Filesystem-Check Handler
@node Built-in Handler
@section Built-in Handler
The built-in handler is linked into the @command{fsck.bookmarkfs} program.
The built-in filesystem-check handler is linked into the
@command{fsck.bookmarkfs} program.
It has minimal functionalities, but is capable enough to handle most
common fsck scenarios.
@ -1854,10 +1854,11 @@ The optional @samp{-} suffix inhibits the default behavior of continuing
to the next entry, after the command completes successfully.
@node Tcl-Based Filesystem-Check Handler
@node Tcl-Based Handler
@section Tcl-Based Handler
The Tcl-based handler allows fsck entries to be handled via Tcl scripting.
The Tcl-based filesystem-check handler allows fsck entries to be handled
via Tcl scripting.
Handler name: @samp{tcl}.
@ -1972,7 +1973,7 @@ Skip current directory and all subdirectories.
Rewind all.
@end table
Here is an example script that simply prints each fsck entry
Here is an example Tcl script that simply prints each fsck entry
(requires the @option{unsafe} option):
@example tcl
@ -1991,15 +1992,15 @@ coroutine whatever apply @{@{@} @{
@end example
@node Filesystem-Check Handler API
@node Handler API
@section Handler API
The Filesystem-Check API specifies how a fsck handler communicates with
The Filesystem-Check Handler API specifies how a fsck handler communicates with
@command{fsck.bookmarkfs}.
@quotation Warning
Currently BookmarkFS is experimental.
Content in this section may change drastically without prior notice.
The Handler API may change drastically without prior notice.
@end quotation
@anchor{Filesystem-Check Handler Symbol Name Format}