Tool: idxsmith 2.4.1 · 412 KB · 11 Nov 2014 · md5 3f1a9c07b2e4 · signed ML · back to its row on the shelf

← Shelf

Placeholder page. These are the standard install steps, kept in the shape this shelf uses so nobody has to invent them twice. Anything in [brackets] is a value nobody has written down yet, and the tool-specific warnings have not been collected. Replace the brackets before this page is handed to anyone outside the desk.

idxsmith 2.4.1

412 KB · 11 Nov 2014 · md5 3f1a9c07b2e4 · signed ML · shelf 4

windowslinuxmacosfreewarewrites .idx only

Rebuilds index files a crash left half-written. The index is derived data; the records behind it are not touched, which is why this one is safe to run at three in the morning.

idxsmith rebuild --all --verify
12 files rebuilt, 0 errors

Note from the shelf row: Run this before jrnlrpl, never after it.

Before you install

  • Runs on: Windows, Linux, macOS. the application must be 4.0.7 to 4.1.6.
  • Space: about 412 KB for the download, plus [WORKING SPACE] while it runs. The store is not copied; the rebuild happens in place.
  • Rights: an ordinary user account; no elevation and no sudo for the tool itself
  • Know first: [PREREQUISITE] — whoever writes this page up properly should say here what has to be true before the tool will run at all.

Download and verify

Take the build for your platform from the [SHARE] and check it against the digest on the shelf row before you unpack anything. The digest is also printed below.

certutil -hashfile idxsmith-2.4.1-win64.zip MD5
md5sum idxsmith-2.4.1-linux-x64.tar.gz
md5 idxsmith-2.4.1-macos.tar.gz

Expected: 3f1a9c07b2e4. The shelf row carries the same digest.

Install

Copy it into place and put it on the path. Nothing here installs a service or a scheduled task, so there is no installer to run and nothing to reboot.

Windows

Unpack the zip, then:

xcopy idxsmith-2.4.1-win64 C:\Tools\idxsmith /E /I
setx PATH "%PATH%;C:\Tools\idxsmith"
idxsmith --version

Linux

Unpack it and link it onto the path:

# unpack into place
sudo tar -xzf idxsmith-2.4.1-linux-x64.tar.gz -C /opt
sudo ln -sf /opt/idxsmith/idxsmith /usr/local/bin/idxsmith
idxsmith --version

macOS

Unpack it and link it onto the path:

# unpack into place
sudo tar -xzf idxsmith-2.4.1-macos.tar.gz -C /opt
sudo ln -sf /opt/idxsmith/idxsmith /usr/local/bin/idxsmith
idxsmith --version

Check it worked

Check the version first, then run the one command the tool exists for. If the output matches, it is working:

idxsmith --version
idxsmith rebuild --all --verify
12 files rebuilt, 0 errors

Expected output is the line shown in the block above; anything else means [TO DO: write the failure list].

Removing it

Delete the folder and drop the path entry. The tool keeps no state of its own, so there is nothing to unregister.

rmdir /s /q C:\Tools\idxsmith
sudo rm -rf /opt/idxsmith /usr/local/bin/idxsmith
sudo rm -rf /opt/idxsmith /usr/local/bin/idxsmith

If it goes wrong

  • [KNOWN FAILURE 1] — the usual fixes for this tool have not been written down yet. Add them the second time somebody hits one.
  • Wrong error number or a fault you cannot name: run the tool's own diagnostic first (shelf row), then the removal steps.
  • Before any repair that writes to a store, take the export — backoff is the tool for it.
  • If a tool on this shelf is being asked to fix something it was never written for, stop and ask the desk rather than reaching for a force flag.