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: misc refactor

Browse source
This commit is contained in:
CismonX 2025-01-21 19:24:02 +08:00
parent 12fb17463a
commit 6989f1e828
No known key found for this signature in database
GPG key ID: 3094873E29A482FB
1 changed files with 20 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
doc/bookmarkfs.texi
View file

@ -95,7 +95,7 @@ Write to the
for bug reports, feature requests, and other discussions. for bug reports, feature requests, and other discussions.
@node Porting @node Porting BookmarkFS
@section Porting BookmarkFS @section Porting BookmarkFS
Currently, BookmarkFS only runs on GNU/Linux and FreeBSD. Currently, BookmarkFS only runs on GNU/Linux and FreeBSD.
@ -1036,7 +1036,6 @@ Read permission is denied for the directory.
@end table @end table
@item BOOKMARKFS_IOC_FSCK_APPLY @item BOOKMARKFS_IOC_FSCK_APPLY
``Repair'' a bookmark by renaming it. ``Repair'' a bookmark by renaming it.
The @code{id} field must be set to a value previously obtained from The @code{id} field must be set to a value previously obtained from
@ -1109,10 +1108,15 @@ Typically, backends are built into shared libraries, and are installed as:
@var{$@{pkglibdir@}}/backend-@var{$@{name@}}@var{$@{shlib_suffix@}} @var{$@{pkglibdir@}}/backend-@var{$@{name@}}@var{$@{shlib_suffix@}}
@end example @end example
Where @var{$@{name@}} is the backend name, equivalent to the value given to the @table @var
@option{-o backend=@var{name}} option of frontend programs, @item $@{name@}
and @var{$@{shlib_suffix@}} is the common filename extension for shared library The backend name, equivalent to the value given to the
files on the current platform (e.g. @file{.so} on GNU/Linux and FreeBSD). @option{-o backend=@var{name}} option of frontend programs.
@item $@{shlib_suffix@}
The common filename extension for shared library files on the current platform
(e.g. @file{.so} on GNU/Linux and FreeBSD).
@end table
@node Firefox @node Firefox
@ -1414,7 +1418,7 @@ struct bookmarkfs_backend @{
bookmarkfs_bookmark_rename_func *bookmark_rename; bookmarkfs_bookmark_rename_func *bookmark_rename;
bookmarkfs_bookmark_set_func *bookmark_set; bookmarkfs_bookmark_set_func *bookmark_set;
bookmarkfs_object_free_func *object_free; bookmarkfs_object_free_func *object_free;
@}; @};
@end example @end example
@ -1437,10 +1441,15 @@ shared libraries, and are installed as:
@var{$@{pkglibdir@}}/fsck-handler-@var{$@{name@}}@var{$@{shlib_suffix@}} @var{$@{pkglibdir@}}/fsck-handler-@var{$@{name@}}@var{$@{shlib_suffix@}}
@end example @end example
Where @var{$@{name@}} is the handler name, equivalent to the value given to @table @var
the @option{-o handler=@var{name}} option of @command{fsck.bookmarkfs}, @item $@{name@}
and @var{$@{shlib_suffix@}} is the common filename extension for shared library The handler name, equivalent to the value given to the
files on the current platform (e.g. @file{.so} on GNU/Linux and FreeBSD). @option{-o handler=@var{name}} option of @command{fsck.bookmarkfs}.
@item $@{shlib_suffix@}
The common filename extension for shared library files on the current platform
(e.g. @file{.so} on GNU/Linux and FreeBSD).
@end table
@node Built-in Filesystem-Check Handler @node Built-in Filesystem-Check Handler