marcuskammer/maildir-backup
1
Fork 0
Code Releases Packages Activity Actions
maildir-backup is a common lisp program which executes mbsync to download emails and zip to package them and moves this zip to Documents folder so that this zip can be synced to my Nextcloud instance. https://www.metalisp.dev
62 commits 1 branch 3 tags 12 MiB
  • Common Lisp 98.1%
  • Just 1.9%
Find a file
Exact
Marcus Kammer 17c20d90a4 Enforce coding standards and add AGENTS.md 
Define custom condition types maildir-missing-error and
process-stream-error to replace bare error calls, then
handle them explicitly in handler-case. Switch log-message
from case to ecase for exhaustive dispatch. Add
configure-cli-environment to disable the interactive
debugger in main. Add missing docstrings throughout the
source. Replace with-open-file with uiop:with-output-file
in test helpers. Add AGENTS.md with build, test, and
architecture guidance for future sessions.
2026-05-31 21:20:12 +02:00
doc doc: Fix formatting 2026-03-24 10:01:01 +01:00
src Enforce coding standards and add AGENTS.md 2026-05-31 21:20:12 +02:00
tests Enforce coding standards and add AGENTS.md 2026-05-31 21:20:12 +02:00
AGENTS.md Enforce coding standards and add AGENTS.md 2026-05-31 21:20:12 +02:00
justfile Handle errors for build step; and fix exit status 2026-03-24 09:52:16 +01:00
keyvisual.png Update keyvisual 2026-03-08 08:44:35 +01:00
LICENSE Update meta data 2025-12-18 10:54:45 +01:00
maildir-backup.asd Fix version number 2026-03-12 20:10:08 +01:00
README.org Add keyvisual to README 2026-03-07 21:35:37 +01:00

README.org

maildir-backup

/marcuskammer/maildir-backup/media/branch/main/keyvisual.png

Introduction

This tool provides a simple and robust solution for backing up local Mail directories (Maildirs) on Linux systems. It is designed to be lightweight, reliable, and easy to inspect.

System Requirements

Please note that this software is specifically designed for Linux operating systems (tested and developed on Fedora). It requires the following system utilities:

make (for building the project) zip (for creating the archives) sbcl (Steel Bank Common Lisp, required for compilation)

Technologies Used

Common Lisp

Common Lisp is a high-performance, general-purpose programming language. Unlike interpreted script languages, this project is compiled into a native binary. This results in fast execution times and a standalone tool that does not require a Lisp installation to run once compiled.

Texinfo

Texinfo is the official documentation format of the GNU project. It allows us to generate high-quality manuals. You can read the documentation as an interactive "Info" page within your terminal or Emacs, or export it to other formats.

Installation and Compilation

The project uses Makefiles to automate the build and installation process.

Compiling the Program

To compile the source code into a native executable, run the following command in the root directory:

make

This will resolve all dependencies via Quicklisp, compile the application, and install the binary to ~/bin/maildir-backup.

Building the Documentation

To build the manual and register it with your system's info directory, navigate to the doc/ folder:

cd doc
make install

After installation, you can access the full manual, including the developer tutorial and glossary, by running:

info maildir-backup

Licensing

This project is committed to software freedom:

Source Code: Licensed under the GNU Affero General Public License (AGPL). Any improvements or modifications must be shared with the community. Documentation: Licensed under the GNU Free Documentation License (FDL).