dar-backup 0.6.8__py3-none-any.whl → 0.6.10__py3-none-any.whl

dar_backup/__about__.py

@@ -1 +1 @@
-__version__ = "0.6.8"
+__version__ = "0.6.10"

dar_backup/clean_log.py

@@ -0,0 +1,151 @@
+#!/usr/bin/env python3
+"""
+clean-log.py source code is here: https://github.com/per2jensen/dar-backup/tree/main/v2/src/dar_backup/clean-log.py
+This script is part of dar-backup, a backup solution for Linux using dar and systemd.
+
+Licensed under GNU GENERAL PUBLIC LICENSE v3, see the supplied file "LICENSE" for details.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW, 
+not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See section 15 and section 16 in the supplied "LICENSE" file
+
+This script can be used to remove (much of) the logged output from `dar`.
+When `dar` verbose options are enabled, quite a lot of information is emitted.
+"""
+
+
+import argparse
+import re
+import os
+import sys 
+
+from . import __about__ as about
+from dar_backup.config_settings import ConfigSettings
+
+LICENSE = '''Licensed under GNU GENERAL PUBLIC LICENSE v3, see the supplied file "LICENSE" for details.
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW, not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+See section 15 and section 16 in the supplied "LICENSE" file.'''
+
+def clean_log_file(log_file_path, dry_run=False):
+    """Removes specific log lines from the given file using a memory-efficient streaming approach."""
+
+
+    if not os.path.isfile(log_file_path):
+        print(f"File '{log_file_path}' not found!")
+        sys.exit(1)
+
+    if not os.access(log_file_path, os.R_OK):
+        print(f"No read permission for '{log_file_path}'")
+        sys.exit(1)
+
+    if not os.access(log_file_path, os.W_OK):
+        print(f"Error: No write permission for '{log_file_path}'")
+        sys.exit(1)
+
+
+    if dry_run:
+        print(f"Performing a dry run on: {log_file_path}")
+
+    temp_file_path = log_file_path + ".tmp"
+    
+    patterns = [
+        r"INFO\s*-\s*<File",
+        r"INFO\s*-\s*<Attributes",
+        r"INFO\s*-\s*</Directory",
+        r"INFO\s*-\s*<Directory",
+        r"INFO\s*-\s*</File",
+        r"INFO\s*-\s*Inspecting\s*directory",
+        r"INFO\s*-\s*Finished\s*Inspecting"
+    ]
+
+    try:
+        with open(log_file_path, "r", errors="ignore") as infile, open(temp_file_path, "w") as outfile:
+
+            for line in infile:
+                original_line = line  # Store the original line before modifying it
+                matched = False  # Track if a pattern is matched
+
+                for pattern in patterns:
+                    if re.search(pattern, line):  # Check if the pattern matches
+                        if dry_run:
+                            print(f"Would remove: {original_line.strip()}")  # Print full line for dry-run
+                        matched = True  # Mark that a pattern matched
+                        line = re.sub(pattern, "", line).strip()  # Remove only matched part
+
+                if not dry_run and line:  # In normal mode, only write non-empty lines
+                    outfile.write(line.rstrip() + "\n")
+
+                if dry_run and matched:
+                    continue  # In dry-run mode, skip writing (since we’re just showing)
+
+        
+        # Ensure the temp file exists before renaming
+        if not os.path.exists(temp_file_path):
+            open(temp_file_path, "w").close()  # Create an empty file if nothing was written
+
+        os.replace(temp_file_path, log_file_path)
+        print(f"Successfully cleaned log file: {log_file_path}")
+
+    except Exception as e:
+        print(f"Error processing file: {e}")
+        sys.exit(1)
+
+
+    
+def main():
+    parser = argparse.ArgumentParser(
+        description="Clean dar-backup log file for `dar` output"
+    )
+    parser.add_argument(
+        "-f", "--file",
+        nargs="+",
+        type=str, help="Path(s) to the log file(s) that needs cleaning. Default is the log file specified in the configuration file."
+    )
+
+    parser.add_argument(
+        '-c', '--config-file',
+        type=str, help="Path to 'dar-backup.conf'",
+        default='~/.config/dar-backup/dar-backup.conf')
+
+    parser.add_argument(
+        "--dry-run",
+        action="store_true",
+        help="Show which lines would be removed without modifying the file."
+    )
+
+
+    parser.add_argument(
+        "-v", "--version",
+        action="version",
+        version=f"%(prog)s version {about.__version__}, {LICENSE}"
+    )
+
+    args = parser.parse_args()
+
+    config_settings = ConfigSettings(os.path.expanduser(args.config_file))
+
+    if not args.file:
+        args.file = [config_settings.logfile_location]
+
+    for file_path in args.file:
+        if not isinstance(file_path, (str, bytes, os.PathLike)):
+            print(f"Error: Invalid file path type: {file_path}")
+            sys.exit(1)
+
+        if not os.path.exists(file_path):
+            print(f"Error: Log file '{file_path}' does not exist.")
+            sys.exit(1)
+
+        if file_path.strip() == "":
+            print(f"Error: Invalid empty filename '{file_path}'.")
+            sys.exit(1)
+
+
+    # Run the log file cleaning function
+    for log_file in args.file:
+        clean_log_file(log_file, dry_run=args.dry_run)
+    print(f"Log file '{args.file}' has been cleaned successfully.")
+
+
+if __name__ == "__main__":
+    main()

