#Olmacs: [WIP] Olm library bindings for Emacs

Copyright (C) 2021-2025 Basil L. Contovounesios basil@contovou.net

See the end of the file for license conditions.

This very much WIP package provides Elisp bindings for the Olm cryptographic ratchet library, which was used to encrypt the Matrix communication protocol.

¡Olm was deprecated in 2024!

Olmacs will continue to be developed only as an experiment in using GNU Autotools as part of an Emacs package.

#Dependencies & Assumptions

¡Help with reducing or eliminating assumptions (aka porting) is most welcome!

• Emacs ≥ 25 configured --with-modules (the default since 27)
• GNU/Linux (tested on Debian Bullseye and Buster)
• C compiler that understands ISO C11 or later
• libolm (tested with versions 3.2.10, 3.2.8, 3.2.4, 3.2.1, 2.2.2)

#Usage

For an overview of the olmacs API, load the library and type M-x shortdoc-display-group RET olmacs RET on Emacs ≥ 28.

Olm objects are exposed as module user pointers whose contents are automatically deleted when garbage collected. For this reason, it is important not to keep unnecessary references to them in Lisp.

#Organization

• .dir-locals.el

  Project-wide editing conventions.

• AUTHORS.md

  List of Olmacs contributors.

• ChangeLog

  History of developer-visible changes. This is actually a dummy stub to appease Automake's gnu strictness level. The real ChangeLog is generated in the distribution tarball.

• ChangeLog-copying

  Trailing copying conditions appended to generated ChangeLog in distribution tarball.

• Makefile.am

  Top-level Automake definitions.

• NEWS.md

  History of user-visible changes.

• bootstrap

  Gnulib script that generates the configure script in Olmacs source checkouts.

• bootstrap.conf

  Project-specific configuration for Gnulib's bootstrap script.

• cfg.mk

  Project-specific configuration for Gnulib's maintainer-oriented GNUmakefile, which the bootstrap script imports.

• configure.ac

  Autoconf input for generating the project's configure script. Used primarily for building the libolmacs dynamic module.

• lisp/

  Elisp sources that form the olmacs ELPA package.

• m4/

  M4 sources for helper configuration macros.

• src/

  C sources that form the libolmacs dynamic module.

• test/

  ERT unit and regression tests.

#License

This file is part of Olmacs.

Olmacs is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.