diff --git a/README.md b/README.md index d3b776f..f4f2d83 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,7 @@ Or after cloning: git submodule update --init --recursive ``` -## Building - -Build everything from the monorepo root: +Build and install everything from the monorepo root: ```bash mk @@ -32,12 +30,14 @@ mk tui # Build terminal UI mk 9p # Build 9p filesystem server ``` -For Emacs Lisp, copy `el/ollie.el` into your own Emacs configuration directory, and: +For Emacs Lisp, copy `el/ellie.el` into your own Emacs configuration directory, and: ```lisp -(require 'ollie) +(require 'ellie) ``` +See [doc/USAGE.md](doc/USAGE.md) for usage instructions. + ## Configuration ### Environment: `~/.config/ollie/env` diff --git a/doc/USAGE.md b/doc/USAGE.md index 5629e06..be88462 100644 --- a/doc/USAGE.md +++ b/doc/USAGE.md @@ -1,6 +1,44 @@ # Usage -Examples assume `$OLLIE` is set to the ollie mount point (default: `$HOME/mnt/ollie`). +## Server + +### Start and stop + +```sh +olliesrv start # start in background (daemonizes) +olliesrv fgstart # start in foreground +olliesrv stop # stop the daemon +olliesrv status # check if running +``` + +By default the server mounts at `$HOME/mnt/ollie`. Override with `-mount`: + +```sh +olliesrv start -mount /tmp/ollie +``` + +### TCP listener + +To also accept connections over TCP (e.g. for remote access): + +```sh +olliesrv start -tcp :9564 +``` + +### Debug logging + +Log level is controlled by `OLLIE_LOG` (default: `warn`). Set to `debug` for verbose output: + +```sh +OLLIE_LOG=debug olliesrv fgstart +``` + +Valid levels: `debug`, `info`, `warn`, `error`. Per-subsystem overrides follow the pattern +`OLLIE__LOG=debug` where `` matches the logger's tag (e.g. `OLLIE_SESSION_LOG`). + +--- + +Examples below assume `$OLLIE` is set to the ollie mount point (default: `$HOME/mnt/ollie`). Scripts under `s/`, `b/`, and `u/` are available directly via the mounted filesystem after running `mk && mk scripts`. diff --git a/el b/el index 0e89242..db54118 160000 --- a/el +++ b/el @@ -1 +1 @@ -Subproject commit 0e89242e8351204c42c59dade966de5643954054 +Subproject commit db541185131834db96a931478b5525eb3cc2dfb8