xref: /freebsd/usr.bin/logname/logname.1 (revision e627b39baccd1ec9129690167cf5e6d860509655)
1.\" Copyright (c) 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the Institute of Electrical and Electronics Engineers, Inc.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"	@(#)logname.1	8.1 (Berkeley) 6/9/93
36.\"
37.Dd "June 9, 1993"
38.Dt LOGNAME 1
39.Os BSD 4.4
40.Sh NAME
41.Nm logname
42.Nd display user's login name
43.Sh SYNOPSIS
44.Nm logname
45.Sh DESCRIPTION
46The
47.Nm logname
48utility writes the user's login name to standard output followed by
49a newline.
50.Pp
51The
52.Nm logname
53utility explicitly ignores the
54.Ev LOGNAME
55and
56.Ev USER
57environment variables
58because the environment cannot be trusted.
59.Pp
60The
61.Nm logname
62utility exits 0 on success, and >0 if an error occurs.
63.Sh SEE ALSO
64.Xr who 1 ,
65.Xr whoami 1 ,
66.Xr getlogin 2
67.Sh STANDARDS
68The
69.Nm logname
70function is expected to conform to
71.St -p1003.2 .
72.Sh HISTORY
73The
74.Nm
75command appears in
76.Bx 4.4 .
77