summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Gamari <ben@well-typed.com>2022-01-25 23:37:57 +0000
committerMarge Bot <ben+marge-bot@smart-cactus.org>2022-01-27 18:36:05 -0500
commit6cc6080c996291a3d481b415470c0361a50224a0 (patch)
tree8957b134a269edcc039057a8273274960a70f119
parent3cae7fde8a98ca3e3bb0ea2331d549b9906cfb0c (diff)
downloadhaskell-6cc6080c996291a3d481b415470c0361a50224a0.tar.gz
users-guide: Document GHC_CHARENC environment variable
As noted in #20963, this was introduced in 1b56c40578374a15b4a2593895710c68b0e2a717 but was no documentation was added at that point. Closes #20963.
-rw-r--r--docs/users_guide/using.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/users_guide/using.rst b/docs/users_guide/using.rst
index 179c34b079..ec62096cd1 100644
--- a/docs/users_guide/using.rst
+++ b/docs/users_guide/using.rst
@@ -1665,7 +1665,13 @@ Other environment variables
.. index::
single: environment variables
-GHC can also be configured using environment variables. Currently the only
-variable it supports is ``GHC_NO_UNICODE``, which, when set, disables Unicode
-output regardless of locale settings. ``GHC_NO_UNICODE`` can be set to anything
-+(event an empty string) to trigger this behaviour.
+GHC can also be configured using various environment variables.
+
+.. envvar:: GHC_NO_UNICODE
+
+ When non-empty, disables Unicode diagnostics output will be disabled of locale settings.
+
+.. envvar:: GHC_CHARENC
+
+ When set to ``UTF-8`` the compiler will always print UTF-8-encoded output, regardless
+ the current locale.