[BACK]Return to environ.7 CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / share / man / man7

Annotation of src/share/man/man7/environ.7, Revision 1.25

1.25    ! wiz         1: .\"    $NetBSD: environ.7,v 1.24 2011/01/21 07:55:12 roy Exp $
1.3       jtc         2: .\"
                      3: .\" Copyright (c) 1983, 1990, 1993
                      4: .\"    The Regents of the University of California.  All rights reserved.
1.1       cgd         5: .\"
                      6: .\" Redistribution and use in source and binary forms, with or without
                      7: .\" modification, are permitted provided that the following conditions
                      8: .\" are met:
                      9: .\" 1. Redistributions of source code must retain the above copyright
                     10: .\"    notice, this list of conditions and the following disclaimer.
                     11: .\" 2. Redistributions in binary form must reproduce the above copyright
                     12: .\"    notice, this list of conditions and the following disclaimer in the
                     13: .\"    documentation and/or other materials provided with the distribution.
1.20      agc        14: .\" 3. Neither the name of the University nor the names of its contributors
1.1       cgd        15: .\"    may be used to endorse or promote products derived from this software
                     16: .\"    without specific prior written permission.
                     17: .\"
                     18: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     19: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     20: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     21: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     22: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     23: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     24: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     25: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     26: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     27: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     28: .\" SUCH DAMAGE.
                     29: .\"
1.3       jtc        30: .\"    @(#)environ.7   8.3 (Berkeley) 4/19/94
1.1       cgd        31: .\"
1.24      roy        32: .Dd January 21, 2011
1.1       cgd        33: .Dt ENVIRON 7
1.7       garbled    34: .Os
1.1       cgd        35: .Sh NAME
                     36: .Nm environ
1.6       fair       37: .Nd user process environment
1.1       cgd        38: .Sh SYNOPSIS
1.23      uwe        39: .Vt extern char ** Ns Dv environ ;
1.1       cgd        40: .Sh DESCRIPTION
                     41: An array of strings called the
1.6       fair       42: .Em environment
1.1       cgd        43: is made available by
1.6       fair       44: .Xr execve 2
                     45: when a process begins.
                     46: By convention these strings have the form
1.1       cgd        47: .Dq Ar name=value .
                     48: The following names are used by various commands:
1.23      uwe        49: .Bl -tag -width ".Ev LIBC_DIAGASSERT"
1.8       kleink     50: .It Ev AUDIOCTLDEVICE
                     51: The name of the audio control device to be used by
                     52: .Xr audioctl 1 ,
                     53: .Xr audioplay 1
                     54: and
                     55: .Xr audiorecord 1 .
                     56: .It Ev AUDIODEVICE
                     57: The name of the audio device to be used by
                     58: .Xr audioplay 1
                     59: and
                     60: .Xr audiorecord 1 .
1.3       jtc        61: .It Ev BLOCKSIZE
                     62: The size of the block units used by several commands, most notably
                     63: .Xr df 1 ,
                     64: .Xr du 1
                     65: and
                     66: .Xr ls 1 .
1.6       fair       67: .Ev BLOCKSIZE
                     68: may be specified in units of a byte by specifying a number,
1.9       enami      69: in units of a kilobyte by specifying a number followed by
1.23      uwe        70: .Ql K
1.9       enami      71: or
1.23      uwe        72: .Ql k ,
1.9       enami      73: in units of a megabyte by specifying a number followed by
1.23      uwe        74: .Ql M
1.9       enami      75: or
1.23      uwe        76: .Ql m
1.9       enami      77: and in units of a gigabyte by specifying a number followed
                     78: by
1.23      uwe        79: .Ql G
1.9       enami      80: or
1.23      uwe        81: .Ql g .
1.3       jtc        82: Sizes less than 512 bytes or greater than a gigabyte are ignored.
1.1       cgd        83: .It Ev EXINIT
                     84: A startup list of commands read by
1.6       fair       85: .Xr ex 1
1.1       cgd        86: and
1.6       fair       87: .Xr vi 1 .
1.1       cgd        88: .It Ev HOME
                     89: A user's login directory, set by
