Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.71 KB

INSTALL.md

File metadata and controls

37 lines (23 loc) · 1.71 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.

Building

make release is the main compile target.

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

If you want mkinitcpio hooks add the initcpio target.

If you want ssh-askpass add the ssh-askpass target.

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.

You can set the maximum passphrase length (defaults to 1024; everything after this will be ignored) by appending LONGEST_VALID_PASSPHRASE=<some integer> after the list of targets.

You disable memory locking warnings (default to on) by setting WARN_ON_MEMORY_LOCK_ERRORS=0 (see the memory locking section below).