From c67ef7c1a12bb46e846c1b3dbda6acda1c6a5d30 Mon Sep 17 00:00:00 2001 From: Black-Hole1 Date: Mon, 31 Jul 2023 10:00:56 +0800 Subject: [PATCH] docs(env-file): improve document description Signed-off-by: Black-Hole1 --- docs/source/markdown/options/env-file.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/source/markdown/options/env-file.md b/docs/source/markdown/options/env-file.md index 428cb78582..467aa4a91d 100644 --- a/docs/source/markdown/options/env-file.md +++ b/docs/source/markdown/options/env-file.md @@ -4,4 +4,8 @@ ####> are applicable to all of those. #### **--env-file**=*file* -Read in a line-delimited file of environment variables. +Read the environment variables from the file, supporting prefix matching: `KEY*`, as well as multiline values in double quotes and single quotes, but not multiline values in backticks. +The env-file will ignore comments and empty lines. And spaces or tabs before and after the KEY. +If an invalid value is encountered, such as only an `=` sign, it will be skipped. If it is a prefix match (`KEY*`), all environment variables starting with KEY on the host machine will be loaded. +If it is only KEY (`KEY`), the KEY environment variable on the host machine will be loaded. +Compatible with the `export` syntax in **dotenv**, such as: `export KEY=bar`.