From 4f0922301c6a582f5abf356572ecd9d698866879 Mon Sep 17 00:00:00 2001
From: Marcus Holland-Moritz <github@mhxnet.de>
Date: Sun, 3 Sep 2023 18:31:51 +0200
Subject: [PATCH] Add Extended Attributes section to README (fixes github #160)

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/README.md b/README.md
index 6555aa8c..20d17975 100644
--- a/README.md
+++ b/README.md
@@ -22,6 +22,7 @@ A fast high compression read-only file system for Linux and Windows.
 - [Usage](#usage)
 - [Windows Support](#windows-support)
   - [Building on Windows](#building-on-windows)
+- [Extended Attributes](#extended-attributes)
 - [Comparison](#comparison)
   - [With SquashFS](#with-squashfs)
   - [With SquashFS &amp; xz](#with-squashfs--xz)
@@ -480,6 +481,25 @@ your machine.
 > ninja test
 ```
 
+## Extended Attributes
+
+Extended attributes are not currently supported. Any extended attributes
+stored in the source file system will not currently be preserved when
+building a DwarFS image using `mkdwarfs`.
+
+That being said, the root inode of a mounted DwarFS image currently exposes
+one or two extended attributes on Linux:
+
+```
+$ attr -l mnt
+Attribute "dwarfs.driver.pid" has a 4 byte value for mnt
+Attribute "dwarfs.driver.perfmon" has a 4849 byte value for mnt
+```
+
+The `dwarfs.driver.pid` attribute simply contains the PID of the DwarFS
+FUSE driver. The `dwarfs.driver.perfmon` attribute contains the current
+results of the [performance monitor](#performance-monitoring).
+
 ## Comparison
 
 The SquashFS, `xz`, `lrzip`, `zpaq` and `wimlib` tests were all done on
@@ -1959,3 +1979,6 @@ Currently, the supported components are `fuse` for the FUSE
 operations, `filesystem_v2` for the DwarFS file system component
 and `inode_reader_v2` for the component that handles all `read()`
 system calls.
+
+The FUSE driver also exposes the performance monitor metrics via
+an [extended attribute](#extended-attributes).