diff options
| author | Ryan Kavanagh <rak@rak.ac> | 2019-07-17 13:28:59 -0400 |
|---|---|---|
| committer | Solderpunk <solderpunk@sdf.org> | 2019-08-31 10:32:30 +0000 |
| commit | d5754a9e8f8928199d7f2b6e67f2bfbbf84ff41c (patch) | |
| tree | 92acc2d0f2d5b27e511d7ebcd4f4e9de777eb2f8 | |
| parent | Extended help now opens the man page (diff) | |
add a README
Signed-off-by: Solderpunk <solderpunk@sdf.org>
| -rw-r--r-- | README | 22 |
1 files changed, 22 insertions, 0 deletions
@@ -0,0 +1,22 @@ +To run telem on a Debian-based system, you will need to install the +following packages: + + sudo apt install lua-penlight lua-posix + +By default, telem stores BBS-related files unter /var/bbs . To change this +path, edit the variable _BBS_ROOT in telem.lua . Under _BBS_ROOT, you will +need to create the following hierarchy: + + boards/ + docs/ + welcome -- your welcome message + rules -- your BBS's rules + +This hierarchy must be writeable by the telem client. To avoid having +it accessible by all users, a C wrapper is provided. We recommend +creating a `bbs' user that owns _BBS_ROOT and installing the C wrapper +setuid bbs. + +The man page `telem.1' should be installed in the `man1' folder at an +appropriate location in your MANPATH, e.g., at + /usr/local/man/man1/telem.1 |