Document Lidarr cue splits for FLAC and APE.

split_flac covers both images, and ape_format plus ape_compression choose what an APE image becomes.

Co-authored-by: Cursor <cursoragent@cursor.com>

Author: davidnewhall

docs/install/configuration.md

@@ -136,6 +136,27 @@ Env: `UN_FOLDER_<key>_WAIT_EXTENSION_0=.part`.
 **Empty folders:** `skip_empty` (env `UN_FOLDER_<key>_SKIP_EMPTY`) drops
 archive-free folders after `start_delay` with no history row and no webhook.
 
+### Lidarr cue sheets
+
+Lidarr only. `split_flac` splits a completed download that has a CUE sheet.
+It splits both FLAC and APE images into one file per track, then asks Lidarr
+to import those tracks. Sonarr, Radarr, and Readarr ignore this setting.
+A watched folder does not split cue sheets.
+
+When the image is APE, `ape_format` chooses the files those tracks become:
+
+- `ape` keeps Monkey's Audio. This is the default, and an empty value means the same.
+- `wav` and `flac` decode the audio. FLAC cannot store 32-bit or float PCM.
+
+`ape_compression` applies only when the format is APE. The choices are `1000`,
+`2000`, `3000`, `4000`, and `5000`. A default of `0` is set to `2000` (normal).
+WAV and FLAC ignore compression.
+
+A lone `.ape` file that has no cue sheet is left for Lidarr to import as-is.
+
+Environment variables use the instance key: `UN_LIDARR_<key>_SPLIT_FLAC`,
+`UN_LIDARR_<key>_APE_FORMAT`, and `UN_LIDARR_<key>_APE_COMPRESSION`.
+
 {/* The Global content is generated from here: https://github.com/Unpackerr/unpackerr/tree/main/init/config */}
 <Global />
 

docs/install/upgrading.md

@@ -37,6 +37,10 @@ If you are on 0.16.x or earlier today, read this page before you pull `latest`.
 - Watched-folder extracts resume from history after a restart. Incomplete
   downloads can wait on `wait_extensions`; archive-free folders can be
   skipped with `skip_empty`.
+- Lidarr `split_flac` splits FLAC and APE cue sheets into tracks. APE tracks
+  can be written as APE, WAV, or FLAC (`ape_format`). A compression of `0` is
+  set to normal (`2000`). See
+  [Lidarr cue sheets](configuration#lidarr-cue-sheets).
 
 The extractor and Starr polling work as they did. Folder watch picked up a
 few v1 changes (per-path poll, restore after restart, wait/skip). See

docs/introduction.md

@@ -62,7 +62,8 @@ of these types:
 - Other compressors: `lz4`, `lz`, `lzip`, `lzma`, `lzma2`, `z`, `br`, `brotli`,
   `s2`, `snappy`, `sz`, `zlib`, `zz`
 - Packages and images: `iso`, `cpio`, `cpio.gz`, `cpgz`, `ar`, `deb`, `rpm`
-- Cue sheets (FLAC splits): `cue`, `cue.txt`
+- Cue sheets: `cue`, `cue.txt`. Lidarr's `split_flac` splits FLAC and APE
+  images into tracks. See [Lidarr cue sheets](/docs/install/configuration#lidarr-cue-sheets).
 - Multi-file archives are supported with RAR and 7-Zip.
 - Password protected archives are supported with RAR and 7-Zip.
 - Archives are detected by the file extension. ISO is disabled by default