diff options
| author | Kaz Kylheku <kaz@kylheku.com> | 2016-08-30 22:20:28 -0700 |
|---|---|---|
| committer | Kaz Kylheku <kaz@kylheku.com> | 2016-08-30 22:20:28 -0700 |
| commit | 80ffc964333c364cea1d0ab9df0b03287b551dc8 (patch) | |
| tree | 6682de365ab5768ed2e594506278ab768e08ff9f /txr.1 | |
| parent | 9f13f1ad244ac023f0cc644e3fefb660020ca8c0 (diff) | |
| download | txr-80ffc964333c364cea1d0ab9df0b03287b551dc8.tar.gz txr-80ffc964333c364cea1d0ab9df0b03287b551dc8.tar.bz2 txr-80ffc964333c364cea1d0ab9df0b03287b551dc8.zip | |
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.
Diffstat (limited to 'txr.1')
| -rw-r--r-- | txr.1 | 13 |
1 files changed, 11 insertions, 2 deletions
@@ -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. |