# HG changeset patch
# User Franz Glasner <fzglas.hg@dom66.de>
# Date 1737637447 -3600
# Node ID 7cf9df49d0baffa87c03594a111dc3f479730fde
# Parent  5bb0b25f8e99de8c227646d66d3c930f228f86cd
Some notes about FLAGS

diff -r 5bb0b25f8e99 -r 7cf9df49d0ba docs/notes.rst
--- a/docs/notes.rst	Thu Jan 23 14:02:44 2025 +0100
+++ b/docs/notes.rst	Thu Jan 23 14:04:07 2025 +0100
@@ -1,4 +1,4 @@
-.. -*- coding: utf-8 -*-
+.. -*- coding: utf-8; indent-tabs-mode: nil; -*-
 
 
 In a aggregated directory checksum at the end of a block:
@@ -36,6 +36,30 @@
 
       - For directories if the one of filenames has a filename problem
 
+   ``FLAGS``
+
+      Defaults without any flags:
+
+      - not following any symlinks (but :option:`--no-follow-file-symlinks` is
+        not yet supported and coerced to :option:`--follow-file-symlinks`)
+      - no modes- no mtime
+      - filenames are in filesystem encoding
+      - no file size is printed
+
+      Contains:
+
+      - ``with-metadata-fullmode``: if a file mode is used completely as
+        given by the OS for digest computation
+      - ``with-metadata-mode``: if just the "portable" file modes are used
+        for digest computation
+      - ``with-metadata-mtime``: if the mtime as ISO-String and truncated to
+        seconds is used in digest computation
+      - ``print-size``: if the filesize is to to be printed also
+      - ``utf8-mode``: the filenames are not in FS encoding but in UTF-8
+      - ``follow-symlinks-XXX`: if symlinks are followed on the command
+        line, while directory walking or for files
+      - ``size-only``: if no digest is to be computed and only a file's size
+        is printed and the accumulated file sizes for a directory tree
 
 
 Offene Fragen