Skip to content

Command Line help page; $datum, $isfirstzone, $islastzone - #255

Merged
ddehilster merged 1 commit into
VisualText:mainfrom
ddehilster:docs/command-line
Oct 28, 2026
Merged

ddehilster merged 1 commit into
VisualText:mainfrom
ddehilster:docs/command-line

Conversation

@ddehilster

Copy link
Copy Markdown
Member

No page listed nlp.exe's switches. Each was mentioned only where it came up:

  • -DEV and -SILENT on their variable pages;
  • -STDIN on $isdirrun;
  • -DICTSOURCE on the analyzer sequence page;
  • -DEBUG only in an announcement;
  • -TIMELIMIT and -ZONES on Large Files.

-DATUM, the compile switches, -OUT, --version and the exit codes were nowhere.

New: Command Line (vscode/commandline.md)

  • Every switch, grouped as in the new nlp --help (nlp --help grouped, with exit codes; a missing input exits 1; -OUT makes its folder (4.2.51) nlp-engine#811): running, debugging, limits and zone mode, compiled analyzers.
  • What -WORK and -OUT really are: the engine folder, and the folder for the run's logs and trees in place of <input>_log.
  • NLP_REC_LIMIT, the exit status, and examples (debug one input, a folder run, a -STDIN stream, -DATUM with -TIMELIMIT, -ZONES with -DEV and -OUT).
  • Linked from the Help view (after Large Files), the home page and Large Files.

New variable pages

$datum, $isfirstzone and $islastzone had no page, no Special Variables row and no index entry. All three now have each. I checked the $datum behavior against the engine: 0 without -DATUM, the value with it.

check-help-docs.ps1: 0 broken links, 0 Help tree errors. The one orphan, New_in_Current_Version, was already there.

Merge after engine 4.2.51 is released. The page describes 4.2.51's -OUT and exit codes.

🤖 Generated with Claude Code

No page listed nlp.exe's switches: -DEV and -SILENT were on variable
pages, -STDIN on $isdirrun, -DICTSOURCE on the analyzer sequence page,
-DEBUG only in an announcement, -TIMELIMIT and -ZONES on Large Files,
and -DATUM, the compile switches, -OUT, --version and the exit codes
nowhere.

- vscode/commandline.md: every switch, grouped as in nlp --help (engine
  4.2.51), with what -WORK and -OUT really are, NLP_REC_LIMIT, the exit
  status, and examples. In the Help view after Large Files, and on the
  home page.
- $datum, $isfirstzone, $islastzone: pages, Special Variables rows
  and index entries; they had none.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@ddehilster
ddehilster merged commit 6c0af1c into VisualText:main Oct 28, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant