Tool: spooldoc 1.5 · 388 KB · 13 Mar 2014 · md5 dee76020bacd · licence per site · 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.

spooldoc 1.5

388 KB · 13 Mar 2014 · md5 dee76020bacd · licence per site · shelf 4

windowslinuxmacosfreewarewrites nothing

Reports the free space left on the store volume.

spooldoc quota --path . --warn-under 15
8% free — a rebuild will not finish here

Note from the shelf row: run it the day before a maintenance window

Before you install

  • Runs on: Windows, Linux, macOS. the application must be 4.0.7 to 4.1.6.
  • Space: about 388 KB for the download, plus [WORKING SPACE] while it runs.
  • Rights: an ordinary user account; no elevation needed
  • Know first: [PREREQUISITE] — what has to be true before this 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.

certutil -hashfile spooldoc-1.5-win64.zip
md5sum spooldoc-1.5-linux-x64.tar.gz
md5 spooldoc-1.5-macos.tar.gz

Expected: dee76020bacd. 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.

Windows

Unpack the zip, then:

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

Linux

Unpack it and link it onto the path:

sudo tar -xzf spooldoc-1.5-linux-x64.tar.gz -C /opt
sudo ln -sf /opt/spooldoc/spooldoc /usr/local/bin/spooldoc
spooldoc --version

macOS

Unpack it and link it onto the path:

sudo tar -xzf spooldoc-1.5-macos.tar.gz -C /opt
sudo ln -sf /opt/spooldoc/spooldoc /usr/local/bin/spooldoc
spooldoc --version

Check it worked

Check the version first, then run the one command the tool exists for:

spooldoc --version
spooldoc quota --path . --warn-under 15
8% free — a rebuild will not finish here

Expected output is the line shown 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.

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

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).
  • Before any repair that writes to a store, take the export — backoff is the tool for it.