dar_backup/dar_backup.py

@@ -322,7 +322,7 @@ def list_contents(backup_name, backup_dir, selection=None):
         stdout,stderr = process.stdout, process.stderr
         if process.returncode != 0:
             logger.error(f"Error listing contents of backup: '{backup_name}'")
-            raise subprocess.CalledProcessError(str(process))
+            raise RuntimeError(str(process))
         for line in stdout.splitlines():
             if "[--- REMOVED ENTRY ----]" in line or "[Saved]" in line:
                 print(line)

{dar_backup-0.6.8.dist-info → dar_backup-0.6.10.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dar-backup
-Version: 0.6.8
+Version: 0.6.10
 Summary: A script to do full, differential and incremental backups using dar.     Some files are restored from the backups during verification, after which par2 redundancy files are created.     The script also has a cleanup feature to remove old backups and par2 files.
 Project-URL: Homepage, https://github.com/per2jensen/dar-backup/tree/main/v2
 Project-URL: Changelog, https://github.com/per2jensen/dar-backup/blob/main/v2/Changelog.md
@@ -692,69 +692,114 @@ Description-Content-Type: text/markdown
 
 # Full, differential or incremental backups using 'dar' 
 
-  The wonderful 'dar' [Disk Archiver] (https://github.com/Edrusb/DAR) is used for 
+  The wonderful 'dar' [Disk Archiver] (https://github.com/Edrusb/DAR) is used for
   the heavy lifting, together with the par2 suite in these scripts.
 
-
-#  My use case
-
- I have cloud storage mounted on a directory within my home dir. The filesystem is [FUSE based](https://www.kernel.org/doc/html/latest/filesystems/fuse.html), which gives it a few special features
- - a non-privileged user (me :-)) can perform a mount
- - a privileged user cannot look into the filesystem --> a backup script running as root is not suitable
+## Table of Contents
+
+- [Full, differential or incremental backups using 'dar'](#full-differential-or-incremental-backups-using-dar)
+- [My use case](#my-use-case)
+- [License](#license)
+- [Status](#status)
+  - [Breaking change in version 0.6.0](#breaking-change-in-version-060)
+- [Homepage - Github](#homepage---github)
+- [Requirements](#requirements)
+- [Config file](#config-file)
+- [How to run](#how-to-run)
+  - [1](#1)
+  - [2](#2)
+  - [3](#3)
+  - [4](#4)
+  - [5](#5)
+  - [6](#6)
+- [.darrc](#darrc)
+- [Systemctl examples](#systemctl-examples)
+  - [Service: dar-back --incremental-backup](#service-dar-back---incremental-backup)
+  - [Timer: dar-back --incremental-backup](#timer-dar-back---incremental-backup)
+- [List contents of an archive](#list-contents-of-an-archive)
+- [dar file selection examples](#dar-file-selection-examples)
+  - [Select a directory](#select-a-directory)
+  - [Select file dates in the directory](#select-file-dates-in-the-directory)
+  - [Exclude .xmp files from that date](#exclude-xmp-files-from-that-date)
+- [Restoring](#restoring)
+  - [Default location for restores](#default-location-for-restores)
+  - [--restore-dir option](#restore-dir-option)
+  - [A single file](#a-single-file)
+  - [A directory](#a-directory)
+  - [.NEF from a specific date](#nef-from-a-specific-date)
+- [Points of interest](#points-of-interest)
+  - [dar manager databases](#dar-manager-databases)
+  - [.darrc sets -vd -vf (since v0.6.4)](#darrc-sets--vd--vf-since-v064)
+- [Reference](#reference)
+  - [dar-backup.py](#dar-backuppy)
+  - [manager.py](#managerpy)
+  - [cleanup.py](#cleanuppy)
+  - [clean-log.py](#clean-logpy)
+
+## My use case
+
+I have cloud storage mounted on a directory within my home dir. The filesystem is [FUSE based](https://www.kernel.org/doc/html/latest/filesystems/fuse.html), which gives it a few special features
+
+- a non-privileged user (me :-)) can perform a mount
+- a privileged user cannot look into the filesystem --> a backup script running as root is not suitable
 
  I needed the following:
- - Backup my cloud storage to something local (cloud is convenient, but I want control over my backups)
- - Backup primarily photos, video and different types of documents
- - Have a simple non-complicated way of restoring, possibly years into the future. 'dar' fits that scenario with a single statically linked binary (kept with the archives). There is no need install/configure anything - restoring is simple and works well.
- - During backup archives must be tested and a restore test (however small) performed
- - Archives stored on a server with a reliable file system (easy to mount a directory over sshfs)
- - Easy to verify archive's integrity, after being moved around.
+
+- Backup my cloud storage to something local (cloud is convenient, but I want control over my backups)
+- Backup primarily photos, video and different types of documents
+- Have a simple non-complicated way of restoring, possibly years into the future. 'dar' fits that scenario with a single statically linked binary (kept with the archives). There is no need install/configure anything - restoring is simple and works well.
+- During backup archives must be tested and a restore test (however small) performed
+- Archives stored on a server with a reliable file system (easy to mount a directory over sshfs)
+- Easy to verify archive's integrity, after being moved around.
 
  I do not need the encryption features of dar, as all storage is already encrypted.
- 
 
-# License
+## License
 
   These scripts are licensed under the GPLv3 license.
   Read more here: https://www.gnu.org/licenses/gpl-3.0.en.html, or have a look at the ["LICENSE"](https://github.com/per2jensen/dar-backup/blob/main/LICENSE) file in this repository.
 
+## Status
 
-# Status
 As of August 8, 2024 I am using the alpha versions of `dar-backup` (alpha-0.5.9 onwards) in my automated backup routine.
 
 As of February 13, 2025, I have changed the status from alpha --> beta, as the featureset is in place and the alphas have worked well for a very long time.
 
-
-**Breaking change in version 0.6.0**
+### Breaking change in version 0.6.0
 
 Version 0.6.0 and forwards requires the config variable *COMMAND_TIMEOUT_SECS* in the config file.
 
-# Homepage - Github
-This 'dar-backup' package lives at: https://github.com/per2jensen/dar-backup
+## Homepage - Github
+
+This 'dar-backup' package lives at: https://github.com/per2jensen/dar-backup/tree/main/v2
 
 This python version is v2 of dar-backup, the first is made in bash.
 
-# Requirements
-  - dar
-  - par2
-  - python3 :-)
+## Requirements
+
+- dar
+- par2
+- python3 :-)
 
 On Ubuntu, install the requirements this way:
-  ````
+
+```` bash
     sudo apt install dar par2 python3
-  ````
+````
 
-# Config file
+## Config file
 
 The default configuration is expected here: ~/.config/dar-backup/dar-backup.conf
 
-# How to run 
+## How to run 
+
+### 1
 
-## 1
 Config file default location is $HOME/.config/dar-backup/dar-backup.conf
 
 Example:
-````
+
+```` code
 [MISC]
 LOGFILE_LOCATION=/home/user/dar-backup.log
 MAX_SIZE_VERIFICATION_MB = 20
@@ -791,9 +836,10 @@ ENABLED = True
 # SCRIPT_2 = <something>
 # ...
 
-````    
+````
+
+### 2
 
-## 2 
 Put your backup definitions in the directory $BACKUP.D_DIR (defined in the config file)
 
 The name of the file is the `backup definition` name.
@@ -803,7 +849,8 @@ Make as many backup definitions as you need. Run them all in one go, or run one
 The `dar` [documentation](http://dar.linux.free.fr/doc/man/dar.html#COMMANDS%20AND%20OPTIONS) has good information on file selection.
 
 Example of backup definition for a home directory
-````    
+
+```` code
 
 # Switch to ordered selection mode, which means that the following
 # options will be considered top to bottom
@@ -817,7 +864,7 @@ Example of backup definition for a home directory
 # if you want to take a backup of /home/user/Documents only, uncomment next line
 #  -g Documents 
 
-# Some directories to exclude below the Root dir
+# Some directories to exclude below the Root dir (here Root directory is `/home/user` as set in the -R option)
  -P mnt
  -P tmp
  -P .cache
@@ -836,131 +883,93 @@ Example of backup definition for a home directory
  # size of each slice in the archive
  --slice 10G
 
-# see https://github.com/per2jensen/dar-backup?tab=readme-ov-file#restore-test-exit-code-4
---comparison-field=ignore-owner
 
 # bypass directores marked as cache directories
 # http://dar.linux.free.fr/doc/Features.html
 --cache-directory-tagging
-````    
+````
 
+### 3
 
-## 3
 Installation is currently in a venv. These commands are installed in the venv:
+
 - dar-back
 - cleanup
 - manager
+- clean-log
 
 To install, create a venv and run pip:
-````    
+
+```` bash
 mkdir $HOME/tmp
 cd $HOME/tmp
 python3 -m venv venv    # create the virtual environment 
 . venv/bin/activate     # activate the virtual env
 pip install dar-backup  # run pip to install `dar-backup`
-````    
-
+````
 
 I have an alias in ~/.bashrc pointing to my venv:
-````    
+
+```` bash
 alias db=". ~/tmp/venv/bin/activate; dar-backup -v"
-````    
+````
 
 Typing `db` at the command line gives this
-````    
+
+```` bash
 (venv) user@machine:~$ db
-dar-backup 0.5.17
+dar-backup 0.6.9
 dar-backup.py source code is here: https://github.com/per2jensen/dar-backup
 Licensed under GNU GENERAL PUBLIC LICENSE v3, see the supplied file "LICENSE" for details.
 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW, not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 See section 15 and section 16 in the supplied "LICENSE" file.
 ````
 
-`dar-backup -h` gives the usage output:
-````
-usage: dar-backup [-h] [-F] [-D] [-I] [-d BACKUP_DEFINITION]
-                  [--alternate-reference-archive ALTERNATE_REFERENCE_ARCHIVE] [-c CONFIG_FILE] [--darrc DARRC]
-                  [--examples] [-l] [--list-contents LIST_CONTENTS] [--selection SELECTION] [-r RESTORE]
-                  [--restore-dir RESTORE_DIR] [--verbose] [--log-level LOG_LEVEL] [--log-stdout]
-                  [--do-not-compare] [-v]
-
-Backup and verify using dar backup definitions.
-
-options:
-  -h, --help            show this help message and exit
-  -F, --full-backup     Perform a full backup.
-  -D, --differential-backup
-                        Perform differential backup.
-  -I, --incremental-backup
-                        Perform incremental backup.
-  -d BACKUP_DEFINITION, --backup-definition BACKUP_DEFINITION
-                        Specific 'recipe' to select directories and files.
-  --alternate-reference-archive ALTERNATE_REFERENCE_ARCHIVE
-                        DIFF or INCR compared to specified archive.
-  -c CONFIG_FILE, --config-file CONFIG_FILE
-                        Path to 'dar-backup.conf'
-  --darrc DARRC         Optional path to .darrc
-  --examples            Examples of using dar-backup.py.
-  -l, --list            List available archives.
-  --list-contents LIST_CONTENTS
-                        List the contents of the specified archive.
-  --selection SELECTION
-                        dar file selection for listing/restoring specific files/directories.
-  -r RESTORE, --restore RESTORE
-                        Restore specified archive.
-  --restore-dir RESTORE_DIR
-                        Directory to restore files to.
-  --verbose             Print various status messages to screen
-  --log-level LOG_LEVEL
-                        `debug` or `trace`
-  --log-stdout          also print log messages to stdout
-  --do-not-compare      do not compare restores to file system
-  -v, --version         Show version and license information.
-````    
-
-## 4
+### 4
+
 Generate the archive catalog database(s). 
 `dar-backup` expects the catalog databases to be in place, it does not automatically create them (by design)
 
-````    
-manager --create-db --config-file <path to config file> --log-level debug --log-stdout
-````    
-
-
+```` bash
+manager --create-db
+````
 
+### 5
 
-## 5
 You are ready to do backups of all your backup definitions, if your backup definitions are 
 in place in BACKUP.D_DIR (see config file)
-````    
+
+```` bash
 dar-backup --full-backup 
-````    
+````
+
 If you want to see dar-backup's log entries in the terminal, use the `--log-stdout` option. This is also useful if dar-backup is started by systemd.
 
 If you want more log messages, use the `--log-level debug` option.
 
-
 If you want a backup of a single definition, use the `-d <backup definition>` option. The definition's name is the filename of the definition in the `backup.d` config directory.
-````    
+
+```` bash
 dar-backup --full-backup -d <your backup definition>
 ````
 
-## 6 
+### 6
 
 Deactivate the virtual environment
-````
+
+```` bash
 deactivate
 ````
 
+## .darrc
 
-# .darrc
 The package includes a default `.darrc` file which configures `dar`.
 
 You can override the default `.darrc` using the `--darrc` option.
 
 The default `.darrc` contents are as follows:
 
-````
+```` code
 #  .darrc configuration file for `dar` as used by the `dar-backup` script.
 #  `dar-backup` lives here: https://github.com/per2jensen/dar-backup
 
@@ -998,19 +1007,21 @@ verbose:
 # -va
 
 
-extract:
+restore-options:
 # don't restore File Specific Attributes
 #--fsa-scope none
 
 # ignore owner, useful when used by a non-privileged user
 --comparison-field=ignore-owner
 
+
+# Exclude specific file types from compression
+compress-exclusion:
+
 # First setting case insensitive mode on:
 -an
 -ag
 
-# Exclude specific file types from compression
-compress-exclusion:
 -Z    "*.gz"
 -Z    "*.bz2"
 -Z    "*.xz"
@@ -1081,14 +1092,15 @@ compress-exclusion:
 -acase
 ````
 
-# Systemctl examples
+## Systemctl examples
+
 I have dar-backup scheduled to run via systemd --user settings.
 
 The files are located in: ~/.config/systemd/user
 
 Once the .service and .timer files are in place, timers must be enabled and started.
 
-````
+```` bash
 systemctl --user enable dar-inc-backup.timer
 systemctl --user start  dar-inc-backup.timer
 systemctl --user daemon-reload
@@ -1096,15 +1108,15 @@ systemctl --user daemon-reload
 
 Verify your timers are set up as you want:
 
-````
+```` bash
 systemctl --user list-timers
 ````
 
-
 ## Service: dar-back --incremental-backup
 
 File:  dar-inc-backup.service
-````
+
+```` code
 [Unit]
 Description=dar-backup INC
 StartLimitIntervalSec=120
@@ -1119,7 +1131,8 @@ ExecStart=/bin/bash -c '. /home/user/programmer/dar-backup.py/venv/bin/activate
 ## Timer: dar-back --incremental-backup
 
 File:  dar-inc-backup.timer
-````
+
+```` code
 [Unit]
 Description=dar-backup INC timer
 
@@ -1131,15 +1144,17 @@ Persistent=true
 WantedBy=timers.target
 ````
 
+## list contents of an archive
 
-# list contents of an archive
-```
+```` bash
 . <the virtual evn>/bin/activate
 dar-backup --list-contents example_FULL_2024-06-23 --selection "-X '*.xmp' -I '*2024-06-16*' -g home/pj/tmp/LUT-play"
 deactivate
-```
+````
+
 gives
-```
+
+``` code
 [Data ][D][ EA  ][FSA][Compr][S]| Permission | User  | Group | Size    |          Date                 |    filename
 --------------------------------+------------+-------+-------+---------+-------------------------------+------------
 [Saved][-]       [-L-][   0%][ ]  drwxr-xr-x   root	root	113 Mio	Sat May 11 16:16:48 2024	home
@@ -1149,17 +1164,17 @@ gives
 [Saved][ ]       [-L-][   0%][X]  -rw-rw-r--   pj	pj	49 Mio	Sun Jun 16 12:52:22 2024	home/pj/tmp/LUT-play/2024-06-16_12:52:22,15.NEF
 ```
 
+## dar file selection exmaples
 
+### select a directory
 
-
-# dar file selection exmaples
-
-## select a directory
-```
+``` bash
 dar -l /tmp/example_FULL_2024-06-23  -g home/pj/tmp/LUT-play
 ```
+
 gives
-```
+
+```` code
 [Data ][D][ EA  ][FSA][Compr][S]| Permission | User  | Group | Size    |          Date                 |    filename
 --------------------------------+------------+-------+-------+---------+-------------------------------+------------
 [Saved][-]       [-L-][   0%][ ]  drwxr-xr-x   root	root	113 Mio	Sat May 11 16:16:48 2024	home
@@ -1186,15 +1201,17 @@ gives
 [Saved][ ]       [-L-][  92%][ ]  -rw-rw-r--   pj	pj	24 kio	Sat Jun 22 21:51:15 2024	home/pj/tmp/LUT-play/2024-06-16_12:52:22,15_16.NEF.xmp
 [Saved][ ]       [-L-][  92%][ ]  -rw-rw-r--   pj	pj	24 kio	Sat Jun 22 21:50:48 2024	home/pj/tmp/LUT-play/2024-06-16_12:52:22,15_17.NEF.xmp
 [Saved][ ]       [-L-][  92%][ ]  -rw-rw-r--   pj	pj	24 kio	Sat Jun 22 21:50:19 2024	home/pj/tmp/LUT-play/2024-06-16_12:52:22,15_18.NEF.xmp
-```
+````
 
+### select file dates in the directory:
 
-## select file dates in the directory:
-```
+``` bash
 dar -l /tmp/example_FULL_2024-06-23  -I '*2024-06-16*' -g home/pj/tmp/LUT-play
 ```
+
 gives
-```
+
+``` code
 [Data ][D][ EA  ][FSA][Compr][S]| Permission | User  | Group | Size    |          Date                 |    filename
 --------------------------------+------------+-------+-------+---------+-------------------------------+------------
 [Saved][-]       [-L-][   0%][ ]  drwxr-xr-x   root	root	113 Mio	Sat May 11 16:16:48 2024	home
@@ -1223,12 +1240,16 @@ gives
 [Saved][ ]       [-L-][  92%][ ]  -rw-rw-r--   pj	pj	24 kio	Sat Jun 22 21:50:19 2024	home/pj/tmp/LUT-play/2024-06-16_12:52:22,15_18.NEF.xmp
 ```
 
-## exclude .xmp files from that date
-```
+### exclude .xmp files from that date
+
+``` bash
 dar -l /tmp/example_FULL_2024-06-23 -X '*.xmp' -I '*2024-06-16*' -g home/pj/tmp/LUT-play
+
 ```
+
 gives
-```
+
+``` code
 [Data ][D][ EA  ][FSA][Compr][S]| Permission | User  | Group | Size    |          Date                 |    filename
 --------------------------------+------------+-------+-------+---------+-------------------------------+------------
 [Saved][-]       [-L-][   0%][ ]  drwxr-xr-x   root	root	113 Mio	Sat May 11 16:16:48 2024	home
@@ -1240,16 +1261,16 @@ gives
 
 Nice :-)
 
+## Restoring
 
+### default location for restores
 
-# Restoring
-
-## default location for restores
 dar-backup will use the TEST_RESTORE_DIR location as the Root for restores, if the --restore-dir option has not been supplied.
 
 See example below to see where files are restored to.
 
-## --restore-dir option
+### --restore-dir option
+
 When the --restore-dir option is used for restoring, a directory must be supplied.
 
 The directory supplied functions as the Root of the restore operation.
@@ -1257,41 +1278,122 @@ The directory supplied functions as the Root of the restore operation.
 **Example**:
 
 A backup has been taken using this backup definition:
-```
+
+``` code
 -R /
 -g home/user/Documents
 ```
 
 When restoring and using `/tmp` for --restore-dir, the restored files can be found in `/tmp/home/user/Documents`
 
-## a single file
-```
+### a single file
+
+``` code
 . <the virtual env>/bin/activate
 dar-backup --restore <archive_name> --selection "-g path/to/file"
 deactivate
+
 ```
-## a directory
-```
+
+### a directory
+
+``` bash
 . <the virtual env>/bin/activate
 dar-backup --restore <archive_name> --selection "-g path/to/directory"
 deactivate
 ```
 
+### .NEF from a specific date
 
-## .NEF from a specific date
-```
+``` bash
 . <the virtual env>/bin/activate
 dar-backup --restore <archive_name>  --selection "-X '*.xmp' -I '*2024-06-16*' -g home/pj/tmp/LUT-play"
 deactivate
 ```
 
+## Points of interest
 
-# Points of interest
- 
-## .darrc sets -vd -vf (since v0.6.4)
+### dar manager databases
+
+`dar-backup` now saves archive catalogs in dar catalog databases.
+
+This makes it easier to restore to a given date when having many FULL, DIFF and INCR archives.
+
+### .darrc sets -vd -vf (since v0.6.4)
 
 These .darrc settings make `dar` print the current directory being processed (-vd) and some stats after (-vf)
 This is very useful in very long running jobs to get an indication that the backup is proceeding normally.
 
-if --log-stdout is used the information would be picked up by systemd and logged by journald
+if --log-stdout is used the information would be picked up by systemd and logged by journald.½
+
+The log file can get quite cluttered, if you want the clutter to be removed, run the `clean-log`script.
+
+## Reference
+
+### dar-backup.py
+
+This script is responsible for managing the backup creation and validation process. It supports the following options:
+
+``` code
+--full-backup                     Perform a full backup.
+--differential-backup             Perform a differential backup.
+--incremental-backup              Perform an incremental backup.
+--backup-definition <name>        Specify the backup definition file.
+--alternate-reference-archive <file>  Use a different archive for DIFF/INCR backups.
+--config-file <path>              Specify the path to the configuration file.
+--darrc <path>                    Specify an optional path to .darrc.
+--examples                        Show examples of using dar-backup.py.
+--list                            List available backups.
+--list-contents <archive>         List the contents of a specified archive.
+--selection <params>              Define file selection for listing/restoring.
+--restore <archive>               Restore a specified archive.
+--restore-dir <path>              Directory to restore files to.
+--verbose                         Enable verbose output.
+--log-level <level>               Set log level (debug, trace, etc.).
+--log-stdout                      Also print log messages to stdout.
+--do-not-compare                  Do not compare restores to file system.
+--version                         Show version and license information.
+```
+
+### manager.py
+
+This script manages `dar` databases and catalogs. Available options include:
+
+``` code
+--create-db                     Create missing databases for all backup definitions.
+--alternate-archive-dir <path>   Use this directory instead of BACKUP_DIR in the config file.
+--add-dir <path>                 Add all archive catalogs in this directory to databases.
+-d, --backup-def <name>          Restrict to work only on this backup definition.
+--add-specific-archive <file>    Add this archive to the catalog database.
+--remove-specific-archive <file> Remove this archive from the catalog database.
+-l, --list-catalogs              List catalogs in databases for all backup definitions.
+--list-catalog-contents <num>    List contents of a catalog by archive number.
+--list-archive-contents <file>   List contents of an archive’s catalog.
+--find-file <file>               Search catalogs for a specific file.
+--verbose                        Enable verbose output.
+--log-level <level>              Set log level.
+```
+
+### cleanup.py
 
+This script cleans up old backups and manages storage. Supported options:
+
+``` code
+--prune-older-than <days>   Remove backups older than the specified number of days.
+--keep-last <num>           Retain only the last <num> backups.
+--dry-run                   Show what would be deleted without actually deleting.
+--backup-dir <path>         Specify the backup directory.
+--verbose                   Enable verbose output.
+--help                      Show this help message and exit.
+```
+
+### clean-log.py
+
+This script removes excessive logging output from `dar` logs, improving readability and efficiency. Available options:
+
+``` code
+-f, --file <path>          Specify the log file(s) to be cleaned.
+-c, --config-file <path>   Specify the configuration file (default: ~/.config/dar-backup/dar-backup.conf).
+--dry-run                  Show which lines would be removed without modifying the file.
+-v, --version              Display version and licensing information.
+```

dar_backup-0.6.10.dist-info/RECORD

@@ -0,0 +1,14 @@
+dar_backup/.darrc,sha256=-aerqivZmOsW_XBCh9IfbYTUvw0GkzDSr3Vx4GcNB1g,2113
+dar_backup/__about__.py,sha256=G-zfU8sHQRTZnZK0te1cvbxqeLhT1z86XeAYFNUON6Q,22
+dar_backup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dar_backup/clean_log.py,sha256=VXKA2BMyQmaC6R08Bq9a3wP3mczdFb_moy6HkL-mnF8,5176
+dar_backup/cleanup.py,sha256=9yEdRR84XPtEvBGc2QfwGBQl2tdTPttjetHeiSc_TsM,11419
+dar_backup/config_settings.py,sha256=CBMUhLOOZ-x7CRdS3vBDk4TYaGqC4N1Ot8IMH-qPaI0,3617
+dar_backup/dar_backup.py,sha256=hDy7aXU-XiWOtW40Pxql441liNkSYKGU76eOwy8m7fU,32714
+dar_backup/manager.py,sha256=HDa8eYF89QFhlBRR4EWRzzmswOW00S_w8ToZ5SARO_o,21359
+dar_backup/util.py,sha256=SSSJYM9lQZfubhTUBlX1xDGWmCpYEF3ePARmlY544xM,11283
+dar_backup-0.6.10.dist-info/METADATA,sha256=CEgbqp93sB_cPnEDWuLn7gphZjdrn4zP_5dShC2Buv8,67980
+dar_backup-0.6.10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+dar_backup-0.6.10.dist-info/entry_points.txt,sha256=p6c4uQLjlTIVP1Od2iorGefrVUH0IWZdFRMl63mNaRg,164
+dar_backup-0.6.10.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+dar_backup-0.6.10.dist-info/RECORD,,

{dar_backup-0.6.8.dist-info → dar_backup-0.6.10.dist-info}/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
+clean-log = dar_backup.clean_log:main
 cleanup = dar_backup.cleanup:main
 dar-backup = dar_backup.dar_backup:main
 manager = dar_backup.manager:main

dar_backup-0.6.8.dist-info/RECORD

@@ -1,13 +0,0 @@
-dar_backup/.darrc,sha256=-aerqivZmOsW_XBCh9IfbYTUvw0GkzDSr3Vx4GcNB1g,2113
-dar_backup/__about__.py,sha256=qbWTdDuFyvScwNj95KArnOcQph9tiLZZ8rgNJYlJ4AE,21
-dar_backup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dar_backup/cleanup.py,sha256=9yEdRR84XPtEvBGc2QfwGBQl2tdTPttjetHeiSc_TsM,11419
-dar_backup/config_settings.py,sha256=CBMUhLOOZ-x7CRdS3vBDk4TYaGqC4N1Ot8IMH-qPaI0,3617
-dar_backup/dar_backup.py,sha256=VbpyiCnoVvJuMWS7LO9wo8WIcDegCPVjb5Q7xN9J9Gg,32731
-dar_backup/manager.py,sha256=HDa8eYF89QFhlBRR4EWRzzmswOW00S_w8ToZ5SARO_o,21359
-dar_backup/util.py,sha256=SSSJYM9lQZfubhTUBlX1xDGWmCpYEF3ePARmlY544xM,11283
-dar_backup-0.6.8.dist-info/METADATA,sha256=U3iy7Gzz-D6p5UePy0VLzX2lNbELs0teKBEZXr-sSqc,64610
-dar_backup-0.6.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-dar_backup-0.6.8.dist-info/entry_points.txt,sha256=x9vnW-JEl8mpDJC69f_XBcn0mBSkV1U0cyvFV-NAP1g,126
-dar_backup-0.6.8.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-dar_backup-0.6.8.dist-info/RECORD,,