From d234b36005c8d30b144dce79c94a069b5f076191 Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Thu, 11 Jul 2024 16:43:32 -0400 Subject: whichbas: update doc for multiple files. --- whichbas.1 | 29 +++++++++++++++++++++-------- whichbas.rst | 27 ++++++++++++++++++++------- 2 files changed, 41 insertions(+), 15 deletions(-) diff --git a/whichbas.1 b/whichbas.1 index ade192e..8c452ff 100644 --- a/whichbas.1 +++ b/whichbas.1 @@ -27,21 +27,29 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "WHICHBAS" 1 "2024-07-09" "0.2.1" "Urchlay's Atari 8-bit Tools" +.TH "WHICHBAS" 1 "2024-07-11" "0.2.1" "Urchlay's Atari 8-bit Tools" .SH NAME whichbas \- Determine BASIC variant of a tokenized Atari 8-bit program .SH SYNOPSIS .sp -whichbas [\-v] \fIinput\-file\fP +whichbas [\-v] \fIinput\-file\fP [\fIinput\-file\fP ...] .SH DESCRIPTION .sp -\fBwhichbas\fP reads a tokenized Atari 8\-bit BASIC, Turbo BASIC, -BASIC XL, BASIC XE, BASIC/A+, or Atari Microsoft BASIC program and attempts to -discover which BASIC is required to run it. +\fBwhichbas\fP reads tokenized Atari 8\-bit BASIC, Turbo BASIC, +BASIC XL, BASIC XE, BASIC/A+, or Atari Microsoft BASIC programs and attempts to +discover which BASIC is required to run each one. .sp -\fIinput\-file\fP must be an actual file. \fBwhichbas\fP can\(aqt read from +\fIinput\-file\fPs must be actual files. \fBwhichbas\fP can\(aqt read from standard input, because it seeks in the input file. +.sp +With multiple \fIinput\-file\fPs, the output is one line per file, +with the filename, a tab, and the detected BASIC. With only one +\fIinput\-file\fP, the filename and tab are not printed. .SH OPTIONS +.sp +\fINote\fP: none of the options \fB\-s\fP \fB\-k\fP \fB\-v\fP are allowed +when checking multiple files; they only work if there\(aqs just one +\fIinput\-file\fP argument. .SS Detection Options .INDENT 0.0 .TP @@ -127,8 +135,13 @@ ELF binaries, etc) as a convenience, but I wouldn\(aqt rely on \fBwhichbas\fP\(aqs non\-BASIC file type detection if I were you. If you need the \fBfile\fP(1) command, use it. .sp -\fBwhichbas\fP knows nothing about other BASICs such as Frost BASIC, -or Altirra BASIC. +\fBwhichbas\fP knows nothing about other BASICs such as Frost BASIC or +Altirra BASIC. +.sp +When using multiple \fIinput\-file\fP arguments, a separate instance of +\fBwhichbas\fP is spawned for each file. This isn\(aqt the most efficient +approach, but it shouldn\(aqt cause problems on reasonably modern +systems. .SH BUGS .SS Misdetection .sp diff --git a/whichbas.rst b/whichbas.rst index 6b9a63f..8a7e15e 100644 --- a/whichbas.rst +++ b/whichbas.rst @@ -10,20 +10,28 @@ Determine BASIC variant of a tokenized Atari 8-bit program SYNOPSIS ======== -whichbas [-v] *input-file* +whichbas [-v] *input-file* [*input-file* ...] DESCRIPTION =========== -**whichbas** reads a tokenized Atari 8-bit BASIC, Turbo BASIC, -BASIC XL, BASIC XE, BASIC/A+, or Atari Microsoft BASIC program and attempts to -discover which BASIC is required to run it. +**whichbas** reads tokenized Atari 8-bit BASIC, Turbo BASIC, +BASIC XL, BASIC XE, BASIC/A+, or Atari Microsoft BASIC programs and attempts to +discover which BASIC is required to run each one. -*input-file* must be an actual file. **whichbas** can't read from +*input-file*\s must be actual files. **whichbas** can't read from standard input, because it seeks in the input file. +With multiple *input-file*\s, the output is one line per file, +with the filename, a tab, and the detected BASIC. With only one +*input-file*, the filename and tab are not printed. + OPTIONS ======= +*Note*\: none of the options **-s** **-k** **-v** are allowed +when checking multiple files; they only work if there's just one +*input-file* argument. + Detection Options ----------------- @@ -92,8 +100,13 @@ ELF binaries, etc) as a convenience, but I wouldn't rely on **whichbas**\'s non-BASIC file type detection if I were you. If you need the **file**\(1) command, use it. -**whichbas** knows nothing about other BASICs such as Frost BASIC, -or Altirra BASIC. +**whichbas** knows nothing about other BASICs such as Frost BASIC or +Altirra BASIC. + +When using multiple *input-file* arguments, a separate instance of +**whichbas** is spawned for each file. This isn't the most efficient +approach, but it shouldn't cause problems on reasonably modern +systems. BUGS ==== -- cgit v1.2.3