1.6       fair       90: .Xr login 1
1.1       cgd        91: from the password file
1.6       fair       92: .Xr passwd 5 .
1.18      lukem      93: .It Ev LANG
                     94: Default for all NLS categories.
                     95: Only used if
                     96: .Ev LC_ALL
                     97: or the environment variable for a particular NLS category
                     98: is not provided
                     99: .Ev ( LC_COLLATE ,
                    100: .Ev LC_CTYPE ,
                    101: .Ev LC_MESSAGES ,
                    102: .Ev LC_MONETARY ,
                    103: .Ev LC_NUMERIC ,
                    104: or
                    105: .Ev LC_TIME ) .
                    106: .It Ev LC_ALL
                    107: Override for all NLS categories.
                    108: If set, overrides the values of
                    109: .Ev LC_COLLATE ,
                    110: .Ev LC_CTYPE ,
                    111: .Ev LC_MESSAGES ,
                    112: .Ev LC_MONETARY ,
                    113: .Ev LC_NUMERIC ,
                    114: and
                    115: .Ev LC_TIME .
                    116: .It Ev LC_COLLATE
                    117: NLS string-collation order information.
                    118: .It Ev LC_CTYPE
                    119: NLS character classification, case conversion, and other character attributes.
                    120: .It Ev LC_MESSAGES
                    121: NLS format for affirmative and negative responses.
                    122: .It Ev LC_MONETARY
                    123: NLS rules and symbols for formatting monetary numeric information.
                    124: .It Ev LC_NUMERIC
                    125: NLS rules and symbols for formatting nonmonetary numeric information.
                    126: .It Ev LC_TIME
                    127: NLS rules and symbols for formatting time and date information.
1.10      lukem     128: .It Ev LIBC_DIAGASSERT
                    129: Control how the
                    130: .Fn _DIAGASSERT
                    131: macro (from
1.22      joerg     132: .In assert.h )
1.10      lukem     133: behaves once the assertion is raised.
                    134: Refer to
                    135: .Xr _DIAGASSERT 3
                    136: for more information.
1.21      kleink    137: .It Ev LOGNAME
                    138: The login name of the user.
1.10      lukem     139: .It Ev MALLOC_OPTIONS
                    140: Control the behaviour of the
                    141: .Fn malloc
                    142: function.
                    143: Refer to
                    144: .Xr malloc 3
                    145: for more information.
1.8       kleink    146: .It Ev MIXERDEVICE
                    147: The name of the audio mixer device to be used by
                    148: .Xr mixerctl 1 .
1.15      perry     149: .It Ev PAGER
                    150: The program used for paginating the output of several commands
                    151: such as
                    152: .Xr man 1 .
                    153: If null or not set, the standard pagination program
                    154: .Xr more 1
                    155: will be used.
1.1       cgd       156: .It Ev PATH
                    157: The sequence of directories, separated by colons, searched by
1.6       fair      158: .Xr csh 1 ,
                    159: .Xr sh 1 ,
                    160: .Xr system 3 ,
                    161: .Xr execvp 3 ,
1.1       cgd       162: etc, when looking for an executable file.
1.23      uwe       163: .Ev PATH
                    164: is set to
                    165: .Pp
                    166: .Dl /usr/bin:/bin:/usr/pkg/bin:/usr/local/bin
                    167: .Pp
1.9       enami     168: initially by
1.6       fair      169: .Xr login 1 .
1.1       cgd       170: .It Ev PRINTER
                    171: The name of the default printer to be used by
1.6       fair      172: .Xr lpr 1 ,
                    173: .Xr lpq 1 ,
1.1       cgd       174: and
1.6       fair      175: .Xr lprm 1 .
1.17      lukem     176: .It Ev RCMD_CMD
                    177: When using the
                    178: .Xr rcmd 3
                    179: function, this variable is used as the program to run instead of
                    180: .Xr rcmd 1 .
1.1       cgd       181: .It Ev SHELL
                    182: The full pathname of the user's login shell.
                    183: .It Ev TERM
                    184: The kind of terminal for which output is to be prepared.
                    185: This information is used by commands, such as
1.6       fair      186: .Xr nroff 1
1.14      wiz       187: .\" or
                    188: .\" .Xr plot 1
1.6       fair      189: which may exploit special terminal capabilities.
                    190: See
1.24      roy       191: .Pa /usr/share/misc/terminfo
                    192: .Pq Xr terminfo 5
1.1       cgd       193: for a list of terminal types.
                    194: .It Ev TERMCAP
1.23      uwe       195: The string describing the terminal in
                    196: .Ev TERM ,
                    197: or, if it begins with a
                    198: .Ql / ,
                    199: the name of the termcap file.
1.24      roy       200: This is only checked if
                    201: .Ev TERMINFO
                    202: is not set.
                    203: .It Ev TERMINFO
                    204: The string describing the terminal in
                    205: .Ev TERM ,
                    206: or, if it begins with a
                    207: .Ql / ,
                    208: the name of the terminfo file.
1.11      blymn     209: .It Ev TIMEFORMAT
                    210: A
                    211: .Xr strftime 3
1.12      wiz       212: format string that may be used by programs such as
1.11      blymn     213: .Xr dump 8
                    214: for formatting timestamps.
1.3       jtc       215: .It Ev TMPDIR
                    216: The directory in which to store temporary files.
                    217: Most applications use either
1.6       fair      218: .Pa /tmp
1.3       jtc       219: or
1.6       fair      220: .Pa /var/tmp .
1.3       jtc       221: Setting this variable will make them use another directory.
                    222: .It Ev TZ
                    223: The timezone to use when displaying dates.
                    224: The normal format is a pathname relative to
1.6       fair      225: .Pa /usr/share/zoneinfo .
1.3       jtc       226: For example, the command
1.23      uwe       227: .Pp
                    228: .Dl env TZ=US/Pacific date
                    229: .Pp
1.3       jtc       230: displays the current time in California.
                    231: See
                    232: .Xr tzset 3
                    233: for more information.
1.1       cgd       234: .It Ev USER
                    235: The login name of the user.
1.21      kleink    236: It is recommended that portable applications use
                    237: .Ev LOGNAME
                    238: instead.
1.1       cgd       239: .El
                    240: .Pp
                    241: Further names may be placed in the environment by the
1.6       fair      242: .Ic export
1.1       cgd       243: command and
                    244: .Ar name=value
                    245: arguments in
1.6       fair      246: .Xr sh 1 ,
1.1       cgd       247: or by the
1.6       fair      248: .Ic setenv
1.1       cgd       249: command if you use
1.6       fair      250: .Xr csh 1 .
1.1       cgd       251: It is unwise to change certain
1.6       fair      252: .Xr sh 1
1.1       cgd       253: variables that are frequently exported by
                    254: .Pa .profile
                    255: files, such as
                    256: .Ev MAIL ,
                    257: .Ev PS1 ,
                    258: .Ev PS2 ,
                    259: and
                    260: .Ev IFS ,
                    261: unless you know what you are doing.
                    262: .Sh SEE ALSO
1.8       kleink    263: .Xr audioctl 1 ,
                    264: .Xr audioplay 1 ,
                    265: .Xr audiorecord 1 ,
1.1       cgd       266: .Xr csh 1 ,
                    267: .Xr ex 1 ,
                    268: .Xr login 1 ,
1.15      perry     269: .Xr man 1 ,
                    270: .Xr more 1 ,
1.1       cgd       271: .Xr sh 1 ,
                    272: .Xr execve 2 ,
1.10      lukem     273: .Xr _DIAGASSERT 3 ,
1.1       cgd       274: .Xr execle 3 ,
1.10      lukem     275: .Xr malloc 3 ,
1.17      lukem     276: .Xr rcmd 3 ,
1.1       cgd       277: .Xr system 3 ,
                    278: .Xr termcap 3 ,
1.24      roy       279: .Xr terminfo 3 ,
1.8       kleink    280: .Xr audio 4 ,
1.25    ! wiz       281: .Xr terminfo 5 ,
1.18      lukem     282: .Xr nls 7 ,
1.11      blymn     283: .Xr dump 8
1.1       cgd       284: .Sh HISTORY
                    285: The
1.6       fair      286: .Nm
1.1       cgd       287: manual page appeared in
                    288: .Bx 4.2 .

CVSweb <webmaster@jp.NetBSD.org>