agendafs

A filesystem for your calendar.

commit de21ca2af448d4dba640b361ec6a4e352268b63e
parent 696ac901dc69f788588f74cff8a26acdba78dade
Author: Marc Coquand <marc@coquand.email>
Date:   Sun, 27 Jul 2025 10:40:28 +0200

Add agendafs.8.scd

Diffstat:
A
agendafs.8.scd
 | 
80
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

1 file changed, 80 insertions(+), 0 deletions(-)
diff --git a/agendafs.8.scd b/agendafs.8.scd
@@ -0,0 +1,80 @@
+MOUNT.AGENDAFS(8)
+
+# NAME
+
+mount.agendafs - Mount notes from vdir storages
+
+# SYNOPSIS
+
+*mount.agendafs* [-fnrsvw] [-o _OPTIONS_] _MOUNTPOINT_
+
+# OPTIONS
+
+Most mount options are described in _mount.fuse_(8) and _mount_(8).
+
+*vdir=*_vdirpath_
+	Use the specified vdir storage path as mountpoint. Currently
+	only one calendar is supported. 
+
+# DESCRIPTION
+
+Agendafs is a virtual filesystem that loads vdir storages to a mountpoint, 
+allowing you to create and edit notes.
+
+
+# XATTRIBUTES
+
+Agendafs has support for _xattr_(7) to modify icalendar fields. See the
+man pages of _xattr_(7), _setfattr_(1), _getfattr_(1) for basic usage.
+Supported extended attributes are:
+
+	*user.categories*
+		A comma separated list of categories to classify an entry.
+	*user.class*
+		The classification of an entry. Can be either *public*,
+		*private* or *confidential*.
+
+# EXAMPLE
+
+Mount vdir storage with agendafs to your home journal directory:
+
+	```
+	$ mount.agendafs -o vdir=$HOME/.calendars/vjournal-calendar \
+	  $HOME/journal
+	```
+
+Find all files with categories, and their categories:
+
+	```
+	$ find . -type f -exec getfattr -n user.categories {} \
+	  + 2>/dev/null
+	```
+
+Find files by category:
+
+	```
+	$ find . -type f -exec getfattr -n user.categories {} + 2>/dev/null \
+	  | grep -B1 "MY_CATEGORY" \
+	  | grep '^# file' \
+	  | awk '{ print substr($0, 9) }'
+	```
+
+# SEE ALSO
+
+_pimsync_(1)
+_mount.fuse_(8)
+_mount_(1)
+_fusermount_(1)
+_xattr(7)_
+_getfattr(1)_
+_setfattr(1)_
+
+vdirsyncer (https://vdirsyncer.pimutils.org/en/stabl)
+
+
+# AUTHORS
+
+Maintained by Marc Coquand <marc@coquand.email>. Up do date sources can be found at
+https://git.sr.ht/~marcc/agendafs and bugs/patches can be submitted by email to
+~marcc/agendafs@lists.sr.ht.
+