shithub: svcfs

Info  •  Files  •  Log  •  Branches

More readme updates

--- a/README

+++ b/README

@@ -1,20 +1,21 @@

-svc/fs

+# svc/fs

+## Creating Services

 This mounts a directory at (default) `/mnt/svc`

- - -m <mntpnt> 

+ - -m <mtpt> 

  - -s <srvname> will post to /srv/srvname

 `/mnt/svc` initially has a file, `clone`.

 Opening `clone` will create a numerical directory starting at `/mnt/svc/0`.

-The first write must be the name of the service. This will post a file to /srv/<service> that clients can mount into there namespace for a session with a given service

+The first write must be the name of the service. This will post a file to /srv/<service> that clients can mount into their namespace for a session with a given service

 Ctl messages on /mnt/svc/n/ctl

 (Note, newlines are important!)

-- `create <buffername>`: This will create a buffer. This must be called before any of the following

-- `title <buffername>\ntitle text`: This will set the title of a given buffer

-- `feed <buffername>\nsome text`: This will be appended to a given buffers' feed file

+- `create <buff>`: This will create a buffer. This must be called before any of the following

+- `title <buff>\ntitle text`: This will set the title of a given buffer

+- `feed <buff>\nsome text`: This will be appended to a given buffers' feed file

-Working with services:

+## Working with Services

 `mount /srv/<svc> /mnt/<svc>`

 eg, mount /srv/oftc /mnt/oftc

@@ -32,3 +33,8 @@

 `echo 'buffer #cat-v' >> /mnt/oftc/ctl`

+## Namespace Considerations

+

+- Each unique mount of /srv/<svc> is multiplexed, so you can create clients that can view different/multiple buffers from a single service

+- Unreads/read states will be synchronized

+-

\ No newline at end of file

-- 

⑨