@ai-ecoverse/slicc-man 0.0.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,9 +1,183 @@
-# @ai-ecoverse/slicc-man
+# slicc-man
 
-🐣 This package name has been claimed with [fledgling](https://github.com/dmno-dev/fledgling) for [https://github.com/ai-ecoverse/slicc-man](https://github.com/ai-ecoverse/slicc-man), and a real release will land here soon.
+`man`, `apropos` and `whatis` for SLICC, and `scman` for SLICC, macOS, Linux and Windows. They show the pages www.sliccy.com already serves: a page is the Markdown at `https://www.sliccy.com/man/<topic>.md`, the topics are the `/man/*` entries of [`sitemap.xml`](https://www.sliccy.com/sitemap.xml), and a page's one-line description is its first paragraph. The package renders the Markdown itself, so it needs no `man`, groff or mandoc on the host, and keeps what it fetched in an [offline cache](#offline-cache).
 
-This is a placeholder — there is nothing to install yet.
+In SLICC, the commands are `man`, `apropos`, `whatis` and `scman`, which is `man` under another name. On a host only `scman` is installed, so the host's own `man` is never shadowed.
 
----
+## Install
 
-Want to claim a name of your own? Run `npx fledgling add <name> --new --yes` — it reserves the name on npm and can set up token-less (OIDC trusted) publishing for when you are ready.
+In SLICC, the package declares its commands in `slicc.commands`, so installing it puts them in `/usr/bin`:
+
+```sh
+pnpm add -g @ai-ecoverse/slicc-man
+```
+
+On macOS and Linux (get.sliccy.ai, once live):
+
+```sh
+curl -fsSL https://get.sliccy.ai/man | sh
+```
+
+On Windows, in PowerShell (get.sliccy.ai, once live):
+
+```powershell
+irm https://get.sliccy.ai/man.ps1 | iex
+```
+
+The same installers are attached to every GitHub release, as `install.sh` and `install.ps1`:
+
+```sh
+curl -fsSL https://github.com/ai-ecoverse/slicc-man/releases/latest/download/install.sh | sh
+```
+
+They install the release's `scman` with a launcher in `~/.local/bin` (on Windows `%LOCALAPPDATA%\slicc-man\bin`, added to the user's `PATH`), and download Node 24 into the install when no Node 24 or later is on `PATH` (the `.tar.gz`, or the `.zip` on Windows), checked against nodejs.org's `SHASUMS256.txt`. Each release also carries the package tarball, `slicc-man-<version>.tgz`, and `SHA256SUMS`, which covers the tarball, `install.sh` and `install.ps1`: the installers check the tarball against it, unpack it into `${XDG_DATA_HOME:-~/.local/share}/slicc-man/<version>` (on Windows `%LOCALAPPDATA%\slicc-man\<version>`), write the launcher (`scman`, or `scman.ps1` and `scman.cmd` on Windows, which only start `node.exe` with the entry script and the arguments, the node call and its `exit` on one line of the `.cmd`), run it with `--version` (the version alone, or `scman <version>` from older releases), and print `scman <version> installed to <launcher>`. Options pass through (`curl -fsSL https://get.sliccy.ai/man | sh -s -- --help`): `--version <version>` installs that release instead of the latest, `--dir <dir>` puts the launcher in `<dir>`, and `--help` prints the usage; `install.sh` exits 2 for an unknown option or one without its value. `install.ps1` takes the same options, spelled `-Version`, `-Dir` and `-Help`. `SLICC_INSTALL_BASE_URL` replaces the directory the assets are downloaded from (by default `https://github.com/ai-ecoverse/slicc-man/releases/latest/download`, or `…/releases/download/v<version>` with `--version`), and `SLICC_NODE_DIST_BASE` nodejs.org, for mirrors and tests.
+
+On a machine with Node 24 or later, npm works too:
+
+```sh
+npm install -g @ai-ecoverse/slicc-man
+scman tree
+```
+
+or without installing, `npx -p @ai-ecoverse/slicc-man scman tree`. The package's `bin` has only `scman`.
+
+## man
+
+```
+man [options] [section] topic...
+```
+
+`man tree` shows the tree page. With several topics, `man` shows each in turn. A topic is looked up in lower case; `topic(1)` is the same as `1 topic`. When the first of two or more operands is a section name (a digit, or a digit and letters, as `3p`), it is the section. Every page is in section 1: a page asked for in any other section prints `No manual entry for <topic> in section <n>` to stderr, and with `-s`, the list as given. A topic that isn't a page name (empty, starting with `.`, or with anything but letters, digits, `.`, `_`, `+` and `-`) has no page, and nothing is fetched for it.
+
+| option | does |
+| --- | --- |
+| `-s <list>`, `--sections=<list>` | the sections to look in, separated by `:` or `,` |
+| `-k`, `--apropos` | `apropos` with the operands as keywords |
+| `-f`, `--whatis` | `whatis` with the operands as topics |
+| `-a`, `--all` | show every matching page; there is only ever one, so it changes nothing |
+| `-w`, `--where`, `--path`, `--location` | print the page's URL, `https://www.sliccy.com/man/<topic>.md`, instead of showing it |
+| `-P <pager>`, `--pager=<pager>` | the pager (see [Rendering](#rendering)) |
+| `-l`, `--local-file` | render the operands, local Markdown files (`-` for stdin), as pages; the page's name is the file's, without `.md`, and `stdin` for `-` |
+| `-i`, `--ignore-case` | the default |
+| `-I`, `--match-case` | look the topic up as typed, not in lower case |
+| `--nh`, `--no-hyphenation`, `--nj`, `--no-justification` | accepted; the renderer neither hyphenates nor justifies |
+| `-h`, `--help` | the usage to stdout, exit 0 |
+| `-V`, `--version` | the version alone (`1.2.0`) to stdout, exit 0; every host command takes it, and the installer runs the launcher with it |
+| `--upgrade` | see [`--upgrade`](#--upgrade) |
+
+Short options may be grouped (`-aw`). An option's value may be attached (`-s1`, `-Pcat`, `--pager=cat`) or the next argument; options may come after the operands, and `--` ends the options. Of `-k` and `-f`, the last one given counts, and so for `-i` and `-I`. With `-k` or `-f`, the operands are matched with `apropos`'s and `whatis`'s defaults, and only `-s` of the other options counts. `man` with no topic prints `What manual page do you want?` and `For example, try 'man man'.` to stderr and exits 2.
+
+## apropos and whatis
+
+```
+apropos [options] keyword...
+whatis [options] topic...
+```
+
+`apropos` searches the topics and descriptions, `whatis` the topics only. Each match is a line like man-db's: the topic and ` (1)` padded to 20 columns, ` - `, and the description, as in `tree (1)             - List contents of directories in a tree-like format.` Matches come in the sitemap's order, each once, and are case-insensitive.
+
+| option | `apropos` | `whatis` |
+| --- | --- | --- |
+| none | each keyword is a regular expression (JavaScript syntax) matched anywhere in a topic or description | each topic must be a page name exactly |
+| `-r`, `--regex` | the default | the topic is a regular expression matched anywhere in a page name |
+| `-w`, `--wildcard` | each keyword is a shell wildcard (`*`, `?`, `[…]`) matched against a whole topic or a whole word of a description | the topic is a wildcard matched against a whole page name |
+| `-e`, `--exact` | each keyword must be a whole topic or a whole word of a description | the default |
+| `-a`, `--and` | a page must match every keyword, not any one | not taken |
+| `-l`, `--long` | don't cut lines to the terminal width | the same |
+| `-s <list>`, `--sections=<list>` | only those sections; without 1, nothing matches | the same |
+| `-h`, `-V`, `--upgrade` | as for `man` | the same |
+
+On a terminal, a line wider than the width (see [Rendering](#rendering)) is cut and ends in `...`; through a pipe it is whole. A keyword with no match prints `<keyword>: nothing appropriate.` to stderr. With `-a`, that is printed for the keywords together, when no page matches them all. A regular expression that doesn't parse is a usage error, `<cmd>: <keyword>: invalid regular expression`. With no keyword, `apropos` prints `apropos what?` (`whatis`: `whatis what?`) to stderr and exits 2; `man -k` and `man -f` do the same.
+
+## Not supported
+
+These man-db options can't work here. They print `<cmd>: <option>: not supported` to stderr and exit 2, before anything is fetched:
+
+- **man:** `-t`/`--troff`, `-T`/`--troff-device`, `-H`/`--html`, `-X`/`--gxditview`, `-Z`/`--ditroff`, `-M`/`--manpath`, `-m`/`--systems`, `-L`/`--locale`, `-C`/`--config-file`, `-d`/`--debug`, `-D`/`--default`, `-W`/`--where-cat`, `-c`/`--catman`, `-u`/`--update`, `-e`/`--extension`, `-p`/`--preprocessor`, `-R`/`--recode`, `-E`/`--encoding`, `-K`/`--global-apropos`, `-r`/`--prompt`, `--regex`, `--wildcard`, `--names-only`, `--no-subpages`.
+- **apropos, whatis:** `-M`/`--manpath`, `-m`/`--systems`, `-L`/`--locale`, `-C`/`--config-file`, `-d`/`--debug`, `-v`/`--verbose`.
+
+Any other option, or an option without its value, prints `<cmd>: unknown option: <option>` (or `<cmd>: <option>: needs a value`) and the usage to stderr, and exits 2. So does `--upgrade` with anything else, as `<cmd>: --upgrade takes no other arguments`.
+
+## Exit codes
+
+| code | means |
+| --- | --- |
+| 0 | done |
+| 1 | `--upgrade` on a host, when the installer fails |
+| 2 | a usage error (`man` with no topic included), an option that isn't supported, or an operational error: the site unreachable with nothing cached, a pager that can't be run, a file `-l` can't read |
+| 16 | at least one topic has no page, or one keyword matched nothing |
+
+`man nope` prints `No manual entry for nope` to stderr and exits 16. With several topics, the others are still shown. `-w` exits 16 for a topic with no page too, printing the URLs of the others.
+
+## Rendering
+
+A page is turned from Markdown into a man page:
+
+- **Header:** `TOPIC(1)`, `SLICC Manual` centred, `TOPIC(1)`, then a blank line.
+- **NAME:** the first paragraph becomes `topic - description`, under `NAME`.
+- **Sections:** each `##` heading is a section heading in capitals at the left margin (`## See Also` becomes `SEE ALSO`), and `###` a subheading indented 3 columns. The body is indented 7 columns and wrapped at the width.
+- **Text:** `**strong**` and `` `code` `` are bold, `*emphasis*` and `_emphasis_` underlined. A link shows its text only, an image its alt text. Lists keep their marker with the item's lines hanging after it. Code blocks and tables are kept line for line, indented and never wrapped.
+- **Escapes:** a backslash before ASCII punctuation is dropped, as Markdown does, which undoes the site's `\[`, `\<` and `\--`; inside code it stays.
+- **Metadata:** the trailing table whose first row is `Metadata` is dropped.
+- **Control characters:** none from a page reaches the terminal; they are dropped, except tabs, which become spaces.
+
+The width is `MANWIDTH` when it is a positive number, else the terminal's width when stdout is a terminal, else 80.
+
+When stdout is a terminal, bold and underline are ANSI escapes (`ESC[1m`, `ESC[4m`), unless `NO_COLOR` is set and not empty, and the page goes through a pager: `-P`, else `MANPAGER`, else `PAGER`, else `less -R` when `less` is on `PATH`, else straight to stdout. The pager is a command line run by the shell (`sh -c`, `cmd /c` on Windows), with the page on its stdin; an empty one means straight to stdout. A pager that exits non-zero doesn't change the exit code; one that can't be run is exit 2. When stdout isn't a terminal, the page is plain text, with no escapes and no pager. `apropos` and `whatis` never use a pager.
+
+## Offline cache
+
+Pages, the sitemap and the topic index are cached:
+
+- on a host in `$XDG_CACHE_HOME/slicc-man`, by default `~/.cache/slicc-man`, and on Windows in `%LOCALAPPDATA%\slicc-man\cache`;
+- in SLICC in `~/.cache/slicc-man`, which lives in OPFS, so it survives reloads.
+
+Each site has its own directory in the cache, named by the base URL's host and port (`www.sliccy.com`, `127.0.0.1-8080`), with one JSON file per page, `sitemap.json` and `index.json`. A cached copy is fresh for the response's `Cache-Control` `max-age` (the site sends 4 hours), and 4 hours without one. A stale copy is revalidated with `If-Modified-Since` (the response's `Last-Modified`): `304` keeps it and makes it fresh again, `200` replaces it, and `404` drops it, so the topic has no page. When the site can't be reached, or answers 5xx, a cached copy is shown however old, after one line on stderr, `<cmd>: <url>: <reason>; showing the copy cached <date>`. With nothing cached, the command prints `<cmd>: <url>: <reason>` and exits 2. The cache is written atomically (a temporary file renamed into place), so two commands at once never see half a page; a cache that can't be written is skipped without a word.
+
+`apropos` and `whatis` read the index: every `/man/<topic>` entry of the sitemap, with its description, the first paragraph of its page, rendered as plain text on one line. The index is built from the cached sitemap and pages, fetching what is missing or stale (pages through the same cache, several at a time), and cached itself under the same rules. A page that fails to load is listed without a description.
+
+`SLICC_MAN_URL` overrides the base URL `https://www.sliccy.com`: pages are `$SLICC_MAN_URL/man/<topic>.md` and the sitemap `$SLICC_MAN_URL/sitemap.xml`, whose entries count by their path, whatever their host. The tests point it at a local server.
+
+## Fallback
+
+In SLICC only: when a topic has no page and is a command on `PATH`, `man` prints `No manual entry for <topic>; showing <topic> --help` to stderr, then the output of `<topic> --help` (stdout and stderr together, as plain text, through the pager when stdout is a terminal), and that topic counts as found, so `man` can exit 0. seven's own commands often have no page yet. The fallback doesn't apply to a section other than 1, `-w`, `-k`, `-f` or `-l`. On a host there is no fallback; the host has its own `man`.
+
+## `--upgrade`
+
+Every host command takes `--upgrade`. It runs the latest release's installer (`install.sh`, or `install.ps1` on Windows) with `--dir` set to the directory the command is installed in, so the new version replaces the old one in place, then prints `<cmd>: <old> → <new>` (for example `scman: 1.2.0 → 1.3.0`), or `<cmd>: already up to date (<version>)`, to stdout and exits 0. If the installer fails, its stderr is passed through and the command exits 1. A command installed with npm prints `npm install -g @ai-ecoverse/slicc-man@latest` to run instead, and exits 0. In SLICC, `--upgrade` prints `pnpm add -g @ai-ecoverse/slicc-man@latest` to run, and exits 0; it installs nothing itself. `--upgrade` takes no other arguments.
+
+The commands are `scman` on a host and `man`, `apropos`, `whatis` and `scman` in SLICC.
+
+The launcher the installer writes sets `SCMAN_INSTALL_DIR` to its own directory; that is how `scman` knows the installer put it there (it removes the variable before it starts a pager or the installer), and without it `scman` counts as installed with npm. The installer is downloaded from `https://github.com/ai-ecoverse/slicc-man/releases/latest/download/` and run as `sh install.sh --dir DIR`, or `powershell.exe -NoProfile -NonInteractive -ExecutionPolicy Bypass -File install.ps1 -Dir DIR` (else `pwsh.exe`); the line it prints, `scman <version> installed to <launcher>`, names the new version. A download that fails is the installer failing: `<cmd>: could not download <url>: <reason>`, exit 1. The download has 60 seconds; after that `--upgrade` prints `<cmd>: download timed out` to stderr and exits 1. `SLICC_INSTALL_BASE_URL`, when set, replaces that release URL for `--upgrade` and for the installers' own downloads.
+
+## Platforms
+
+| platform | commands | cache | pager | network |
+| --- | --- | --- | --- | --- |
+| SLICC | `man`, `apropos`, `whatis`, `scman` | `~/.cache/slicc-man`, in OPFS | `less -R` (seven's `less`) | the kernel's network transport |
+| macOS | `scman` | `$XDG_CACHE_HOME/slicc-man`, else `~/.cache/slicc-man` | `less -R` | direct HTTPS |
+| Linux | `scman` | `$XDG_CACHE_HOME/slicc-man`, else `~/.cache/slicc-man` | `less -R` when installed, else stdout | direct HTTPS |
+| Windows | `scman` | `%LOCALAPPDATA%\slicc-man\cache` | `less -R` when on `PATH` (Git for Windows has one), else stdout | direct HTTPS |
+
+`scman -k` and `scman -f` are its `apropos` and `whatis`. Other Unix systems are treated as Linux.
+
+## Development
+
+```sh
+npm install
+npm run lint
+npm test
+npm run test:unit
+```
+
+- `npm run lint`: Biome, the no-comment check and the other [slicc-shared-web](https://github.com/ai-ecoverse/slicc-shared-web) checks, then `shellcheck -s sh` and `dash -n` on `install.sh`.
+- `npm test`: the integration tests in `test/integration/`. `host.test.mjs` runs `scman` (in-process, so a terminal can be faked, and as `host/scman.mjs`) against a local HTTP server on an ephemeral port standing in for www.sliccy.com (`SLICC_MAN_URL`), serving copies of the site's `tree.md` and `man.md` (`pages.json`, with their expected renderings), with a temporary cache and fake tools, `less` among them, on a temporary `PATH`; only CI touches the real site. `install.test.mjs` runs `install.sh` on a tarball packed from the tree, with the Node on `PATH` and with a Node download from a fake nodejs.org, and `--upgrade` against a release served from a local server; `install.ps1` is checked statically, and run when `pwsh` is on `PATH`. `repo.test.mjs` checks the workflow, the release config, the package's shape, what `npm pack` ships and the repo rules.
+- `npm run test:unit`: the unit tests in the gitignored `test/unit/`, with Node's coverage in `coverage/unit/lcov.info`. The pre-commit hook wants 100% coverage of the changed lines.
+
+CI is `.github/workflows/ci.yml`, the only workflow, which runs [slicc-shared-web's pipeline](https://github.com/ai-ecoverse/slicc-shared-web#pipeline) at the devDependency's version, on Linux only: `npm run lint`, then `npm test`, then on a pull request the Claude and Codex reviews. The merge queue requires `ci / integration` and `ci / review`. On a push to `main`, semantic-release releases and publishes to npm through trusted publishing, with provenance from `ci.yml`, and attaches `slicc-man-<version>.tgz`, `SHA256SUMS`, `install.sh` and `install.ps1` to the GitHub release (`scripts/assets.mjs` renames the tarball and writes `SHA256SUMS`).
+
+The code is in `lib/` (options, the Markdown renderer, the cache and index, apropos and whatis, shared with SLICC) and `host/` (`scman.mjs`, the cache directory, the pager, `--upgrade`).
+
+## License
+
+Apache-2.0

package/host/cache.mjs

@@ -0,0 +1,43 @@
+import { mkdir, readFile, rename, rm, writeFile } from 'node:fs/promises';
+import { homedir } from 'node:os';
+import { isAbsolute, join } from 'node:path';
+import { variable } from './path.mjs';
+
+export function cacheRoot(platform, env) {
+  if (platform === 'win32') {
+    const local = variable(env, 'LOCALAPPDATA') || join(homedir(), 'AppData', 'Local');
+    return join(local, 'slicc-man', 'cache');
+  }
+  const xdg = env.XDG_CACHE_HOME;
+  if (xdg && isAbsolute(xdg)) return join(xdg, 'slicc-man');
+  return join(env.HOME || homedir(), '.cache', 'slicc-man');
+}
+
+let counter = 0;
+
+export function store(dir) {
+  const file = (id) => join(dir, `${id}.json`);
+  return {
+    async read(id) {
+      try {
+        return await readFile(file(id), 'utf8');
+      } catch {
+        return undefined;
+      }
+    },
+    async write(id, text) {
+      await mkdir(dir, { recursive: true });
+      const temp = join(dir, `.${id}.${process.pid}.${Date.now()}.${counter++}.tmp`);
+      try {
+        await writeFile(temp, text);
+        await rename(temp, file(id));
+      } catch (error) {
+        await rm(temp, { force: true });
+        throw error;
+      }
+    },
+    async remove(id) {
+      await rm(file(id), { force: true });
+    },
+  };
+}

package/host/io.mjs

@@ -0,0 +1,15 @@
+import { writeSync } from 'node:fs';
+
+export function say(fd, text) {
+  const data = Buffer.from(text);
+  let at = 0;
+  while (at < data.length) {
+    try {
+      at += writeSync(fd, data, at, data.length - at);
+    } catch (error) {
+      if (error.code === 'EAGAIN') continue;
+      if (error.code === 'EPIPE') return;
+      throw error;
+    }
+  }
+}

package/host/main.mjs

@@ -0,0 +1,54 @@
+import { readFileSync } from 'node:fs';
+import { join } from 'node:path';
+import { run } from '../lib/man.mjs';
+import { cacheRoot, store } from './cache.mjs';
+import { say } from './io.mjs';
+import { page } from './pager.mjs';
+import { lookup } from './path.mjs';
+import { upgrade, version } from './upgrade.mjs';
+
+const reasons = {
+  ENOENT: 'No such file or directory',
+  EACCES: 'Permission denied',
+  EISDIR: 'Is a directory',
+  ENOTDIR: 'Not a directory',
+};
+
+function read(file, fds) {
+  try {
+    return readFileSync(file === '-' ? fds[0] : file, 'utf8');
+  } catch (error) {
+    throw new Error(reasons[error.code] ?? error.message);
+  }
+}
+
+export async function main({
+  name,
+  argv,
+  env,
+  platform,
+  fds,
+  tty,
+  columns,
+  fetch = globalThis.fetch,
+  now,
+}) {
+  const child = { ...env };
+  delete child.SCMAN_INSTALL_DIR;
+  const root = cacheRoot(platform, env);
+  const io = {
+    tty,
+    columns,
+    fetch,
+    now,
+    version: version(),
+    out: (text) => say(fds[1], text),
+    err: (text) => say(fds[2], text),
+    store: (dir) => store(join(root, dir)),
+    which: (file) => lookup(file, platform, env) !== undefined,
+    page: (command, text) => page(command, text, { name, platform, env: child, fds }),
+    read: (file) => read(file, fds),
+    upgrade: () => upgrade({ name, env, platform, fds, fetch }),
+  };
+  return run({ kind: 'man', name, argv, env, io });
+}

package/host/pager.mjs

@@ -0,0 +1,38 @@
+import { spawn } from 'node:child_process';
+import { say } from './io.mjs';
+import { variable } from './path.mjs';
+
+export function shell(command, platform, env) {
+  if (platform === 'win32') {
+    return {
+      file: variable(env, 'COMSPEC') || 'cmd.exe',
+      args: ['/d', '/s', '/c', `"${command}"`],
+      options: { windowsVerbatimArguments: true },
+    };
+  }
+  return { file: '/bin/sh', args: ['-c', command], options: {} };
+}
+
+export function page(command, text, { name, platform, env, fds }) {
+  const run = shell(command, platform, env);
+  const ignore = () => {};
+  process.on('SIGINT', ignore);
+  return new Promise((done) => {
+    let failed = false;
+    const child = spawn(run.file, run.args, {
+      ...run.options,
+      env,
+      stdio: ['pipe', fds[1], fds[2]],
+    });
+    child.on('error', (error) => {
+      failed = true;
+      say(fds[2], `${name}: ${command}: ${error.message}\n`);
+    });
+    child.stdin.on('error', ignore);
+    child.stdin.end(text);
+    child.on('close', (code) => {
+      process.off('SIGINT', ignore);
+      done(failed || code === 126 || code === 127 ? 2 : 0);
+    });
+  });
+}

package/host/path.mjs

@@ -0,0 +1,33 @@
+import { accessSync, constants, statSync } from 'node:fs';
+import { join } from 'node:path';
+
+export function variable(env, name) {
+  const found = Object.keys(env).find((key) => key.toUpperCase() === name);
+  return found === undefined ? undefined : env[found];
+}
+
+export function lookup(file, platform, env) {
+  const windows = platform === 'win32';
+  const dirs = String((windows ? variable(env, 'PATH') : env.PATH) ?? '')
+    .split(windows ? ';' : ':')
+    .filter(Boolean);
+  const exts = windows
+    ? [
+        '',
+        ...String(variable(env, 'PATHEXT') || '.COM;.EXE;.BAT;.CMD')
+          .split(';')
+          .filter(Boolean),
+      ]
+    : [''];
+  for (const dir of dirs) {
+    for (const ext of exts) {
+      const path = join(dir, file + ext);
+      try {
+        if (!statSync(path).isFile()) continue;
+        if (!windows) accessSync(path, constants.X_OK);
+        return path;
+      } catch {}
+    }
+  }
+  return undefined;
+}

package/host/scman.mjs

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+import { isatty } from 'node:tty';
+import { main } from './main.mjs';
+
+const tty = isatty(1);
+process.exitCode = await main({
+  name: 'scman',
+  argv: process.argv.slice(2),
+  env: process.env,
+  platform: process.platform,
+  fds: [0, 1, 2],
+  tty,
+  columns: tty ? process.stdout.columns : undefined,
+});