Tool: volcheck 1.1 · 32 KB · 09 Sep 2014 · md5 f6b2781ac05e · 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.

volcheck 1.1

32 KB · 09 Sep 2014 · md5 f6b2781ac05e · signed ML · shelf 4

windowslinuxmacosfreewarewrites nothing

Warns when the store volume drops under fifteen per cent free. A rebuild that runs out of disk is a rebuild you get to do twice, and the second one is on a smaller store.

volcheck --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 32 KB for the download, plus [WORKING SPACE] while it runs. No space needed.
  • 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 volcheck-1.1-win64.zip MD5
md5sum volcheck-1.1-linux-x64.tar.gz
md5 volcheck-1.1-macos.tar.gz

Expected: f6b2781ac05e. 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 volcheck-1.1-win64 C:\Tools\volcheck /E /I
setx PATH "%PATH%;C:\Tools\volcheck"
volcheck --version

Linux

Unpack it and link it onto the path:

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

macOS

Unpack it and link it onto the path:

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

Check it worked

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

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

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\volcheck
sudo rm -rf /opt/volcheck /usr/local/bin/volcheck
sudo rm -rf /opt/volcheck /usr/local/bin/volcheck

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.