From 6a4dddbd04e320baaf7c83ee6f56e4948707d290 Mon Sep 17 00:00:00 2001
From: Florian Spreckelsen <f.spreckelsen@indiscale.com>
Date: Wed, 7 Aug 2024 10:01:19 +0200
Subject: [PATCH] DOC: Add short section on loadFiles to utilities
 documentation

---
 src/doc/utilities.rst | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/src/doc/utilities.rst b/src/doc/utilities.rst
index 4d520ae2..45874352 100644
--- a/src/doc/utilities.rst
+++ b/src/doc/utilities.rst
@@ -35,3 +35,24 @@ behavior can be changed by initializing the ``TableImporter`` with
 :py:class:`~caosadvancedtools.datainconsistency.DataInconsistencyError` is
 raised when an empty field is encountered in a column with an non-nullable
 integer datatype.
+
+The loadfiles module and executable
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+For making files available to the LinkAhead server as File entities
+(see also the server's `file server
+<https://docs.indiscale.com/caosdb-server/specification/Fileserver.html>`_
+documentation), the LinkAhead Advanced User tools provide the
+:py:mod:`~caosadvancedtools.loadFiles` module and a
+`linkahead-loadfiles` executable. Both operate on a path as seen by
+the LinkAhead server (i.e., a path within the Docker container in the
+typical LinkAhead Control setup) and can be further specified to
+exclude or exclude specific files.
+
+Execute
+
+.. code-block:: sh
+
+   linkahead-loadfiles --help
+
+for more information and examples.
-- 
GitLab