share/man/man1/logname.1

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Copyright (c) 1992, X/Open Company Limited  All Rights Reserved
   4 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc.  All Rights Reserved
   5 .\" 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  http://www.opengroup.org/bookstore/.
   6 .\" 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
   7 .\" 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
   8 .\" 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.
   9 .\"  This notice shall appear on any product containing this material.
  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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
  11 .\"  See the License for the specific language governing permissions and limitations under the License. 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
  12 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  13 .TH LOGNAME 1 "Aug 11, 2009"
  14 .SH NAME
  15 logname \- return user's login name
  16 .SH SYNOPSIS
  17 .LP
  18 .nf
  19 \fB/usr/bin/logname\fR
  20 .fi
  21
  22 .SS "ksh93"
  23 .sp
  24 .LP
  25 \fBlogname\fR
  26 .SH DESCRIPTION
  27 .SS "/usr/bin/logname"
  28 .sp
  29 .LP
  30 The \fBlogname\fR utility writes the user's login name to standard output. The
  31 login name is the string that would be returned by the \fBgetlogin\fR(3C)
  32 function. Under the conditions where \fBgetlogin()\fR would fail, \fBlogname\fR
  33 will write a diagnostic message to standard error and exit with a non-zero exit
  34 status.
  35 .SS "ksh93"
  36 .sp
  37 .LP
  38 The \fBlogname\fR utility writes the user's login name to standard output. The
  39 login name is the string that would be returned by the \fBgetlogin\fR(3C)
  40 function. If \fBgetlogin()\fR does not return successfully, the name
  41 corresponding to the real user IDof the calling process is used instead.
  42 .SH ENVIRONMENT VARIABLES
  43 .sp
  44 .LP
  45 See \fBenviron\fR(5) for descriptions of the following environment variables
  46 that affect the execution of \fBlogname\fR: \fBLANG\fR, \fBLC_ALL\fR,
  47 \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
  48 .SH EXIT STATUS
  49 .sp
  50 .LP
  51 The following error values are returned:
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB0\fR\fR
  56 .ad
  57 .RS 6n
  58 Successful completion.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fB>0\fR\fR
  65 .ad
  66 .RS 6n
  67 An error occurred.
  68 .RE
  69
  70 .SH FILES
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fB/etc/profile\fR\fR
  75 .ad
  76 .RS 18n
  77 environment for user at login time
  78 .RE
  79
  80 .sp
  81 .ne 2
  82 .na
  83 \fB\fB/var/adm/utmpx\fR\fR
  84 .ad
  85 .RS 18n
  86 user and accounting information
  87 .RE
  88
  89 .SH ATTRIBUTES
  90 .sp
  91 .LP
  92 See \fBattributes\fR(5) for descriptions of the following attributes:
  93 .sp
  94
  95 .sp
  96 .TS
  97 box;
  98 c | c
  99 l | l .
 100 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 101 _
 102 Interface Stability     Committed
 103 _
 104 Standard        See \fBstandards\fR(5).
 105 .TE
 106
 107 .SH SEE ALSO
 108 .sp
 109 .LP
 110 \fBenv\fR(1), \fBlogin\fR(1), \fBgetlogin\fR(3C), \fButmpx\fR(4),
 111 \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)