diff --git a/FRequest/FRequest-protocol.md b/FRequest/FRequest-protocol.md index ab05e52..b45dd09 100644 --- a/FRequest/FRequest-protocol.md +++ b/FRequest/FRequest-protocol.md @@ -37,3 +37,7 @@ Status codes can be the following characters: 4. The server closes the connection when the transfer is completed. Servers may wish to implement restricting users to a specific directory. + +## Implementations + +- [OpenOS reference implementation](OpenOS/README.md) diff --git a/FRequest/OpenOS/README.md b/FRequest/OpenOS/README.md new file mode 100644 index 0000000..4eab152 --- /dev/null +++ b/FRequest/OpenOS/README.md @@ -0,0 +1,55 @@ +# Minitel for OpenOS + +This package includes the FRequest daemon, in etc/rc.d/frequest.lua, and the fget FRequest client, in usr/bin/fget.lua. + +## fget client + +### Installation + +#### With OPPM + +1. Run `oppm install fget` + +#### Manual + +1. Place fget.lua into /usr/bin + +### Invocation + +fget can be used to get both directory listings and files, provided the server allows it. + +To use fget, run: + +``` +fget +``` + +## fserv daemon + +fserv is the FRequest server. It provides directory listing and file transfer. + +### Installation + +#### With OPPM + +1. Run `oppm install frequestd` + +#### Manual + +1. Place fserv.lua into /etc/rc.d +2. Run rc frequestd enable; rc minitel start + +### Configuration + +The fserv daemon does not keep a configuration file, so settings have to be set every boot. + +To change a setting, one invokes: + +`rc fserv set_