agendafs

A filesystem for your calendar.

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

Improve docs

Diffstat:
M
Makefile
 | 
12
++++++------
M
README.md
 | 
3
+++
D
agendafs.1.scd
 | 
46
----------------------------------------------
M
main.c
 | 
4
++--

4 files changed, 11 insertions(+), 54 deletions(-)
diff --git a/Makefile b/Makefile
@@ -21,17 +21,17 @@ clean:
 	rm -f $(OUTDIR)
 
 manpages:
-	scdoc < agendafs.1.scd > $(OUTDIR)/agendafs.1
+	scdoc < agendafs.8.scd > $(OUTDIR)/agendafs.8
 
 all: agendafs manpages
 
 install:
-	mkdir -p $(DESTDIR)$(BINDIR) $(DESTDIR)$(MANDIR)/man1
+	mkdir -p $(DESTDIR)$(BINDIR) $(DESTDIR)$(MANDIR)/man8
 	install -m755 $(OUTDIR)/mount_agendafs.o $(DESTDIR)$(BINDIR)/mount.agendafs
-	install -m644 $(OUTDIR)/agendafs.1 $(DESTDIR)$(MANDIR)/man1/agendafs.1
-	ln -s $(DESTDIR)$(MANDIR)/man1/agendafs.1 $(DESTDIR)$(MANDIR)/man1/mount.agendafs.1
+	install -m644 $(OUTDIR)/agendafs.8 $(DESTDIR)$(MANDIR)/man8/agendafs.8
+	ln -fs $(DESTDIR)$(MANDIR)/man8/agendafs.8 $(DESTDIR)$(MANDIR)/man8/mount.agendafs.8
 
 uninstall:
 	rm -f $(DESTDIR)$(BINDIR)/mount.agendafs
-	rm -r $(DESTDIR)$(MANDIR)/man1/mount.agendafs.1
-	rm -f $(DESTDIR)$(MANDIR)/man1/agendafs.1
+	rm -r $(DESTDIR)$(MANDIR)/man8/mount.agendafs.8
+	rm -f $(DESTDIR)$(MANDIR)/man8/agendafs.8
diff --git a/README.md b/README.md
@@ -13,6 +13,8 @@ Agendafs is still in early development and is alpha-level software. It probably 
 
 Prerequisites: scdoc (man pages), C compiler, libfuse, libuuid, libical and pkg-config. Optionally a `shell.nix` exists which sets up all dependencies for you.
 
+Some fields, such as categories, are accessed via xattributes (xattr(7)), for that you will need to have the xattribute utilities installed.
+
 You also need to setup a tool that syncs vdir storages to a caldav server, like
 [vdirsyncer](https://vdirsyncer.pimutils.org/en/stable/when.html#) or [pimsync](https://sr.ht/~whynothugo/pimsync/).
 
@@ -22,6 +24,7 @@ To build:
 git clone https://sr.ht/~marcc/agendafs/
 cd agendafs
 make
+make install
 ```
 
 ## Basic principles
diff --git a/agendafs.1.scd b/agendafs.1.scd
@@ -1,46 +0,0 @@
-AGENDAFS(1)
-
-# NAME
-
-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. 
-
-# SEE ALSO
-
-_pimsync_(1)
-_mount.fuse_(8)
-_mount_(1)
-_fusermount_(1)
-
-vdirsyncer (https://vdirsyncer.pimutils.org/en/stabl)
-
-# EXAMPLE
-
-To mount a vdir storage with agendafs:
-
-```
-mount.agendafs -o vdir=/home/bob/.calendars/vjournal-calendar /home/bob/journal
-```
-
-# 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.
-
diff --git a/main.c b/main.c
@@ -676,10 +676,10 @@ main(int argc, char *argv[])
 
 	if (conf.ics_directory == NULL) {
 		fprintf(stderr,
-			"usage: %s mountpoint [options]\n"
+			"usage: %s [options] mountpoint\n"
 			"\n"
 			"agendafs options:\n"
-			"    -o vdir=STRING\n",
+			"    -o vdir=STRING\n\n",
 			argv[0]);
 		fuse_opt_add_arg(&args, "-h");
 		fuse_main(args.argc, args.argv, &fuse_oper, NULL);