Merge pull request #2476 from lonvia/harmonize-configuration-file-settings

[nominatim.git] / settings / env.defaults

diff --git a/settings/env.defaults b/settings/env.defaults
index cf1f5108c4ac1ff839c6a4336e9070833af00cc5..00f5569ae0894db7aa1179cd39bb635ad98042eb 100644 (file)
--- a/settings/env.defaults
+++ b/settings/env.defaults
@@ -24,7 +24,7 @@ NOMINATIM_DATABASE_MODULE_PATH=
 # Currently available tokenizers: legacy
 NOMINATIM_TOKENIZER="legacy"
 
 # Currently available tokenizers: legacy
 NOMINATIM_TOKENIZER="legacy"
 

-# Number of occurances of a word before it is considered frequent.
+# Number of occurrences of a word before it is considered frequent.

 # Similar to the concept of stop words. Frequent partial words get ignored
 # or handled differently during search.
 # Changing this value requires a reimport.
 # Similar to the concept of stop words. Frequent partial words get ignored
 # or handled differently during search.
 # Changing this value requires a reimport.


@@ -48,7 +48,7 @@ NOMINATIM_TERM_NORMALIZATION=":: NFD (); [[:Nonspacing Mark:] [:Cf:]] >;  :: low
 
 # Configuration file for the tokenizer.
 # The content depends on the tokenizer used. If left empty the default settings
 
 # Configuration file for the tokenizer.
 # The content depends on the tokenizer used. If left empty the default settings

-# for the chooseen tokenizer will be used. The configuration can only be set
+# for the chosen tokenizer will be used. The configuration can only be set

 # on import and not be changed afterwards.
 NOMINATIM_TOKENIZER_CONFIG=
 
 # on import and not be changed afterwards.
 NOMINATIM_TOKENIZER_CONFIG=
 


@@ -57,7 +57,7 @@ NOMINATIM_TOKENIZER_CONFIG=
 # Changing this value requires to run ./utils/setup --create-functions --setup-website.
 NOMINATIM_USE_US_TIGER_DATA=no
 
 # Changing this value requires to run ./utils/setup --create-functions --setup-website.
 NOMINATIM_USE_US_TIGER_DATA=no
 

-# Search in the auxilary housenumber table.
+# Search in the auxiliary housenumber table.

 # Changing this value requires to run ./utils/setup --create-functions --setup-website.
 NOMINATIM_USE_AUX_LOCATION_DATA=no
 
 # Changing this value requires to run ./utils/setup --create-functions --setup-website.
 NOMINATIM_USE_AUX_LOCATION_DATA=no
 


@@ -65,7 +65,7 @@ NOMINATIM_USE_AUX_LOCATION_DATA=no
 # The following settings allow to set a proxy to use when remotely downloading
 # data. Host and port are required. Login and password are optional.
 NOMINATIM_HTTP_PROXY=no
 # The following settings allow to set a proxy to use when remotely downloading
 # data. Host and port are required. Login and password are optional.
 NOMINATIM_HTTP_PROXY=no

-NOMINATIM_HTTP_PROXY_HOST=proxy.mydomain.com
+NOMINATIM_HTTP_PROXY_HOST=

 NOMINATIM_HTTP_PROXY_PORT=3128
 NOMINATIM_HTTP_PROXY_LOGIN=
 NOMINATIM_HTTP_PROXY_PASSWORD=
 NOMINATIM_HTTP_PROXY_PORT=3128
 NOMINATIM_HTTP_PROXY_LOGIN=
 NOMINATIM_HTTP_PROXY_PASSWORD=


@@ -89,14 +89,12 @@ NOMINATIM_TIGER_DATA_PATH=
 NOMINATIM_WIKIPEDIA_DATA_PATH=
 
 # Configuration file for special phrase import.
 NOMINATIM_WIKIPEDIA_DATA_PATH=
 
 # Configuration file for special phrase import.

-# When unset, the internal default settings from 'settings/phrase-settings.json'
-# are used.
+# OBSOLETE: use `nominatim special-phrases --config <file>` or simply put
+#           a custom phrase-settings.json into your project directory.

 NOMINATIM_PHRASE_CONFIG=
 
 # Configuration file for rank assignments.
 NOMINATIM_PHRASE_CONFIG=
 
 # Configuration file for rank assignments.

-# When unset, the internal default settings from 'settings/address-levels.json'
-# are used.
-NOMINATIM_ADDRESS_LEVEL_CONFIG=
+NOMINATIM_ADDRESS_LEVEL_CONFIG=address-levels.json

 
 # Configuration file for OSM data import.
 # This may either be the name of one of an internal style or point
 
 # Configuration file for OSM data import.
 # This may either be the name of one of an internal style or point


@@ -192,7 +190,7 @@ NOMINATIM_MAPICON_URL=
 NOMINATIM_DEFAULT_LANGUAGE=
 
 # Enable a special batch query mode.
 NOMINATIM_DEFAULT_LANGUAGE=
 
 # Enable a special batch query mode.

-# This features is currently undocumented and potentially broken.
+# This feature is currently undocumented and potentially broken.

 NOMINATIM_SEARCH_BATCH_MODE=no
 
 # Threshold for searches by name only.
 NOMINATIM_SEARCH_BATCH_MODE=no
 
 # Threshold for searches by name only.