Print this page 
2989 Eliminate use of LOGNAME_MAX in ON
1166 useradd have warning with name more 8 chars
Split Close
Expand all
Collapse all
          --- old/usr/src/man/man3c/getlogin.3c
          +++ new/usr/src/man/man3c/getlogin.3c
   1    1  '\" te
        2 +.\" Copyright (c) 2013 Gary Mills
   2    3  .\" Copyright (c) 2004 Sun Microsystems, Inc.  All Rights Reserved.
   3    4  .\" Copyright 1989 AT&T
   4    5  .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
   5    6  .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   6    7  .\" http://www.opengroup.org/bookstore/.
   7    8  .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   8    9  .\"  This notice shall appear on any product containing this material.
   9   10  .\" 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.
  10   11  .\" 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.
  11   12  .\" 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]
  12      -.TH GETLOGIN 3C "May 18, 2004"
       13 +.TH GETLOGIN 3C "May 25, 2013"
  13   14  .SH NAME
  14   15  getlogin, getlogin_r \- get login name
  15   16  .SH SYNOPSIS
  16   17  .LP
  17   18  .nf
  18   19  #include <unistd.h>
  19   20  
  20   21  \fBchar *\fR\fBgetlogin\fR(\fBvoid\fR);
  21   22  .fi
  22   23
↓ open down ↓ 12 lines elided ↑ open up ↑ 
  35   36  
  36   37  .SH DESCRIPTION
  37   38  .sp
  38   39  .LP
  39   40  The \fBgetlogin()\fR function returns a pointer to the login name as found in
  40   41  \fB/var/adm/utmpx\fR. It can be used in conjunction with \fBgetpwnam\fR(3C) to
  41   42  locate the correct password file entry when the same user \fBID\fR is shared by
  42   43  several login names.
  43   44  .sp
  44   45  .LP
       46 +The login name plus the terminating null byte can be up to 33 characters
       47 +in length.
       48 +Newly-compiled programs should use the \fBLOGIN_NAME_MAX\fR symbol,
       49 +defined in <\fBlimits.h\fR>, to size the buffer.
       50 +Older programs that call \fBgetlogin()\fR  expect only the legacy
       51 +9-character length.
       52 +These automatically link to a version of the \fBgetlogin()\fR functions that
       53 +truncates longer login names.
       54 +It's also possible to compile new programs that link to truncating versions
       55 +of these functions by defining \fB__USE_LEGACY_LOGNAME__\fR in the
       56 +compile environment.
       57 +.sp
       58 +.LP
       59 +Some older programs will correctly handle long login names returned
       60 +by the \fBgetlogin()\fR function.
       61 +For this case, the user compatibility library
       62 +\fB/usr/lib/getloginx.so.1\fR redirects to a version of the \fBgetlogin()\fR
       63 +function that returns the long name.
       64 +This library should be added to such an application
       65 +at runtime using \fBLD_PRELOAD\fR.
       66 +.sp
       67 +.LP
  45   68  If \fBgetlogin()\fR is called within a process that is not attached to a
  46   69  terminal, it returns a null pointer. The correct procedure for determining the
  47   70  login name is to call \fBcuserid\fR(3C), or to call \fBgetlogin()\fR and if it
  48   71  fails to call \fBgetpwuid\fR(3C).
  49   72  .sp
  50   73  .LP
  51   74  The \fBgetlogin_r()\fR function has the same functionality as \fBgetlogin()\fR
  52   75  except that the caller must supply a buffer \fIname\fR with length
  53   76  \fInamelen\fR to store the result.  The \fIname\fR buffer must be at least
  54      -\fB_POSIX_LOGIN_NAME_MAX\fR bytes in size (defined in <\fBlimits.h\fR>). The
       77 +\fBLOGIN_NAME_MAX\fR bytes in size (defined in <\fBlimits.h\fR>). The
  55   78  POSIX version (see \fBstandards\fR(5)) of \fBgetlogin_r()\fR takes a
  56   79  \fInamesize\fR parameter of type \fBsize_t\fR.
  57   80  .SH RETURN VALUES
  58   81  .sp
  59   82  .LP
  60   83  Upon successful completion, \fBgetlogin()\fR returns a pointer to the login
  61   84  name or a null pointer if the user's login name cannot be found.  Otherwise it
  62   85  returns a null pointer and sets \fBerrno\fR to indicate the error.
  63   86  .sp
  64   87  .LP
↓ open down ↓ 79 lines elided ↑ open up ↑ 
 144  167  .SH FILES
 145  168  .sp
 146  169  .ne 2
 147  170  .na
 148  171  \fB\fB/var/adm/utmpx\fR\fR
 149  172  .ad
 150  173  .RS 18n
 151  174  user access and administration information
 152  175  .RE
 153  176  
      177 +.sp
      178 +.ne 2
      179 +.na
      180 +\fB\fB/usr/lib/getloginx.so.1\fR\fR
      181 +.ad
      182 +.RS 18n
      183 +A compatibility library that returns long login names to older applications.
      184 +.RE
      185 +
      186 +.sp
      187 +.ne 2
      188 +.na
      189 +\fB\fB/usr/lib/64/getloginx.so.1\fR\fR
      190 +.ad
      191 +.RS 18n
      192 +A 64-bit compatibility library to return long login names.
      193 +.RE
      194 +
 154  195  .SH ATTRIBUTES
 155  196  .sp
 156  197  .LP
 157  198  See \fBattributes\fR(5) for descriptions of the following attributes:
 158  199  .sp
 159  200  
 160  201  .sp
 161  202  .TS
 162  203  box;
 163  204  c | c
↓ open down ↓ 29 lines elided ↑ open up ↑ 
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX