From 804b215c8895d833c746a05707000d1b96cad5b5 Mon Sep 17 00:00:00 2001 From: Jakub Wilk Date: Sat, 7 May 2016 17:41:36 +0200 Subject: [PATCH 1/4] Fixed hyphen vs minus vs em-dash confusion in man page - prints as hyphen; \- prints as minus sign; \em prints as em-dash. --- man/tio.1 | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/man/tio.1 b/man/tio.1 index 933ab91..66bb483 100644 --- a/man/tio.1 +++ b/man/tio.1 @@ -17,43 +17,43 @@ commandline interface to easily connect to TTY devices for basic input/output. .SH "OPTIONS" .TP -.B \-b, \--baudrate +.B \-b, \-\-baudrate Set baud rate [bps] (default: 115200). .TP -.B \-d, \--databits 5|6|7|8 +.B \-d, \-\-databits 5|6|7|8 Set data bits (default: 8). .TP -.B \-f, \--flow hard|soft|none +.B \-f, \-\-flow hard|soft|none Set flow control (default: none). .TP -.B \-s, \--stopbits 1|2 +.B \-s, \-\-stopbits 1|2 Set stop bits (default: 1). .TP -.B \-p, \--parity odd|even|none +.B \-p, \-\-parity odd|even|none Set parity (default: none). .TP -.B \-o, \--output-delay +.B \-o, \-\-output\-delay -Set output delay [ms] - delay inserted between each transmitted character (default: 0). +Set output delay [ms] \(em delay inserted between each transmitted character (default: 0). .TP -.B \-n, \--no-autoconnect +.B \-n, \-\-no\-autoconnect Disable automatic connect. .TP -.B \-l, \--log +.B \-l, \-\-log Log to file. .TP -.B \-v, \--version +.B \-v, \-\-version Display program version. .TP -.B \-h, \--help +.B \-h, \-\-help Display help. @@ -69,15 +69,15 @@ tio /dev/ttyUSB0 .TP Which corresponds to: -tio -b 115200 -d 8 -f none -s 1 -p none /dev/ttyUSB0 +tio \-b 115200 \-d 8 \-f none \-s 1 \-p none /dev/ttyUSB0 .TP It is recommended to connect serial tty devices by id. For example: -tio /dev/serial/by-id/usb-FTDI_TTL232R-3V3_FTGQVXBL-if00-port0 +tio /dev/serial/by\-id/usb\-FTDI_TTL232R-3V3_FTGQVXBL\-if00\-port0 .PP Using serial devices by id ensures that tio automatically reconnects to the correct serial device if the device is disconnected and then reconnected. .SH "AUTHOR" .PP -Written by Martin Lund . +Written by Martin Lund . From fb8e96b5be442e6e7921f6e80c96004e7a64b5f3 Mon Sep 17 00:00:00 2001 From: Jakub Wilk Date: Sat, 7 May 2016 17:54:21 +0200 Subject: [PATCH 2/4] Improve man page formatting Use regular font for metacharacters such as "[]", "," or "|"; use italic font for metavariables. --- man/tio.1 | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/man/tio.1 b/man/tio.1 index 66bb483..b2ff85f 100644 --- a/man/tio.1 +++ b/man/tio.1 @@ -6,7 +6,7 @@ tio \- The simple TTY terminal I/O application .SH "SYNOPSIS" .PP .B tio -[] +.RI "[" "] " "" .SH "DESCRIPTION" .PP @@ -17,43 +17,43 @@ commandline interface to easily connect to TTY devices for basic input/output. .SH "OPTIONS" .TP -.B \-b, \-\-baudrate +.BR \-b ", " "\-\-baudrate " \fI Set baud rate [bps] (default: 115200). .TP -.B \-d, \-\-databits 5|6|7|8 +.BR \-d ", " "\-\-databits 5" | 6 | 7 | 8 Set data bits (default: 8). .TP -.B \-f, \-\-flow hard|soft|none +.BR \-f ", " "\-\-flow hard" | soft | none Set flow control (default: none). .TP -.B \-s, \-\-stopbits 1|2 +.BR \-s ", " "\-\-stopbits 1" | 2 Set stop bits (default: 1). .TP -.B \-p, \-\-parity odd|even|none +.BR \-p ", " "\-\-parity odd" | even | none Set parity (default: none). .TP -.B \-o, \-\-output\-delay +.BR \-o ", " "\-\-output\-delay " \fI Set output delay [ms] \(em delay inserted between each transmitted character (default: 0). .TP -.B \-n, \-\-no\-autoconnect +.BR \-n ", " \-\-no\-autoconnect Disable automatic connect. .TP -.B \-l, \-\-log +.BR \-l ", " "\-\-log " \fI Log to file. .TP -.B \-v, \-\-version +.BR \-v ", " \-\-version Display program version. .TP -.B \-h, \-\-help +.BR \-h ", " \-\-help Display help. From 8cd11402e55150271b40fe9af4c0035500c403b2 Mon Sep 17 00:00:00 2001 From: Jakub Wilk Date: Sat, 7 May 2016 17:55:43 +0200 Subject: [PATCH 3/4] Bumped date in man page --- man/tio.1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/tio.1 b/man/tio.1 index b2ff85f..54751ce 100644 --- a/man/tio.1 +++ b/man/tio.1 @@ -1,4 +1,4 @@ -.TH "tio" "1" "30 September 2014" +.TH "tio" "1" "7 May 2016" .SH "NAME" tio \- The simple TTY terminal I/O application From cf15601e828ee2146b21fa8e05ce5ef621589507 Mon Sep 17 00:00:00 2001 From: Jakub Wilk Date: Sat, 7 May 2016 18:14:33 +0200 Subject: [PATCH 4/4] Used HTTPS for tio.github.io --- README | 2 +- configure.ac | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README b/README index 56be5c7..3fa7dbc 100644 --- a/README +++ b/README @@ -50,7 +50,7 @@ 3. Download - Find the latest release tarball at http://tio.github.io + Find the latest release tarball at https://tio.github.io The latest source is available on github: https://github.com/tio/tio diff --git a/configure.ac b/configure.ac index d78a903..ae286b5 100644 --- a/configure.ac +++ b/configure.ac @@ -1,5 +1,5 @@ AC_PREREQ([2.68]) -AC_INIT([tio], [1.7], [], [tio], [http://tio.github.io]) +AC_INIT([tio], [1.7], [], [tio], [https://tio.github.io]) AC_CONFIG_HEADERS([src/include/config.h]) AM_INIT_AUTOMAKE([1.11 foreign dist-xz no-dist-gzip -Wall -Werror]) AM_SILENT_RULES([yes])