comparison docs/notes.rst @ 219:19eaba51c632

Refactored the printing of FLAGS: print flags always and explicitely print symlink behaviour and encoding configuration
author Franz Glasner <fzglas.hg@dom66.de>
date Sat, 25 Jan 2025 13:49:12 +0100
parents 7cf9df49d0ba
children d7be68a8937d
comparison
equal deleted inserted replaced
218:dee891ed2307 219:19eaba51c632
26 Fields: 26 Fields:
27 27
28 ``FSENCODING`` 28 ``FSENCODING``
29 29
30 The result of :func:`os.getfilesystemencoding` that is in effect when 30 The result of :func:`os.getfilesystemencoding` that is in effect when
31 generating treesum digests 31 generating treesum digests (process environment)
32 32
33 ``ERROR`` 33 ``ERROR``
34 34
35 Errors are reported: 35 Errors are reported:
36 36
37 - For directories if the one of filenames has a filename problem 37 - For directories if the one of filenames has a filename problem
38 38
39 ``FLAGS`` 39 ``FLAGS``
40 40
41 Defaults without any flags: 41 Some flags are always printed.
42 42
43 - not following any symlinks (but :option:`--no-follow-file-symlinks` is 43 - no file modes and no file mtime is taken into account for digesting
44 not yet supported and coerced to :option:`--follow-file-symlinks`)
45 - no modes- no mtime
46 - filenames are in filesystem encoding
47 - no file size is printed 44 - no file size is printed
48 45
49 Contains: 46 Contains:
50 47
51 - ``with-metadata-fullmode``: if a file mode is used completely as 48 - ``with-metadata-fullmode``: if a file mode is used completely as
52 given by the OS for digest computation 49 given by the OS for digest computation
53 - ``with-metadata-mode``: if just the "portable" file modes are used 50 - ``with-metadata-mode``: if just the "portable" file modes are used
54 for digest computation 51 for digest computation
55 - ``with-metadata-mtime``: if the mtime as ISO-String and truncated to 52 - ``with-metadata-mtime``: if the mtime as ISO-String and truncated to
56 seconds is used in digest computation 53 seconds is used in digest computation
57 - ``print-size``: if the filesize is to to be printed also 54 - ``print-size``: if the filesize is to to be printed also -- does not
58 - ``utf8-mode``: the filenames are not in FS encoding but in UTF-8 55 change digests
59 - ``follow-symlinks-XXX`: if symlinks are followed on the command 56 - ``fs-encoding``: the filenames are given in FS encoding
57 - ``utf8-encoding``: the filenames are given in UTF-8 encoding
58 - ``follow-symlinks-XXX`` and ``no-follow-symlinkx-XXX``: if symlinks are followed on the command
60 line, while directory walking or for files 59 line, while directory walking or for files
61 - ``size-only``: if no digest is to be computed and only a file's size 60 - ``size-only``: if no digest is to be computed and only a file's size
62 is printed and the accumulated file sizes for a directory tree 61 is printed and the accumulated file sizes for a directory tree
63 62
64 63