diff options
Diffstat (limited to 'static/freebsd/man7/environ.7 3.html')
| -rw-r--r-- | static/freebsd/man7/environ.7 3.html | 217 |
1 files changed, 217 insertions, 0 deletions
diff --git a/static/freebsd/man7/environ.7 3.html b/static/freebsd/man7/environ.7 3.html new file mode 100644 index 00000000..4fd735ca --- /dev/null +++ b/static/freebsd/man7/environ.7 3.html @@ -0,0 +1,217 @@ +<table class="head"> + <tr> + <td class="head-ltitle">ENVIRON(7)</td> + <td class="head-vol">Miscellaneous Information Manual</td> + <td class="head-rtitle">ENVIRON(7)</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">environ</code> — <span class="Nd">user + environment</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp"><var class="Ar">extern char **environ</var>;</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">An array of strings, called the <var class="Ar">environment</var> + is made available to each process by <a class="Xr">execve(2)</a> when a + process begins. By convention these strings have the form + <var class="Va">name</var><span class="No">=</span><var class="Ar">value</var>, + and are referred to as “environment variables”. A process can + query, update, and delete these strings using the + <a class="Xr">getenv(3)</a>, <a class="Xr">setenv(3)</a>, and + <a class="Xr">unsetenv(3)</a> functions, respectively. The shells also + provide commands to manipulate the environment; they are described in the + respective shell manual pages.</p> +<p class="Pp">What follows is a list of environment variables typically seen on + a <span class="Ux">UNIX</span> system. It includes only those variables that + a user can expect to see during their day-to-day use of the system, and is + far from complete. Environment variables specific to a particular program or + library function are documented in the + <a class="Sx" href="#ENVIRONMENT">ENVIRONMENT</a> section of the appropriate + manual page.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="ENVIRONMENT"><a class="permalink" href="#ENVIRONMENT">ENVIRONMENT</a></h1> +<dl class="Bl-tag"> + <dt id="ARCHLEVEL"><a class="permalink" href="#ARCHLEVEL"><code class="Ev">ARCHLEVEL</code></a></dt> + <dd>On + <a class="permalink" href="#amd64"><i class="Em" id="amd64">amd64</i></a>, + controls the level of SIMD enhancements used. See + <a class="Xr">simd(7)</a> for details.</dd> + <dt id="BLOCKSIZE"><a class="permalink" href="#BLOCKSIZE"><code class="Ev">BLOCKSIZE</code></a></dt> + <dd>The size of the block units used by several disk-related commands, most + notably <a class="Xr">df(1)</a>, <a class="Xr">du(1)</a> and + <a class="Xr">ls(1)</a>. <code class="Ev">BLOCKSIZE</code> may be + specified in units of a byte by specifying a number, in units of a + kilobyte by specifying a number followed by + ‘<code class="Li">K</code>’ or + ‘<code class="Li">k</code>’, in units of a megabyte by + specifying a number followed by ‘<code class="Li">M</code>’ + or ‘<code class="Li">m</code>’, and in units of a gigabyte + by specifying a number followed by + ‘<code class="Li">G</code>’ or + ‘<code class="Li">g</code>’. Sizes less than 512 bytes or + greater than a gigabyte are ignored. This variable is processed by the + <a class="Xr">getbsize(3)</a> function.</dd> + <dt id="COLUMNS"><a class="permalink" href="#COLUMNS"><code class="Ev">COLUMNS</code></a></dt> + <dd>The user's preferred width in column positions for the terminal. Utilities + such as <a class="Xr">ls(1)</a> and <a class="Xr">who(1)</a> use this to + format output into columns. If unset or empty, utilities will use an + <a class="Xr">ioctl(2)</a> call to ask the terminal driver for the + width.</dd> + <dt id="EDITOR"><a class="permalink" href="#EDITOR"><code class="Ev">EDITOR</code></a></dt> + <dd>Default editor name.</dd> + <dt id="EXINIT"><a class="permalink" href="#EXINIT"><code class="Ev">EXINIT</code></a></dt> + <dd>A startup list of commands read by <a class="Xr">ex(1)</a> and + <a class="Xr">vi(1)</a>.</dd> + <dt id="EXTERROR_VERBOSE"><a class="permalink" href="#EXTERROR_VERBOSE"><code class="Ev">EXTERROR_VERBOSE</code></a></dt> + <dd>Request the <a class="Xr">err(3)</a> and <a class="Xr">uexterr_gettext</a> + functions to unconditionally report additional information, mostly useful + for the (kernel) developer to diagnose the issue. See + <a class="Xr">err(3)</a> and <a class="Xr">exterror(9)</a> for more + details.</dd> + <dt id="HOME"><a class="permalink" href="#HOME"><code class="Ev">HOME</code></a></dt> + <dd>A user's login directory, set by <a class="Xr">login(1)</a> from the + password file <a class="Xr">passwd(5)</a>.</dd> + <dt id="LANG"><a class="permalink" href="#LANG"><code class="Ev">LANG</code></a></dt> + <dd>This variable configures all programs which use + <a class="Xr">setlocale(3)</a> to use the specified locale unless the + <code class="Ev">LC_*</code> variables are set.</dd> + <dt id="LC_ALL"><a class="permalink" href="#LC_ALL"><code class="Ev">LC_ALL</code></a></dt> + <dd>Overrides the values of <code class="Ev">LC_COLLATE</code>, + <code class="Ev">LC_CTYPE</code>, <code class="Ev">LC_MESSAGES</code>, + <code class="Ev">LC_MONETARY</code>, <code class="Ev">LC_NUMERIC</code>, + <code class="Ev">LC_TIME</code> and <code class="Ev">LANG</code>.</dd> + <dt id="LC_COLLATE"><a class="permalink" href="#LC_COLLATE"><code class="Ev">LC_COLLATE</code></a></dt> + <dd>Locale to be used for ordering of strings.</dd> + <dt id="LC_CTYPE"><a class="permalink" href="#LC_CTYPE"><code class="Ev">LC_CTYPE</code></a></dt> + <dd>Locale to be used for character classification (letter, space, digit, + etc.) and for interpreting byte sequences as multibyte characters.</dd> + <dt id="LC_MESSAGES"><a class="permalink" href="#LC_MESSAGES"><code class="Ev">LC_MESSAGES</code></a></dt> + <dd>Locale to be used for diagnostic messages.</dd> + <dt id="LC_MONETARY"><a class="permalink" href="#LC_MONETARY"><code class="Ev">LC_MONETARY</code></a></dt> + <dd>Locale to be used for interpreting monetary input and formatting + output.</dd> + <dt id="LC_NUMERIC"><a class="permalink" href="#LC_NUMERIC"><code class="Ev">LC_NUMERIC</code></a></dt> + <dd>Locale to be used for interpreting numeric input and formatting + output.</dd> + <dt id="LC_TIME"><a class="permalink" href="#LC_TIME"><code class="Ev">LC_TIME</code></a></dt> + <dd>Locale to be used for interpreting dates input and for formatting + output.</dd> + <dt id="MAIL"><a class="permalink" href="#MAIL"><code class="Ev">MAIL</code></a></dt> + <dd>The location of the user's mailbox instead of the default in /var/mail, + used by <a class="Xr">mail(1)</a>, <a class="Xr">sh(1)</a>, and many other + mail clients.</dd> + <dt id="MANPATH"><a class="permalink" href="#MANPATH"><code class="Ev">MANPATH</code></a></dt> + <dd>The sequence of directories, separated by colons, searched by + <a class="Xr">man(1)</a> when looking for manual pages.</dd> + <dt id="NLSPATH"><a class="permalink" href="#NLSPATH"><code class="Ev">NLSPATH</code></a></dt> + <dd>List of directories to be searched for the message catalog referred to by + <code class="Ev">LC_MESSAGES</code>. See + <a class="Xr">catopen(3)</a>.</dd> + <dt id="PAGER"><a class="permalink" href="#PAGER"><code class="Ev">PAGER</code></a></dt> + <dd>Default paginator program. The program specified by this variable is used + by <a class="Xr">mail(1)</a>, <a class="Xr">man(1)</a>, + <a class="Xr">ftp(1)</a>, etc, to display information which is longer than + the current display.</dd> + <dt id="PATH"><a class="permalink" href="#PATH"><code class="Ev">PATH</code></a></dt> + <dd>The sequence of directories, separated by colons, searched by + <a class="Xr">csh(1)</a>, <a class="Xr">sh(1)</a>, + <a class="Xr">system(3)</a>, <a class="Xr">execvp(3)</a>, etc, when + looking for an executable file. <code class="Ev">PATH</code> is set to + ``/usr/bin:/bin'' initially by <a class="Xr">login(1)</a>.</dd> + <dt id="POSIXLY_CORRECT"><a class="permalink" href="#POSIXLY_CORRECT"><code class="Ev">POSIXLY_CORRECT</code></a></dt> + <dd>When set to any value, this environment variable modifies the behaviour of + certain commands to (mostly) execute in a strictly POSIX-compliant + manner.</dd> + <dt id="PRINTER"><a class="permalink" href="#PRINTER"><code class="Ev">PRINTER</code></a></dt> + <dd>The name of the default printer to be used by <a class="Xr">lpr(1)</a>, + <a class="Xr">lpq(1)</a>, and <a class="Xr">lprm(1)</a>.</dd> + <dt id="PWD"><a class="permalink" href="#PWD"><code class="Ev">PWD</code></a></dt> + <dd>The current directory pathname.</dd> + <dt id="SHELL"><a class="permalink" href="#SHELL"><code class="Ev">SHELL</code></a></dt> + <dd>The full pathname of the user's login shell.</dd> + <dt id="TERM"><a class="permalink" href="#TERM"><code class="Ev">TERM</code></a></dt> + <dd>The kind of terminal for which output is to be prepared. This information + is used by commands, such as <a class="Xr">nroff(1)</a> + (<span class="Pa">ports/textproc/groff</span>) or + <a class="Xr">plot(1)</a> which may exploit special terminal capabilities. + See <span class="Pa">/usr/share/misc/termcap</span> + (<a class="Xr">termcap(5)</a>) for a list of terminal types.</dd> + <dt id="TERMCAP"><a class="permalink" href="#TERMCAP"><code class="Ev">TERMCAP</code></a></dt> + <dd>The string describing the terminal in <code class="Ev">TERM</code>, or, if + it begins with a '/', the name of the termcap file. See + <code class="Ev">TERMPATH</code> below, and + <a class="Xr">termcap(5)</a>.</dd> + <dt id="TERMPATH"><a class="permalink" href="#TERMPATH"><code class="Ev">TERMPATH</code></a></dt> + <dd>A sequence of pathnames of termcap files, separated by colons or spaces, + which are searched for terminal descriptions in the order listed. Having + no <code class="Ev">TERMPATH</code> is equivalent to a + <code class="Ev">TERMPATH</code> of + <span class="Pa">$HOME/.termcap:/etc/termcap</span>. + <code class="Ev">TERMPATH</code> is ignored if + <code class="Ev">TERMCAP</code> contains a full pathname.</dd> + <dt id="TMPDIR"><a class="permalink" href="#TMPDIR"><code class="Ev">TMPDIR</code></a></dt> + <dd>The directory in which to store temporary files. Most applications use + either <span class="Pa">/tmp</span> or <span class="Pa">/var/tmp</span>. + Setting this variable will make them use another directory.</dd> + <dt id="TZ"><a class="permalink" href="#TZ"><code class="Ev">TZ</code></a></dt> + <dd>The timezone to use when displaying dates. The normal format is a pathname + relative to <span class="Pa">/usr/share/zoneinfo</span>. For example, the + command + <p class="Pp"></p> + <div class="Bd Bd-indent"><code class="Li">env TZ=America/Los_Angeles + date</code></div> + <p class="Pp">displays the current time in California. See + <a class="Xr">tzset(3)</a> for more information.</p> + </dd> + <dt id="USER"><a class="permalink" href="#USER"><code class="Ev">USER</code></a></dt> + <dd>The login name of the user. It is recommended that portable applications + use <code class="Ev">LOGNAME</code> instead.</dd> +</dl> +<p class="Pp">Further names may be placed in the environment by the + <code class="Ic">export</code> command and <var class="Ar">name=value</var> + arguments in <a class="Xr">sh(1)</a>, or by the + <code class="Ic">setenv</code> command if you use <a class="Xr">csh(1)</a>. + It is unwise to change certain <a class="Xr">sh(1)</a> variables that are + frequently exported by <span class="Pa">.profile</span> files, such as + <code class="Ev">MAIL</code>, <code class="Ev">PS1</code>, + <code class="Ev">PS2</code>, and <code class="Ev">IFS</code>, unless you + know what you are doing.</p> +<p class="Pp">The current environment variables can be printed with + <a class="Xr">env(1)</a>, <a class="Xr">set(1)</a> or + <a class="Xr">printenv(1)</a> in <a class="Xr">sh(1)</a> and + <a class="Xr">env(1)</a>, <a class="Xr">printenv(1)</a> or the + <code class="Cm">printenv</code> built-in command in + <a class="Xr">csh(1)</a>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">cd(1)</a>, <a class="Xr">csh(1)</a>, + <a class="Xr">env(1)</a>, <a class="Xr">err(3)</a>, <a class="Xr">ex(1)</a>, + <a class="Xr">login(1)</a>, <a class="Xr">printenv(1)</a>, + <a class="Xr">sh(1)</a>, <a class="Xr">execve(2)</a>, + <a class="Xr">execle(3)</a>, <a class="Xr">getbsize(3)</a>, + <a class="Xr">getenv(3)</a>, <a class="Xr">setenv(3)</a>, + <a class="Xr">setlocale(3)</a>, <a class="Xr">system(3)</a>, + <a class="Xr">termcap(3)</a>, <a class="Xr">termcap(5)</a>, + <a class="Xr">simd(7)</a>, <a class="Xr">exterror(9)</a></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Nm">environ</code> manual page appeared in + <span class="Ux">Version 7 AT&T UNIX</span>.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">September 3, 2023</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |