Docs: tile-based output requires libgsf

lovell · Mar 22, 2023 · 6008ff8 · 6008ff8
1 parent cd5e11b
commit 6008ff8
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/docs/api-output.md b/docs/api-output.md
@@ -549,6 +549,10 @@ Use a `.zip` or `.szi` file extension with `toFile` to write to a compressed arc
 
 The container will be set to `zip` when the output is a Buffer or Stream, otherwise it will default to `fs`.
 
+Requires libvips compiled with support for libgsf.
+The prebuilt binaries do not include this - see
+[installing a custom libvips](https://sharp.pixelplumbing.com/install#custom-libvips).
+
 
 **Throws**:
 

diff --git a/lib/output.js b/lib/output.js
@@ -1056,6 +1056,10 @@ function raw (options) {
  *
  * The container will be set to `zip` when the output is a Buffer or Stream, otherwise it will default to `fs`.
  *
+ * Requires libvips compiled with support for libgsf.
+ * The prebuilt binaries do not include this - see
+ * {@link https://sharp.pixelplumbing.com/install#custom-libvips installing a custom libvips}.
+ *
  * @example
  *  sharp('input.tiff')
  *   .png()