luxferre/tii
1
0
Fork 0
Code Actions Activity

updated readme to reflect recent changes

Browse Source
This commit is contained in:
Luxferre
2024-11-01 07:51:45 +02:00
parent 2f04542cf6
commit 91b42cfb9e
1 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README
+5 -7
View File
@@ -2,14 +2,12 @@ tii: a Tcl-based suite for working with ii/IDEC protocol
======================================================== ========================================================
This suite implements the client side of ii and (partially) IDEC protocols of This suite implements the client side of ii and (partially) IDEC protocols of
distributed, cross-platform, text-based communication (a FIDOnet successor, so distributed, cross-platform, text-based communication (a FIDOnet successor, so
to speak). Protocol documentation can be found here for both ii and IDEC: to speak). See ii-doc.txt for the protocol documentation.
https://github.com/IDEC-net/new-docs/blob/master/protocol-en.md
(this is an official link, see ii-doc.txt for more concise documentation)
The tii suite requires at least Tcl 8.6 to run. Running it inside starpacks is The tii suite requires at least Tcl 8.6 to run. Running it inside starpacks is
possible but not recommended. possible but not recommended.
The tii repo consists of the following parts: The tii distribution consists of the following parts:
* tiifetch.tcl: the core ii/IDEC message fetching library and CLI utility * tiifetch.tcl: the core ii/IDEC message fetching library and CLI utility
* tiipost.tcl: the core ii/IDEC message posting library and CLI utility * tiipost.tcl: the core ii/IDEC message posting library and CLI utility
@@ -17,9 +15,9 @@ The tii repo consists of the following parts:
* tii.db: the SQLite3 database that contains all messages and echo lists * tii.db: the SQLite3 database that contains all messages and echo lists
* config.txt: the set of parameters for all HTTP requests by the tii scripts * config.txt: the set of parameters for all HTTP requests by the tii scripts
* stations.txt: the list of stations to be auto-fetched by tiifetch when none * stations.txt: the list of stations to be auto-fetched by tiifetch when none
of its command-line parameters is passed of its command-line parameters is passed (not included in the repo)
* auth.txt: the list of station/authstring mappings to be used by tiipost when * auth.txt: the list of station/authstring mappings to be used by tiipost when
posting messages to a particular station posting messages to a particular station (not included in the repo)
* tiix.tcl: the GUI ii/IDEC viewer that also leverages tiifetch and tiipost to * tiix.tcl: the GUI ii/IDEC viewer that also leverages tiifetch and tiipost to
provide fetching and posting functionality provide fetching and posting functionality
@@ -150,6 +148,7 @@ the file is a Tcl dictionary (`key "value"`) and has the following fields:
will connect directly) will connect directly)
* proxyport: the HTTP port to use on the proxy (only effective if proxyhost is * proxyport: the HTTP port to use on the proxy (only effective if proxyhost is
set to a non-empty string) set to a non-empty string)
* net_timeout: the timeout (in milliseconds) for all network requests
Any of the fields can be omitted, as well as the file itself. Any of the fields can be omitted, as well as the file itself.
You can also use torsocks with any script invocation in order to fully cloak You can also use torsocks with any script invocation in order to fully cloak
@@ -158,7 +157,6 @@ your originating IP address.
FAQ FAQ
--- ---
- Does tii implement any IDEC extensions? - Does tii implement any IDEC extensions?
Only one: fetching list.txt from the station to get the entire list of echo Only one: fetching list.txt from the station to get the entire list of echo