summaryrefslogtreecommitdiffstats
path: root/man1p/logname.1p
diff options
context:
space:
mode:
Diffstat (limited to 'man1p/logname.1p')
-rw-r--r--man1p/logname.1p129
1 files changed, 129 insertions, 0 deletions
diff --git a/man1p/logname.1p b/man1p/logname.1p
new file mode 100644
index 000000000..8c3b45246
--- /dev/null
+++ b/man1p/logname.1p
@@ -0,0 +1,129 @@
+.\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
+.TH "LOGNAME" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\" logname
+.SH NAME
+logname \- return the user's login name
+.SH SYNOPSIS
+.LP
+\fBlogname\fP
+.SH DESCRIPTION
+.LP
+The \fIlogname\fP utility shall write the user's login name to standard
+output. The login name shall be the string that would
+be returned by the \fIgetlogin\fP() function defined in the System
+Interfaces volume of
+IEEE\ Std\ 1003.1-2001. Under the conditions where the \fIgetlogin\fP()
+function
+would fail, the \fIlogname\fP utility shall write a diagnostic message
+to standard error and exit with a non-zero exit status.
+.SH OPTIONS
+.LP
+None.
+.SH OPERANDS
+.LP
+None.
+.SH STDIN
+.LP
+Not used.
+.SH INPUT FILES
+.LP
+None.
+.SH ENVIRONMENT VARIABLES
+.LP
+The following environment variables shall affect the execution of
+\fIlogname\fP:
+.TP 7
+\fILANG\fP
+Provide a default value for the internationalization variables that
+are unset or null. (See the Base Definitions volume of
+IEEE\ Std\ 1003.1-2001, Section 8.2, Internationalization Variables
+for
+the precedence of internationalization variables used to determine
+the values of locale categories.)
+.TP 7
+\fILC_ALL\fP
+If set to a non-empty string value, override the values of all the
+other internationalization variables.
+.TP 7
+\fILC_CTYPE\fP
+Determine the locale for the interpretation of sequences of bytes
+of text data as characters (for example, single-byte as
+opposed to multi-byte characters in arguments).
+.TP 7
+\fILC_MESSAGES\fP
+Determine the locale that should be used to affect the format and
+contents of diagnostic messages written to standard
+error.
+.TP 7
+\fINLSPATH\fP
+Determine the location of message catalogs for the processing of \fILC_MESSAGES
+\&.\fP
+.sp
+.SH ASYNCHRONOUS EVENTS
+.LP
+Default.
+.SH STDOUT
+.LP
+The \fIlogname\fP utility output shall be a single line consisting
+of the user's login name:
+.sp
+.RS
+.nf
+
+\fB"%s\\n", <\fP\fIlogin name\fP\fB>
+\fP
+.fi
+.RE
+.SH STDERR
+.LP
+The standard error shall be used only for diagnostic messages.
+.SH OUTPUT FILES
+.LP
+None.
+.SH EXTENDED DESCRIPTION
+.LP
+None.
+.SH EXIT STATUS
+.LP
+The following exit values shall be returned:
+.TP 7
+\ 0
+Successful completion.
+.TP 7
+>0
+An error occurred.
+.sp
+.SH CONSEQUENCES OF ERRORS
+.LP
+Default.
+.LP
+\fIThe following sections are informative.\fP
+.SH APPLICATION USAGE
+.LP
+The \fIlogname\fP utility explicitly ignores the \fILOGNAME\fP environment
+variable because environment changes could produce
+erroneous results.
+.SH EXAMPLES
+.LP
+None.
+.SH RATIONALE
+.LP
+The \fBpasswd\fP file is not listed as required because the implementation
+may have other means of mapping login names.
+.SH FUTURE DIRECTIONS
+.LP
+None.
+.SH SEE ALSO
+.LP
+\fIid\fP , \fIwho\fP , the System Interfaces volume of
+IEEE\ Std\ 1003.1-2001, \fIgetlogin\fP()
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group. In the
+event of any discrepancy between this version 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 .