Update socket interface documentaton

This commit is contained in:
Martin Lund 2022-04-20 12:08:40 +02:00
parent af93efb9e4
commit 45c32f78a8
2 changed files with 9 additions and 3 deletions

View file

@ -115,14 +115,20 @@ Colorize tio text using ANSI color code ranging from 0 to 255.
If color code is negative a list of available ANSI colors will be printed. If color code is negative a list of available ANSI colors will be printed.
.TP .TP
.BR \-S ", " "\-\-socket unix:\fI<filename>\fR\fB .BR \-S ", " "\-\-socket \fI<socket>\fR\fB
Listen on a Unix domain socket at the specified path. Any input from clients connected to the socket is sent on the serial port as if entered at the terminal where tio is running (except that Listen on socket. Any input from clients connected to the socket is sent on the serial port as if entered at the terminal where tio is running (except that
.B ctrl-t .B ctrl-t
sequences are not recognized), and any input from the serial port is multiplexed to the terminal and all connected clients. sequences are not recognized), and any input from the serial port is multiplexed to the terminal and all connected clients.
Sockets remain open while the serial port is disconnected, and writes will block. Sockets remain open while the serial port is disconnected, and writes will block.
Two socket types are supported using different prefixes in the socket field:
unix:<filename> - Unix Domain Socket (file)
inet:<IP>:<port> - Internet Socket (network) (NOT YET SUPPORTED)
At present there is a hardcoded limit of 16 clients connected at one time. At present there is a hardcoded limit of 16 clients connected at one time.
.TP .TP

View file

@ -74,7 +74,7 @@ void print_help(char *argv[])
printf(" -l, --log[=<filename>] Log to file\n"); printf(" -l, --log[=<filename>] Log to file\n");
printf(" -m, --map <flags> Map special characters\n"); printf(" -m, --map <flags> Map special characters\n");
printf(" -c, --color <code> Colorize tio text\n"); printf(" -c, --color <code> Colorize tio text\n");
printf(" -S, --socket <filename> Listen on domain socket\n"); printf(" -S, --socket <socket> Listen on socket\n");
printf(" -v, --version Display version\n"); printf(" -v, --version Display version\n");
printf(" -h, --help Display help\n"); printf(" -h, --help Display help\n");
printf("\n"); printf("\n");