Skip to content

Commit 97a14b0

Browse files
committed
describe OCRD_PROFILE{,_FILE} in README
1 parent 4fdfbf3 commit 97a14b0

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
* [Command line tools](#command-line-tools)
2020
* [`ocrd` CLI](#ocrd-cli)
2121
* [`ocrd-dummy` CLI](#ocrd-dummy-cli)
22+
* [Configuration](#configuration)
2223
* [Packages](#packages)
2324
* [ocrd_utils](#ocrd_utils)
2425
* [ocrd_models](#ocrd_models)
@@ -81,6 +82,19 @@ supported flags, options and arguments.
8182

8283
A minimal [OCR-D processor](https://ocr-d.de/en/user_guide#using-the-ocr-d-processors) that copies from `-I/-input-file-grp` to `-O/-output-file-grp`
8384

85+
## Configuration
86+
87+
Almost all behaviour of the OCR-D/core software is configured via CLI options and flags, which can be listed with the `--help` flag that all CLI support.
88+
89+
Some parts of the software are configured via environement variables:
90+
91+
* `OCRD_METS_CACHING`: If set to `true`, access to the METS file is cached, speeding in-memory search and modification.
92+
* `OCRD_PROFILE`: This variable configures the built-in CPU and memory profiling. If empty, no profiling is done. Otherwise expected to contain any of the following tokens:
93+
* `CPU`: Enable CPU profiling of processor runs
94+
* `RSS`: Enable RSS memory profiling
95+
* `PSS`: Enable proportionate memory profiling
96+
* `OCRD_PROFILE_FILE`: If set, then the CPU profile is written to this file for later peruse with a analysis tools like [snakeviz](https://jiffyclub.github.io/snakeviz/)
97+
8498
## Packages
8599

86100
### ocrd_utils

0 commit comments

Comments
 (0)