From 10cc9c05c4786f53266ba7c3615b956fcb3eda4a Mon Sep 17 00:00:00 2001 From: Artem Titoulenko Date: Fri, 24 Dec 2021 13:45:42 -0500 Subject: [PATCH] readme --- Readme.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/Readme.md b/Readme.md index b049a8f..1f0392a 100644 --- a/Readme.md +++ b/Readme.md @@ -23,3 +23,30 @@ Clone this repository, make sure you have [Go](https://go.dev/) installed in you ``` $ go build && ./aim-oscar ``` + +### Configuration + +Environment flags: + +- OSCAR_HOST: hostname of the server +- OSCAR_PORT: port to bind to +- OSCAR_BOS_HOST: hostname of Basic OSCAR Service that provides core client features +- OSCAR_BOS_PORT: port of Basic OSCAR Service + +Flags: + +- `-host`: hostname of server +- `-port`: port to bind to +- `-boshost`: hostname of Basic OSCAR Service +- `-bosort`: port of Basic OSCAR Service +- `-h`: see help information about flags + +### Terms + +_mirrored from [iserverd](http://iserverd.khstu.ru/oscar/terms.html)_ + +- `BOS`: Basic OSCAR Service. This term refers to the services that form the core of the Instant Messenger service. These services include Login/Logoff, Locate, Instant Message, Roster management, Info management and Buddy List +- `FLAP` is a low-level communications protocol that facilitates the development of higher-level, record-oriented, communications layers. It is used on the TCP connection between all clients and servers. +- `SNAC`: A SNAC is the basic communication unit that is exchanged between clients and servers. The SNAC communication layers sits on top of the FLAP layer. +- `TLV`: Type Length Value. A tuple allowing typed opaque information to be passed through the protocol. Typically TLV's are intended for interpretation at the core layer. Being typed, new elements can be added w/o modifying the lower layers. +- `ICBM`: Inter Client Basic Message. ICBM is a channelized client-to-client mechanism. Currently the most user visible channel is used for Instant Messages.