aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/curl_getenv.3
diff options
context:
space:
mode:
Diffstat (limited to 'docs/libcurl/curl_getenv.3')
-rw-r--r--docs/libcurl/curl_getenv.316
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/libcurl/curl_getenv.3 b/docs/libcurl/curl_getenv.3
index d8b458254..1ec6c66d4 100644
--- a/docs/libcurl/curl_getenv.3
+++ b/docs/libcurl/curl_getenv.3
@@ -19,7 +19,7 @@
.\" * KIND, either express or implied.
.\" *
.\" **************************************************************************
-.TH curl_getenv 3 "December 31, 2020" "libcurl 7.78.0" "libcurl Manual"
+.TH curl_getenv 3 "October 31, 2021" "libcurl 7.80.0" "libcurl Manual"
.SH NAME
curl_getenv - return value for environment name
@@ -33,7 +33,15 @@ curl_getenv() is a portable wrapper for the getenv() function, meant to
emulate its behavior and provide an identical interface for all operating
systems libcurl builds on (including win32).
-You must \fIcurl_free(3)\fP the returned string when you're done with it.
+You must \fIcurl_free(3)\fP the returned string when you are done with it.
+.SH EXAMPLE
+.nf
+ char *width = curl_getenv("COLUMNS");
+ if(width) {
+ /* it was set! */
+ curl_free(width);
+ }
+.fi
.SH AVAILABILITY
This function will be removed from the public libcurl API in a near future. It
will instead be made "available" by source code access only, and then as
@@ -42,8 +50,8 @@ curlx_getenv().
A pointer to a null-terminated string or NULL if it failed to find the
specified name.
.SH NOTE
-Under unix operating systems, there isn't any point in returning an allocated
-memory, although other systems won't work properly if this isn't done. The
+Under unix operating systems, there is no point in returning an allocated
+memory, although other systems will not work properly if this is not done. The
unix implementation thus has to suffer slightly from the drawbacks of other
systems.
.SH "SEE ALSO"