From 2b6aecb42be08b9f2d9b2d900a60fc7b899f214f Mon Sep 17 00:00:00 2001 From: Kaz Kylheku Date: Tue, 30 Aug 2016 22:20:28 -0700 Subject: doc: revise synopsis; document listener invocation. * txr.1: Revise the synopsis so that it doesn't insinuate that the query-file or data-file arguments are mandatory. A formatting issue with the brackets around options is fixed. Under ARGUMENTS AND OPTIONS document that if no arguments are present, the interactive listener is launched. Under INTERACTIVE LISTENER, mention that not only does the -i option run the listener, but so does txr invocation with no arguments. --- txr.1 | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/txr.1 b/txr.1 index 4168efda..02d7b83f 100644 --- a/txr.1 +++ b/txr.1 @@ -345,7 +345,7 @@ .SH* SYNOPSIS .cblk -.meti txr >> [ options ] < query-file < data-files .. +.meti txr [ < options ] [ < script-file [ < data-files ... ]] .cble .SH* DESCRIPTION @@ -386,6 +386,13 @@ arbitrary-precision (bignum integers). .SH* ARGUMENTS AND OPTIONS +If \*(TX is given no arguments, it will enter into an interactive +mode. See the INTERACTIVE LISTENER section for a +description of this mode. When \*(TX enters interactive mode this +way, it prints a one-line banner is printed announcing the program +name and version, and one line of help text instructing the user +how to exit. + Options which don't take an argument may be combined together. The .code -v @@ -42182,7 +42189,9 @@ the trailing slash. On some target platforms, \*(TX provides an interactive listener, which is invoked using the .code -i -command line option. The interactive listener provides features like visual +command line option, or by executing +.code txr +with no arguments. The interactive listener provides features like visual editing of the command line, tab completion on \*(TL symbols, and history recall. -- cgit v1.2.3