Document file requirement under magic feature

swsnr · Feb 21, 2023 · e3cedc7 · e3cedc7
1 parent a7d8ce3
commit e3cedc7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -94,7 +94,7 @@ If you package mdcat you may want to include these files too.
 
 ## Requirements
 
-For image type detection the `file` tool with support for `--brief` and `--mime-type` flags must be available in `$PATH`.
+If `mdcat` wasn't built with the `magic` feature, image type detection requires the `file` tool with support for `--brief` and `--mime-type` flags to be available in `$PATH`.
 
 [Homebrew]: https://brew.sh
 [MacPorts]: https://www.macports.org

diff --git a/mdcat.1.adoc b/mdcat.1.adoc
@@ -55,7 +55,8 @@ mdcat supports most standard pixel formats by default.
 
 mdcat silently ignores images larger than 100 MiB.
 
-For some terminals mdcat needs to detect the mimetype; it uses the `file --brief --mime-type` for this purpose, and thus requires a compatible `file` utility in `$PATH`.
+For some terminals mdcat needs to detect the mimetype.
+If `mdcat` was not built with `libmagic` (see output of `--version` to check) it uses the `file --brief --mime-type` for this purpose, and thus requires a compatible `file` utility in `$PATH`.
 
 === SVG support