From 8070e3852d647ab64142402e2bf09cc5f719b244 Mon Sep 17 00:00:00 2001 From: Leonard Kugis Date: Mon, 6 Oct 2025 15:41:15 +0200 Subject: Added README --- README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..548eea7 --- /dev/null +++ b/README.md @@ -0,0 +1,67 @@ +# SquashR + +Manage backups based on SquashFS, OverlayFS and LUKS + +## Installation + +1. Clone this repository +2. + +```bash +make +sudo make install +``` +3. Adjust default config in `/etc/squashr.conf` or copy it to a custom directory. + +## Usage + +``` +Usage: squashr [OPTIONS] + +Commands: + backup + minimize + new + mount + umount + delete + help Print this message or the help of the given subcommand(s) + +Options: + -c, --config + + --squashr-root + + --squashr-n-snapshots-min + + --squashr-n-snapshots-max + + --squashr-include + + --squashr-exclude + + --squashr-truncate + + --squashr-compression-enable + [possible values: true, false] + --squashr-compression-algo + + --squashr-compression-args + + --squashr-cryptsetup-enable + [possible values: true, false] + --squashr-cryptsetup-create-args + + --squashr-cryptsetup-open-args + + -h, --help + Print help + -V, --version + Print version +``` + +## References + +- [SquashFS](https://docs.kernel.org/filesystems/squashfs.html) +- [OverlayFS](https://docs.kernel.org/filesystems/overlayfs.html) +- [dm-crypt](https://docs.kernel.org/admin-guide/device-mapper/dm-crypt.html) -- cgit v1.2.3