From b978132ee046655ed1b0b7d4eef162876b2c9b3b Mon Sep 17 00:00:00 2001 From: simon987 Date: Sun, 9 Jan 2022 10:20:49 -0500 Subject: [PATCH] Update readme --- README.md | 11 ++++++----- docs/USAGE.md | 12 +++++++++--- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5cda63e..5ae0f7c 100644 --- a/README.md +++ b/README.md @@ -48,10 +48,11 @@ sist2 (Simple incremental search tool) - "ES_JAVA_OPTS=-Xms1G -Xmx2G" ``` 1. Download sist2 executable - 1. Download the [latest sist2 release](https://github.com/simon987/sist2/releases) * - 1. *(or)* Download a [development snapshot](https://files.simon987.net/.gate/sist2/simon987_sist2/) *(Not + 1. Download the [latest sist2 release](https://github.com/simon987/sist2/releases). +Select the file corresponding to your CPU architecture and mark the binary as executable with `chmod +x` * + 2. *(or)* Download a [development snapshot](https://files.simon987.net/.gate/sist2/simon987_sist2/) *(Not recommended!)* - 1. *(or)* `docker pull simon987/sist2:2.11.6-x64-linux` + 3. *(or)* `docker pull simon987/sist2:2.11.6-x64-linux` 1. See [Usage guide](docs/USAGE.md) @@ -73,8 +74,8 @@ See [Usage guide](docs/USAGE.md) for more details | cbz,cbr | [libscan](https://github.com/simon987/sist2/tree/master/third-party/libscan) | - | yes | - | | `audio/*` | ffmpeg | - | yes | ID3 tags | | `video/*` | ffmpeg | - | yes | title, comment, artist | -| `image/*` | ffmpeg | - | yes | [Common EXIF tags](https://github.com/simon987/sist2/blob/efdde2734eca9b14a54f84568863b7ffd59bdba3/src/parsing/media.c#L190), GPS tags | -| raw, rw2, dng, cr2, crw, dcr, k25, kdc, mrw, pef, xf3, arw, sr2, srf, erf | LibRaw | - | yes | Common EXIF tags, GPS tags | +| `image/*` | ffmpeg | ocr | yes | [Common EXIF tags](https://github.com/simon987/sist2/blob/efdde2734eca9b14a54f84568863b7ffd59bdba3/src/parsing/media.c#L190), GPS tags | +| raw, rw2, dng, cr2, crw, dcr, k25, kdc, mrw, pef, xf3, arw, sr2, srf, erf | LibRaw | no | yes | Common EXIF tags, GPS tags | | ttf,ttc,cff,woff,fnt,otf | Freetype2 | - | yes, `bmp` | Name & style | | `text/plain` | [libscan](https://github.com/simon987/sist2/tree/master/third-party/libscan) | yes | no | - | | html, xml | [libscan](https://github.com/simon987/sist2/tree/master/third-party/libscan) | yes | no | - | diff --git a/docs/USAGE.md b/docs/USAGE.md index 1112986..3219e61 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -43,7 +43,9 @@ Scan options --depth= Scan up to DEPTH subdirectories deep. Use 0 to only scan files in PATH. DEFAULT: -1 --archive= Archive file mode (skip|list|shallow|recurse). skip: Don't parse, list: only get file names as text, shallow: Don't parse archives inside archives. DEFAULT: recurse --archive-passphrase= Passphrase for encrypted archive files - # TODO: add new --ocr-* options here + --ocr-lang= Tesseract language (use 'tesseract --list-langs' to see which are installed on your machine) + --ocr-images Enable OCR'ing of image files. + --ocr-ebooks Enable OCR'ing of ebook files. -e, --exclude= Files that match this regex will not be scanned --fast Only index file names & mime type --treemap-threshold= Relative size threshold for treemap (see USAGE.md). DEFAULT: 0.0005 @@ -51,6 +53,7 @@ Scan options --read-subtitles Read subtitles from media files. --fast-epub Faster but less accurate EPUB parsing (no thumbnails, metadata) --checksums Calculate file checksums when scanning. + --list-file= Specify a list of newline-delimited paths to be scanned instead of normal directory traversal. Use '-' to read from stdin. Index options -t, --threads= Number of threads. DEFAULT=1 @@ -72,6 +75,7 @@ Web options --tag-auth= Basic auth in user:password format for tagging --tagline= Tagline in navbar --dev Serve html & js files from disk (for development) + --lang= Default UI language. Can be changed by the user Exec-script options --es-url= Elasticsearch url. DEFAULT=http://localhost:9200 @@ -105,7 +109,7 @@ Exec-script options * list: Only get file names as text * shallow: Don't parse archives inside archives. * recurse: Scan archives recursively (default) -* `--ocr` See [OCR](../README.md#OCR) +* `--ocr-lang`, `--ocr-ebooks`, `--ocr-images` See [OCR](../README.md#OCR) * `-e, --exclude` Regex pattern to exclude files. A file is excluded if the pattern matches any part of the full absolute path. @@ -248,7 +252,9 @@ sist2 index --print ./my_index/ | jq | less `--auth` argument, but authentication is only applied the `/tag/` endpoint. * `--tagline=` When specified, will replace the default tagline in the navbar. * `--dev` Serve html & js files from disk (for development, used to modify frontend files without having to recompile) - + * `--lang=` Set the default web UI language (See #180 for a list of supported languages, default + is `en`). The user can change the language in the configuration page + ### Web examples **Single index**