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: make examples more intuitive

Browse source
This commit is contained in:
CismonX 2025-01-02 17:06:51 +08:00
parent babeca2dcd
commit 3d56aa560f
No known key found for this signature in database
GPG key ID: 3094873E29A482FB
1 changed files with 3 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/bookmarkfs.texi
View file

@ -228,10 +228,10 @@ Applications should tread lightly if they wish to cache tag directory entries.
To associate a bookmark with a tag, use @posixfuncmanpage{link}:
@example
fd = openat(dirfd, "tags/gnu/readline", O_CREAT | O_WRONLY, 0600);
fd = open("tags/gnu/readline", O_CREAT | O_WRONLY, 0600);
// Oops, fd == -1, errno == EPERM
fd = linkat(dirfd, "bookmarks/other/readline", dirfd, "tags/gnu/readline", 0);
fd = link("bookmarks/other/readline", "tags/gnu/readline", 0);
// OK!
@end example
@ -330,23 +330,13 @@ application bookmarks.
Typically, backends are built into shared libraries, and are installed as:
@example
$@{pkglibdir@}/backend-$@{short_name@}$@{shlib_suffix@}
$@{libdir@}/bookmarkfs/backend-$@{short_name@}$@{shlib_suffix@}
@end example
Where @code{$@{short_name@}} is the name passed to the frontend program, and
@code{$@{shlib_suffix@}} is the common filename extension for shared library
files on the current platform (e.g. @code{.so} on GNU/Linux and FreeBSD).
For example, when mounting a BookmarkFS filesystem with:
@example
$ /usr/local/bin/mount.bookmarkfs -o backend=firefox \
> ~/.mozilla/firefox/my-profile/places.sqlite /mnt/firefox
@end example
The @code{mount.bookmarkfs} program loads the bookmark file using the
backend module @code{/usr/local/lib/bookmarkfs/backend-firefox.so}.
Currently, BookmarkFS ships with two backends.
One for Firefox, the other for Chromium.
If you which to add support for more backends,