diff options
Diffstat (limited to 'static/freebsd/man9/getenv.9 4.html')
| -rw-r--r-- | static/freebsd/man9/getenv.9 4.html | 231 |
1 files changed, 0 insertions, 231 deletions
diff --git a/static/freebsd/man9/getenv.9 4.html b/static/freebsd/man9/getenv.9 4.html deleted file mode 100644 index 889c8db7..00000000 --- a/static/freebsd/man9/getenv.9 4.html +++ /dev/null @@ -1,231 +0,0 @@ -<table class="head"> - <tr> - <td class="head-ltitle">GETENV(9)</td> - <td class="head-vol">Kernel Developer's Manual</td> - <td class="head-rtitle">GETENV(9)</td> - </tr> -</table> -<div class="manual-text"> -<section class="Sh"> -<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> -<p class="Pp"><code class="Nm">freeenv</code>, - <code class="Nm">kern_getenv</code>, <code class="Nm">getenv_int</code>, - <code class="Nm">getenv_long</code>, <code class="Nm">getenv_string</code>, - <code class="Nm">getenv_quad</code>, <code class="Nm">getenv_uint</code>, - <code class="Nm">getenv_ulong</code>, <code class="Nm">getenv_bool</code>, - <code class="Nm">getenv_is_true</code>, - <code class="Nm">getenv_is_false</code>, - <code class="Nm">kern_setenv</code>, <code class="Nm">testenv</code>, - <code class="Nm">kern_unsetenv</code> — <span class="Nd">kernel - environment variable functions</span></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> -<p class="Pp"><code class="In">#include - <<a class="In">sys/param.h</a>></code> - <br/> - <code class="In">#include <<a class="In">sys/systm.h</a>></code></p> -<p class="Pp"><var class="Ft">void</var> - <br/> - <code class="Fn">freeenv</code>(<var class="Fa" style="white-space: nowrap;">char - *env</var>);</p> -<p class="Pp"><var class="Ft">char *</var> - <br/> - <code class="Fn">kern_getenv</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">getenv_int</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>, <var class="Fa" style="white-space: nowrap;">int - *data</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">getenv_long</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>, <var class="Fa" style="white-space: nowrap;">long - *data</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">getenv_string</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>, <var class="Fa" style="white-space: nowrap;">char - *data</var>, <var class="Fa" style="white-space: nowrap;">int - size</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">getenv_quad</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>, <var class="Fa" style="white-space: nowrap;">quad_t - *data</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">getenv_uint</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>, <var class="Fa" style="white-space: nowrap;">unsigned int - *data</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">getenv_ulong</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>, <var class="Fa" style="white-space: nowrap;">unsigned long - *data</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">getenv_bool</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>, <var class="Fa" style="white-space: nowrap;">bool - *data</var>);</p> -<p class="Pp"><var class="Ft">bool</var> - <br/> - <code class="Fn">getenv_is_true</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>);</p> -<p class="Pp"><var class="Ft">bool</var> - <br/> - <code class="Fn">getenv_is_false</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">kern_setenv</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>, <var class="Fa" style="white-space: nowrap;">const char - *value</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">testenv</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>);</p> -<p class="Pp"><var class="Ft">int</var> - <br/> - <code class="Fn">kern_unsetenv</code>(<var class="Fa" style="white-space: nowrap;">const - char *name</var>);</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<p class="Pp">These functions set, unset, fetch, and parse variables from the - kernel's environment.</p> -<p class="Pp" id="kern_getenv">The - <a class="permalink" href="#kern_getenv"><code class="Fn">kern_getenv</code></a>() - function obtains the current value of the kernel environment variable - <var class="Fa">name</var> and returns a pointer to the string value. The - caller should not modify the string pointed to by the return value. The - <code class="Fn">kern_getenv</code>() function may allocate temporary - storage, so the <code class="Fn">freeenv</code>() function must be called to - release any allocated resources when the value returned by - <code class="Fn">kern_getenv</code>() is no longer needed.</p> -<p class="Pp" id="freeenv">The - <a class="permalink" href="#freeenv"><code class="Fn">freeenv</code></a>() - function is used to release the resources allocated by a previous call to - <code class="Fn">kern_getenv</code>(). The <var class="Fa">env</var> - argument passed to <code class="Fn">freeenv</code>() is the pointer returned - by the earlier call to <code class="Fn">kern_getenv</code>(). Like - <a class="Xr">free(3)</a>, the <var class="Fa">env</var> argument can be - <var class="Va">NULL</var>, in which case no action occurs.</p> -<p class="Pp" id="kern_setenv">The - <a class="permalink" href="#kern_setenv"><code class="Fn">kern_setenv</code></a>() - function inserts or resets the kernel environment variable - <var class="Fa">name</var> to <var class="Fa">value</var>. If the variable - <var class="Fa">name</var> already exists, its value is replaced. This - function can fail if an internal limit on the number of environment - variables is exceeded.</p> -<p class="Pp" id="kern_unsetenv">The - <a class="permalink" href="#kern_unsetenv"><code class="Fn">kern_unsetenv</code></a>() - function deletes the kernel environment variable - <var class="Fa">name</var>.</p> -<p class="Pp" id="testenv">The - <a class="permalink" href="#testenv"><code class="Fn">testenv</code></a>() - function is used to determine if a kernel environment variable exists. It - returns a non-zero value if the variable <var class="Fa">name</var> exists - and zero if it does not.</p> -<p class="Pp" id="getenv_int">The - <a class="permalink" href="#getenv_int"><code class="Fn">getenv_int</code></a>(), - <a class="permalink" href="#getenv_long"><code class="Fn" id="getenv_long">getenv_long</code></a>(), - <a class="permalink" href="#getenv_quad"><code class="Fn" id="getenv_quad">getenv_quad</code></a>(), - <a class="permalink" href="#getenv_uint"><code class="Fn" id="getenv_uint">getenv_uint</code></a>(), - and - <a class="permalink" href="#getenv_ulong"><code class="Fn" id="getenv_ulong">getenv_ulong</code></a>() - functions look for a kernel environment variable <var class="Fa">name</var> - 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 <var class="Fa">name</var> 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 - <var class="Fa">data</var>. If the parsed value overflows the integer type, - a truncated value is stored in <var class="Fa">data</var> 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:</p> -<table class="Bl-column Bd-indent"> - <tr id="Unit"> - <td><a class="permalink" href="#Unit"><b class="Sy">Unit</b></a></td> - <td><a class="permalink" href="#Magnitude"><b class="Sy" id="Magnitude">Magnitude</b></a></td> - </tr> - <tr> - <td>k</td> - <td>2^10</td> - </tr> - <tr> - <td>m</td> - <td>2^20</td> - </tr> - <tr> - <td>g</td> - <td>2^30</td> - </tr> - <tr> - <td>t</td> - <td>2^40</td> - </tr> -</table> -<p class="Pp" id="getenv_string">The - <a class="permalink" href="#getenv_string"><code class="Fn">getenv_string</code></a>() - function stores a copy of the kernel environment variable - <var class="Fa">name</var> in the buffer described by - <var class="Fa">data</var> and <var class="Fa">size</var>. If the variable - does not exist, zero is returned. If the variable exists, up to - <var class="Fa">size - 1</var> characters of its value are copied to the - buffer pointed to by <var class="Fa">data</var> followed by a null character - and a non-zero value is returned.</p> -<p class="Pp" id="getenv_bool">The - <a class="permalink" href="#getenv_bool"><code class="Fn">getenv_bool</code></a>() - function interprets the value of the kernel environment variable - <var class="Fa">name</var> as a boolean value by performing a - case-insensitive comparison against the strings "1", - "0", "true", and "false". If the environment - variable exists and has a valid boolean value, then that value will be - copied to the variable pointed to by <var class="Fa">data</var>. If the - environment variable exists but is not a boolean value, then a warning will - be printed to the kernel message buffer. The - <a class="permalink" href="#getenv_is_true"><code class="Fn" id="getenv_is_true">getenv_is_true</code></a>() - and - <a class="permalink" href="#getenv_is_false"><code class="Fn" id="getenv_is_false">getenv_is_false</code></a>() - functions are wrappers around <code class="Fn">getenv_bool</code>() that - simplify testing for a desired boolean value.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN - VALUES</a></h1> -<p class="Pp">The <code class="Fn">kern_getenv</code>() function returns a - pointer to an environment variable's value on success or - <code class="Dv">NULL</code> if the variable does not exist.</p> -<p class="Pp">The <code class="Fn">kern_setenv</code>() and - <code class="Fn">kern_unsetenv</code>() functions return zero on success and - -1 on failure.</p> -<p class="Pp">The <code class="Fn">testenv</code>() function returns zero if the - specified environment variable does not exist and a non-zero value if it - does exist.</p> -<p class="Pp">The <code class="Fn">getenv_int</code>(), - <code class="Fn">getenv_long</code>(), - <code class="Fn">getenv_string</code>(), - <code class="Fn">getenv_quad</code>(), - <code class="Fn">getenv_uint</code>(), - <code class="Fn">getenv_ulong</code>(), and - <code class="Fn">getenv_bool</code>() functions return a non-zero value on - success and zero on failure.</p> -<p class="Pp">The <code class="Fn">getenv_is_true</code>() and - <code class="Fn">getenv_is_false</code>() functions return - <code class="Dv">true</code> if the specified environment variable exists - and its value matches the desired boolean condition, and - <code class="Dv">false</code> otherwise.</p> -</section> -</div> -<table class="foot"> - <tr> - <td class="foot-date">September 21, 2020</td> - <td class="foot-os">FreeBSD 15.0</td> - </tr> -</table> |