~aleteoryx/ntalk

3d9f9df366e042387f191117d6187fb7c33d576b — Aleteoryx 2 months ago e1e29d9
document client
1 files changed, 24 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +24 -0
@@ 4,6 4,7 @@

see also [neauoire's client][100r] and probably other things


## `ntalk.sh`: simple nanotalk server

meant to be run under a connection broker like socat.


@@ 12,5 13,28 @@ probably there's a chance of the file being clobbered.
will get slower with more scrollback, cause it's just
implemented with tail and head and wc. :P

## `ntalk.tcl`: tcl/tk nanotalk client

requires you have wish(1) installed.

boots to a config file, in which you can set fonts and stuff
the connection is done entirely over $sok, so set that to whatever.
if you want to include e.g. ssl, go ahead. the config file is saved
to/read from ~/.config/ntalk/cscript.tcl.

if $cmds is set, it will be used for command parsing. it is inserted
into the body of a switch statement, with globbing enabled. you do
not need to start your commands with /. if $server is set, it'll be
shown in the top bar. if $user is set, it'll be used for the username.

to see the builtin commands, read the source code. they're torwards
the bottom.

if tklib is installed, history will be setup on the main input box.

Ctrl-Shift-R will restart the client, allowing you to test config
changes rapidly. Ctrl-Q exits.


[src]: https://git.phial.org/d6/nanochat
[100r]: https://git.sr.ht/~rabbits/nanotalk