freeenv(9freebsd)
NAME
freeenv, getenv, getenv_int, getenv_long, getenv_string, getenv_quad,
getenv_uint, getenv_ulong, setenv, testenv, unsetenv --- kernel environment
variable functions
SYNOPSIS
#include <sys/param.h>
#include <sys/systm.h>
void
freeenv(char *env);
char *
getenv(const char *name);
int
getenv_int(const char *name, int *data);
int
getenv_long(const char *name, long *data);
int
getenv_string(const char *name, char *data, int size);
int
getenv_quad(const char *name, quad_t *data);
int
getenv_uint(const char *name, unsigned int *data);
int
getenv_ulong(const char *name, unsigned long *data);
int
setenv(const char *name, const char *value);
int
testenv(const char *name);
int
unsetenv(const char *name);
DESCRIPTION
These functions set, unset, fetch, and parse variables from the kernel's
environment.
The getenv() function obtains the current value of the kernel environment
variable name and returns a pointer to the string value. The caller
should not modify the string pointed to by the return value. The
getenv() function may allocate temporary storage, so the freeenv()
function must be called to release any allocated resources when the value
returned by getenv() is no longer needed.
The freeenv() function is used to release the resources allocated by a
previous call to getenv(). The env argument passed to freeenv() is the
pointer returned by the earlier call to getenv(). Like free(3), the env
argument can be NULL, in which case no action occurs.
The setenv() function inserts or resets the kernel environment variable
name to value. If the variable name already exists, its value is
replaced. This function can fail if an internal limit on the number of
environment variables is exceeded.
The unsetenv() function deletes the kernel environment variable name.
The testenv() function is used to determine if a kernel environment
variable exists. It returns a non-zero value if the variable name exists
and zero if it does not.
The getenv_int(), getenv_long(), getenv_quad(), getenv_uint(), and
getenv_ulong() functions look for a kernel environment variable name and
parse it as a signed integer, long integer, signed 64-bit integer,
unsigned integer, or an unsigned long integer, respectively. These
functions fail and return zero if name does not exist or if any invalid
characters are present in its value. On success, these function store
the parsed value in the integer variable pointed to by data. If the
parsed value overflows the integer type, a truncated value is stored in
data and zero is returned. If the value begins with a prefix of "0x" it
is interpreted as hexadecimal. If it begins with a prefix of "0" it is
interpreted as octal. Otherwise, the value is interpreted as decimal.
The value may contain a single character suffix specifying a unit for the
value. The interpreted value is multiplied by the unit's magnitude
before being returned. The following unit suffixes are supported:
Unit Magnitude
k 2^10
m 2^20
g 2^30
t 2^40
The getenv_string() function stores a copy of the kernel environment
variable name in the buffer described by data and size. If the variable
does not exist, zero is returned. If the variable exists, up to size - 1
characters of its value are copied to the buffer pointed to by data
followed by a null character and a non-zero value is returned.
RETURN VALUES
The getenv() function returns a pointer to an environment variable's
value on success or NULL if the variable does not exist.
The setenv() and unsetenv() functions return zero on success and -1 on
failure.
The testenv() function returns zero if the specified environment variable
does not exist and a non-zero value if it does exist. The getenv_int(),
getenv_long(), getenv_string(), getenv_quad(), getenv_uint(), and
getenv_ulong() functions return a non-zero value on success and zero on
failure.
Opportunity
Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.
Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.
Free Software
Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.
Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.
Free Books
The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.
Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.
Education
Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.
Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.
