Mention config file in --help

This commit is contained in:
Martin Lund 2022-06-02 00:26:52 +02:00
parent fb1fc9b7a1
commit 89574b2469
3 changed files with 10 additions and 5 deletions

View file

@ -25,7 +25,7 @@ embedded developers and hackers.
The command-line interface is straightforward as reflected in the output from The command-line interface is straightforward as reflected in the output from
'tio --help': 'tio --help':
``` ```
Usage: tio [<options>] <tty-device> Usage: tio [<options>] <tty-device|config>
Options: Options:
-b, --baudrate <bps> Baud rate (default: 115200) -b, --baudrate <bps> Baud rate (default: 115200)
@ -45,9 +45,11 @@ The command-line interface is straightforward as reflected in the output from
-v, --version Display version -v, --version Display version
-h, --help Display help -h, --help Display help
See the man page for more details. Options may be set via configuration file.
In session, press ctrl-t q to quit. In session, press ctrl-t q to quit.
See the man page for more details.
``` ```
The only option which requires a bit of elaboration is perhaps the The only option which requires a bit of elaboration is perhaps the

View file

@ -6,7 +6,7 @@ tio \- a simple serial terminal I/O tool
.SH "SYNOPSIS" .SH "SYNOPSIS"
.PP .PP
.B tio .B tio
.RI "[" <options> "] " "<tty-device/config>" .RI "[" <options> "] " "<tty-device|config>"
.SH "DESCRIPTION" .SH "DESCRIPTION"
.PP .PP

View file

@ -58,7 +58,7 @@ struct option_t option =
void print_help(char *argv[]) void print_help(char *argv[])
{ {
printf("Usage: %s [<options>] <tty-device/config>\n", argv[0]); printf("Usage: %s [<options>] <tty-device|config>\n", argv[0]);
printf("\n"); printf("\n");
printf("Options:\n"); printf("Options:\n");
printf(" -b, --baudrate <bps> Baud rate (default: 115200)\n"); printf(" -b, --baudrate <bps> Baud rate (default: 115200)\n");
@ -78,10 +78,13 @@ void print_help(char *argv[])
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");
printf("See the man page for more details.\n"); printf("Options may be set via configuration file.\n");
printf("\n"); printf("\n");
printf("In session, press ctrl-t q to quit.\n"); printf("In session, press ctrl-t q to quit.\n");
printf("\n"); printf("\n");
printf("See the man page for more details.\n");
printf("\n");
} }
const char* timestamp_token(enum timestamp_t timestamp) const char* timestamp_token(enum timestamp_t timestamp)