Installation

There are two main ways to install this program, which are as follows.

Binary

This is the simplest, but can cause problems with modern versions of some operating systems, such as recent versions of macOS.

To install by this method, download and run the appropriate file from below:

These packages will take care of everything for you, though the Windows installer does not include offline help.

Source

If you want the most control over this program, it is recommended that you install via source.

To do so, you must have a version of the Rust toolchain that supports the 2024 edition of Rust and libclang.

Libclang is preinstalled on FreeBSD and included with the macOS developer tools.

Once you have those tools, you can then run either:

cargo build --release

Or, if your OS uses Gnu Make:

make

Cargo is the best to use, as it will work on any operating system that has access to the Rust toolchain.

Once it is done building, you can move files into their appropriate places or use:

sudo make install

However, installing via Make is only guaranteed to work on macOS and Linux.

If you are intending to run this on an operating system not utilizing FHS or don't want to follow those conventions, you will need to set an environment variable.

Once you have set the variables, you can then run:

sudo -E make -e install

After installing, everything should be good to go.