Document FUSE mount and 9pfuse dependency

This commit is contained in:
Levi Neely 2026-03-20 17:13:35 +01:00
parent 76f7baae25
commit c5c2c4ab1d
1 changed files with 10 additions and 1 deletions

View File

@ -2,6 +2,10 @@
9P server for [denote](https://protesilaos.com/emacs/denote) notes. 9P server for [denote](https://protesilaos.com/emacs/denote) notes.
## Dependencies
- [plan9port](https://9fans.github.io/plan9port/) (provides `9pfuse`)
## Installation ## Installation
```sh ```sh
@ -17,6 +21,9 @@ denotesrv status
denotesrv stop denotesrv stop
``` ```
On startup, the server automatically mounts at `~/mnt/denote` via 9pfuse.
Use `-mount /path` to override the mount location.
## Environment ## Environment
| Variable | Default | Description | | Variable | Default | Description |
@ -28,16 +35,18 @@ denotesrv stop
``` ```
denote/ denote/
ctl (write) filter <query>, cd <path> ctl (write) filter <query>, cd <path>, refresh
event (read) Event stream event (read) Event stream
index (read) Note metadata (respects filter) index (read) Note metadata (respects filter)
new (write) Create note: "'title' tag1,tag2" new (write) Create note: "'title' tag1,tag2"
n/ n/
<id>/ <id>/
backlinks (read) Notes linking to this note backlinks (read) Notes linking to this note
body (rw) File content
ctl (write) 'd' to delete ctl (write) 'd' to delete
keywords (rw) Tags keywords (rw) Tags
path (rw) Filesystem path path (rw) Filesystem path
signature (rw) Note signature
title (rw) Note title title (rw) Note title
``` ```