eefcc1bda4
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
58 lines
1.1 KiB
Markdown
58 lines
1.1 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: curl_getenv
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- getenv (3C)
|
|
---
|
|
|
|
# NAME
|
|
|
|
curl_getenv - return value for environment name
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
char *curl_getenv(const char *name);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
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 curl_free(3) the returned string when you are done with it.
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
char *width = curl_getenv("COLUMNS");
|
|
if(width) {
|
|
/* it was set! */
|
|
curl_free(width);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Always
|
|
|
|
# RETURN VALUE
|
|
|
|
A pointer to a null-terminated string or NULL if it failed to find the
|
|
specified name.
|
|
|
|
# NOTE
|
|
|
|
Under unix operating systems, there is no point in returning an allocated
|
|
memory, although other systems does not work properly if this is not done. The
|
|
unix implementation thus suffers slightly from the drawbacks of other systems.
|