diff options
| author | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2015-11-09 14:24:04 +0100 |
|---|---|---|
| committer | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2015-11-09 14:24:04 +0100 |
| commit | 27ccb291ea7cf08fda9d7b033a22df6b9909234f (patch) | |
| tree | 32984984d59d0c56c06c99f773ee56fd54857cc6 /docs | |
| parent | 30259ff7865b35b5c3078aa1b6ab2c022df6285e (diff) | |
Fix #99: document environment variables
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/manual/using/details.rst | 21 | ||||
| -rw-r--r-- | docs/manual/using/index.rst | 2 |
2 files changed, 22 insertions, 1 deletions
diff --git a/docs/manual/using/details.rst b/docs/manual/using/details.rst new file mode 100644 index 0000000..fa54ba0 --- /dev/null +++ b/docs/manual/using/details.rst @@ -0,0 +1,21 @@ +.. _using-details: + +============== +Detailed usage +============== + +Environment variables +===================== + +You can modify the run-time behaviour by setting environment variables: + +.. envvar:: G_MESSAGES_DEBUG + + Controls the output of the library. By default nothing is printed on stdout. + Set this to `all` to see debug output. + +.. envvar:: UFO_DEVICES + + Controls which OpenCL devices should be used. It works similar to the + `CUDA_VISIBLE_DEVICES` environment variables, i.e. set it to `0,2` to choose + the first and third device that's available. diff --git a/docs/manual/using/index.rst b/docs/manual/using/index.rst index 79ce8c3..7c12fb7 100644 --- a/docs/manual/using/index.rst +++ b/docs/manual/using/index.rst @@ -24,7 +24,7 @@ own image processing pipeline or implement a new filter. :maxdepth: 2 quickstart.rst + details.rst background.rst cluster.rst filters.rst - |