From 45c32f78a836e9e19c4d62c19f7f2358eea38113 Mon Sep 17 00:00:00 2001 From: Martin Lund Date: Wed, 20 Apr 2022 12:08:40 +0200 Subject: [PATCH] Update socket interface documentaton --- man/tio.1.in | 10 ++++++++-- src/options.c | 2 +- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/man/tio.1.in b/man/tio.1.in index f038295..db2c5e9 100644 --- a/man/tio.1.in +++ b/man/tio.1.in @@ -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. .TP -.BR \-S ", " "\-\-socket unix:\fI\fR\fB +.BR \-S ", " "\-\-socket \fI\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 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. +Two socket types are supported using different prefixes in the socket field: + +unix: - Unix Domain Socket (file) + +inet:: - Internet Socket (network) (NOT YET SUPPORTED) + At present there is a hardcoded limit of 16 clients connected at one time. .TP diff --git a/src/options.c b/src/options.c index 0ab7147..8955515 100644 --- a/src/options.c +++ b/src/options.c @@ -74,7 +74,7 @@ void print_help(char *argv[]) printf(" -l, --log[=] Log to file\n"); printf(" -m, --map Map special characters\n"); printf(" -c, --color Colorize tio text\n"); - printf(" -S, --socket Listen on domain socket\n"); + printf(" -S, --socket Listen on socket\n"); printf(" -v, --version Display version\n"); printf(" -h, --help Display help\n"); printf("\n");