mirrors/sist2
1
0
Fork 0
mirror of https://github.com/sist2app/sist2.git synced 2025-05-11 12:25:54 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Some documentation updates

Browse source
This commit is contained in:
simon987 2021-09-24 20:55:08 -04:00
parent 43a566fe2f
commit 0a7e59b646
3 changed files with 17 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/USAGE.md
View file

@ -49,6 +49,7 @@ Scan options
--mem-buffer=<int> Maximum memory buffer size per thread in MB for files inside archives (see USAGE.md). DEFAULT: 2000
--read-subtitles Read subtitles from media files.
--fast-epub Faster but less accurate EPUB parsing (no thumbnails, metadata)
--checksums Calculate file checksums when scanning.
Index options
-t, --threads=<int> Number of threads. DEFAULT=1
@ -129,6 +130,9 @@ Exec-script options
To check if a media file can be parsed without *seek*, execute `cat file.mp4 | ffprobe -`
* `--read-subtitles` When enabled, will attempt to read the subtitles stream from media files.
* `--fast-epub` Much faster but less accurate EPUB parsing. When enabled, sist2 will use a simple HTML parser to read epub files instead of the MuPDF library. No thumbnails are generated and author/title metadata are not parsed.
* `--checksums` Calculate file checksums (sha1) when scanning files. This option does not cause any additional read
operations. Checksums are not calculated for all file types, unless the file is inside an archive. When enabled, duplicate
files are hidden in the web UI (this behaviour can be toggled in the Configuration page).
### Scan examples