From 457250367efd3a7ac94647aaaaf0520e62337260 Mon Sep 17 00:00:00 2001 From: Andrey Kislyuk Date: Sat, 22 Apr 2023 14:41:27 -0700 Subject: [PATCH] Add doc for --xml-item-depth to README --- README.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 2e7d80d..ef80df0 100644 --- a/README.rst +++ b/README.rst @@ -108,7 +108,10 @@ XML support `transcodes XML to JSON `_ using `xmltodict `_ and pipes it to ``jq``. Roundtrip transcoding is available with the ``xq --xml-output``/``xq -x`` option. Multiple XML documents can be passed in separate files/streams as -``xq a.xml b.xml``. Entity expansion and DTD resolution is disabled to avoid XML parsing vulnerabilities. +``xq a.xml b.xml``. Use ``--xml-item-depth`` to descend into large documents, streaming their contents without loading +the full doc into memory (for example, stream a `Wikipedia database dump `_ with +``cat enwiki-*.xml.bz2 | bunzip2 | xq . --xml-item-depth=2``). Entity expansion and DTD resolution is disabled to avoid +XML parsing vulnerabilities. TOML support ------------