Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.58 KB

INSTALL.md

File metadata and controls

37 lines (24 loc) · 1.58 KB

Installation

Dependencies

Before building or running this tool, you'll need the following dependencies installed:

At the moment I believe this tool is linux-only; issue reports or pull requests to improve portability are gratefully accepted.

To build this tool, you'll also need:

Building

make release is the main compile target.

If you want a bash-completion script, add the bash-completion target.

Run make help for a list of other targets.

Build flags

Flag Type Default Meaning
LONGEST_VALID_PASSPHRASE integer 1024 length after which passphrases are truncated
WARN_ON_MEMORY_LOCK_ERRORS boolean 1 if 0, this will disable warnings when memory cannot be locked
SETCAP_BINARY boolean 1 if 0, then make install will not attempt to add CAP_IPC_LOCK to the installed binary
DEBUG N/A unset if set to any value, this will enable debug mode (enabling core dumps, assertions and symbols)

Standard makefile variables (CC, CFLAGS, LDFLAGS, DESTDIR, PREFIX) are respected.