romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-04-14 21:31:42 +03:00
Code Issues Projects Releases Packages Wiki Activity

docs: reword explanation of --variable option

Browse source 
Simplify the language expaining the --variable option, reducing
repetition. Also fix some minor grammar issues and makes language for
examples more consistent.

Closes #20636
This commit is contained in:
Anna Liberty 2026-02-19 12:23:04 -08:00 • committed by Viktor Szakats
parent aa1854a8ff
commit 3699976b79
No known key found for this signature in database
1 changed files with 9 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/cmdline-opts/_VARIABLES.md
View file

@ -11,23 +11,22 @@ variable `name` inserted, or a blank if the name does not exist as a
variable. Insert `{{` verbatim in the string by prefixing it with a backslash,
like `\{{`.
You access and expand environment variables by first importing them. You
select to either require the environment variable to be set or you can provide
a default value in case it is not already set. Plain `--variable %name`
imports the variable called `name` but exits with an error if that environment
variable is not already set. To provide a default value if it is not set, use
`--variable %name=content` or `--variable %name@content`.
You can access and expand environment variables by importing them with
`--variable %name`. This imports the variable called `name` but exits with an
error if that environment variable is not already set. To provide a default
value in case it is not already set, use `--variable %name=content` or
`--variable %name@content`.
Example. Get the USER environment variable into the URL, fail if USER is not
set:
Example: get the USER environment variable and expand into the URL, fail if
USER is not set:
--variable '%USER'
--expand-url = "https://example.com/api/{{USER}}/method"
When expanding variables, curl supports a set of functions that can make the
variable contents more convenient to use. It can trim leading and trailing
white space with `trim`, it can output the contents as a JSON quoted string
with `json`, URL encode the string with `url`, base64 encode it with `b64` and
white space with `trim`, output the contents as a JSON quoted string with
`json`, URL encode the string with `url`, base64 encode it with `b64` and
base64 decode it with `64dec`. To apply functions to a variable expansion, add
them colon separated to the right side of the variable. Variable content
holding null bytes that are not encoded when expanded causes an error.