1
0
mirror of https://github.com/ShadowKatStudios/OC-Minitel.git synced 2024-11-23 10:38:05 +11:00

updated the man page for the minitel daemon

This commit is contained in:
Izaya 2018-08-08 09:44:11 +10:00
parent 3df8ee1146
commit e614eefa90

View File

@ -4,17 +4,20 @@ The Minitel daemon handles receiving and relaying Minitel packets.
## Configuration ## Configuration
The minitel daemon does not keep a configuration file, so settings have to be set every boot. The minitel daemon keeps a settings file in /etc/minitel.cfg, which is loaded on start. This can be edited directly and the daemon restarted, or settings can be changed from the command line.
To change a setting, one invokes: To change a setting, one invokes:
`rc minitel set_<option> value` `rc minitel set <option> <value>`
### Available settings ### Available settings
- port: the physical port the protocol runs over - port: the physical port the protocol runs over
- pctime: the amount of time packets are kept in the packet cache - pctime: the amount of time packets are kept in the packet cache
- retry: how many seconds between resend attempts of reliable packets - retry: how many seconds between resend attempts of reliable packets
- rctime: How long items are kept in the routing cache - rctime: How long items are kept in the routing cache
- retrycount: how many attempts to resend should be made
- route: whether to forward packets
- debug: whether to output debugging info to the display
In addition, one can invoke `rc minitel debug` to get large amounts of debug output, rc `minitel set_route <local_modem> <remote_modem>` to add a static route, and `rc minitel del_route` to delete a static route. In addition, one can invoke to get large amounts of debug output, *rc minitel set_route <hostname> <local_modem> <remote_modem>* to add a static route, and *rc minitel del_route <hostname>* to delete a static route.