usr/src/man/man1/logname.1

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc.  All Rights Reserved
  46 .\"
  47 .TH LOGNAME 1 "Aug 11, 2009"
  48 .SH NAME
  49 logname \- return user's login name
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 \fB/usr/bin/logname\fR
  54 .fi
  55
  56 .SS "ksh93"
  57 .sp
  58 .LP
  59 \fBlogname\fR
  60 .SH DESCRIPTION
  61 .SS "/usr/bin/logname"
  62 .sp
  63 .LP
  64 The \fBlogname\fR utility writes the user's login name to standard output. The
  65 login name is the string that would be returned by the \fBgetlogin\fR(3C)
  66 function. Under the conditions where \fBgetlogin()\fR would fail, \fBlogname\fR
  67 will write a diagnostic message to standard error and exit with a non-zero exit
  68 status.
  69 .SS "ksh93"
  70 .sp
  71 .LP
  72 The \fBlogname\fR utility writes the user's login name to standard output. The
  73 login name is the string that would be returned by the \fBgetlogin\fR(3C)
  74 function. If \fBgetlogin()\fR does not return successfully, the name
  75 corresponding to the real user IDof the calling process is used instead.
  76 .SH ENVIRONMENT VARIABLES
  77 .sp
  78 .LP
  79 See \fBenviron\fR(5) for descriptions of the following environment variables
  80 that affect the execution of \fBlogname\fR: \fBLANG\fR, \fBLC_ALL\fR,
  81 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
  82 .SH EXIT STATUS
  83 .sp
  84 .LP
  85 The following error values are returned:
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB0\fR\fR
  90 .ad
  91 .RS 6n
  92 Successful completion.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fB>0\fR\fR
  99 .ad
 100 .RS 6n
 101 An error occurred.
 102 .RE
 103
 104 .SH FILES
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fB/etc/profile\fR\fR
 109 .ad
 110 .RS 18n
 111 environment for user at login time
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fB/var/adm/utmpx\fR\fR
 118 .ad
 119 .RS 18n
 120 user and accounting information
 121 .RE
 122
 123 .SH ATTRIBUTES
 124 .sp
 125 .LP
 126 See \fBattributes\fR(5) for descriptions of the following attributes:
 127 .sp
 128
 129 .sp
 130 .TS
 131 box;
 132 c | c
 133 l | l .
 134 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 135 _
 136 Interface Stability     Committed
 137 _
 138 Standard        See \fBstandards\fR(5).
 139 .TE
 140
 141 .SH SEE ALSO
 142 .sp
 143 .LP
 144 \fBenv\fR(1), \fBlogin\fR(1), \fBgetlogin\fR(3C), \fButmpx\fR(4),
 145 \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)