Print this page
Garrett's man page edits.

Split Close
Expand all
Collapse all
          --- old/usr/src/man/man5/environ.5
          +++ new/usr/src/man/man5/environ.5
   1    1  '\" te
   2    2  .\" Copyright 1989 AT&T
   3    3  .\" Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   4    4  .\" Copyright (c) 2014, Joyent, Inc.  All Rights Reserved
        5 +.\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
   5    6  .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6    7  .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7    8  .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8      -.TH ENVIRON 5 "Nov 19, 2002"
        9 +.TH ENVIRON 5 "Jun 26, 2014"
   9   10  .SH NAME
  10   11  environ \- user environment
  11   12  .SH DESCRIPTION
  12      -.sp
  13   13  .LP
  14   14  When a process begins execution, one of the \fBexec\fR family of functions
  15   15  makes available an array of strings called the environment; see \fBexec\fR(2).
  16   16  By convention, these strings have the form \fIvariable=value\fR, for example,
  17   17  \fBPATH=/sbin:/usr/sbin\fR. These environmental variables provide a way to make
  18   18  information about a program's environment available to programs.
  19      -.sp
  20   19  .LP
  21   20  A name may be placed in the environment by the \fBexport\fR command and
  22   21  \fIname\fR=\fIvalue\fR arguments in \fBsh\fR(1), or by one of the \fBexec\fR
  23   22  functions. It is unwise to conflict with certain shell variables such as
  24   23  \fBMAIL\fR, \fBPS1\fR, \fBPS2\fR, and \fBIFS\fR that are frequently exported by
  25   24  \fB\&.profile\fR files; see \fBprofile\fR(4).
  26      -.sp
  27   25  .LP
  28   26  The following environmental variables can be used by applications and are
  29   27  expected to be set in the target run-time environment.
  30   28  .sp
  31   29  .ne 2
  32   30  .na
  33   31  \fB\fBHOME\fR\fR
  34   32  .ad
  35   33  .sp .6
  36   34  .RS 4n
↓ open down ↓ 2 lines elided ↑ open up ↑
  39   37  .RE
  40   38  
  41   39  .sp
  42   40  .ne 2
  43   41  .na
  44   42  \fB\fBLANG\fR\fR
  45   43  .ad
  46   44  .sp .6
  47   45  .RS 4n
  48   46  The string used to specify internationalization information that allows users
  49      -to work with different national conventions. The \fBsetlocale\fR(3C) function
  50      -checks the \fBLANG\fR environment variable when it is called with \fB""\fR as
       47 +to work with different national conventions. The \fBsetlocale\fR(3C) and
       48 +\fBnewlocale\fR(3C) functions
       49 +check the \fBLANG\fR environment variable when they are called with \fB""\fR as
  51   50  the \fBlocale\fR argument.  \fBLANG\fR is used as the default locale if the
  52   51  corresponding environment variable for a particular category is unset or null.
  53   52  If, however,  \fBLC_ALL\fR is set to a valid, non-empty value, its contents are
  54   53  used to override both the \fBLANG\fR and the other \fBLC_*\fR variables. For
  55   54  example, when invoked as \fBsetlocale(LC_CTYPE, "")\fR, \fBsetlocale()\fR will
  56   55  query the \fBLC_CTYPE\fR environment variable first to see if it is set and
  57   56  non-null. If \fBLC_CTYPE\fR is not set or null, then \fBsetlocale()\fR will
  58   57  check the \fBLANG\fR environment variable to see if it is set and non-null. If
  59   58  both \fBLANG\fR and \fBLC_CTYPE\fR are unset or \fINULL\fR, the default "C"
  60   59  locale will be used to set the \fBLC_CTYPE\fR category.
  61   60  .sp
  62   61  Most commands will invoke \fBsetlocale(LC_ALL, "")\fR prior to any other
  63   62  processing. This allows the command to be used with different national
  64   63  conventions by setting the appropriate environment variables. In addition, some
  65   64  commands will use
  66   65  .BR uselocale (3C)
  67      -to set a specific locale for opertations performed in a single thread.
       66 +to set a thread-specific locale.
  68   67  .sp
  69   68  The following environment variables correspond to each category of
  70   69  \fBsetlocale\fR(3C):
  71   70  .sp
  72   71  .ne 2
  73   72  .na
  74   73  \fB\fBLC_ALL\fR\fR
  75   74  .ad
  76   75  .sp .6
  77   76  .RS 4n
↓ open down ↓ 3 lines elided ↑ open up ↑
  81   80  
  82   81  .sp
  83   82  .ne 2
  84   83  .na
  85   84  \fB\fBLC_COLLATE\fR\fR
  86   85  .ad
  87   86  .sp .6
  88   87  .RS 4n
  89   88  This category specifies the character collation sequence being used.  The
  90   89  information corresponding to this category is stored in a database  created by
  91      -the \fBlocaledef\fR(1) command.   This environment variable affects
       90 +the \fBlocaledef\fR(1) command.  This environment variable affects
  92   91  \fBstrcoll\fR(3C) and \fBstrxfrm\fR(3C).
  93   92  .RE
  94   93  
  95   94  .sp
  96   95  .ne 2
  97   96  .na
  98   97  \fB\fBLC_CTYPE\fR\fR
  99   98  .ad
 100   99  .sp .6
 101  100  .RS 4n
↓ open down ↓ 412 lines elided ↑ open up ↑
 514  513  these optional fields are not specified.
 515  514  .sp
 516  515  The \fItime\fR has the same format as \fIoffset\fR except that no leading sign
 517  516  ("-" or "+" ) is allowed. If \fItime\fR is not specified, the default value is
 518  517  02:00:00.
 519  518  .RE
 520  519  
 521  520  .RE
 522  521  
 523  522  .SH SEE ALSO
 524      -.sp
 525  523  .LP
 526  524  \fBcat\fR(1), \fBdate\fR(1), \fBed\fR(1), \fBfmtmsg\fR(1), \fBlocaledef\fR(1),
 527  525  \fBlogin\fR(1), \fBls\fR(1), \fBmkmsgs\fR(1), \fBnice\fR(1), \fBnohup\fR(1),
 528  526  \fBsh\fR(1), \fBsort\fR(1), \fBtime\fR(1), \fBvi\fR(1), \fBexec\fR(2),
 529  527  \fBaddseverity\fR(3C), \fBcatopen\fR(3C), \fBctime\fR(3C), \fBctype\fR(3C),
 530  528  \fBfmtmsg\fR(3C), \fBgetdate\fR(3C), \fBgetnetpath\fR(3NSL), \fBgettext\fR(3C),
 531  529  \fBgettxt\fR(3C), \fBlocaleconv\fR(3C), \fBmblen\fR(3C), \fBmktime\fR(3C),
      530 +\fBnewlocale\fR(3C),
 532  531  \fBprintf\fR(3C), \fBsetlocale\fR(3C), \fBstrcoll\fR(3C), \fBstrftime\fR(3C),
 533  532  \fBstrtod\fR(3C), \fBstrxfrm\fR(3C), \fBuselocale\fR(3C), \fBTIMEZONE\fR(4),
 534  533  \fBnetconfig\fR(4), \fBpasswd\fR(4), \fBprofile\fR(4)
    
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX