freebsd-nq/lib/libc/gen/ctermid.3

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)ctermid.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\"
.Dd October 1, 2011
.Dt CTERMID 3
.Os
.Sh NAME
.Nm ctermid
.Nd generate terminal pathname
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdio.h
.Ft char *
.Fn ctermid "char *buf"
.Ft char *
.Fn ctermid_r "char *buf"
.Sh DESCRIPTION
The
.Fn ctermid
function generates a string, that, when used as a pathname, refers to
the current controlling terminal of the calling process.
.Pp
If
.Fa buf
is the
.Dv NULL
pointer, a pointer to a static area is returned.
Otherwise, the pathname is copied into the memory referenced by
.Fa buf .
The argument
.Fa buf
is assumed to be at least
.Dv L_ctermid
(as defined in the include
file
.In stdio.h )
bytes long.
.Pp
The
.Fn ctermid_r
function
provides the same functionality as
.Fn ctermid
except that if
.Fa buf
is a
.Dv NULL
pointer,
.Dv NULL
is returned.
.Pp
If no suitable lookup of the controlling terminal name can be performed,
this implementation returns
.Ql /dev/tty .
.Sh RETURN VALUES
Upon successful completion, a
.Pf non- Dv NULL
pointer is returned.
Otherwise, a
.Dv NULL
pointer is returned and the global variable
.Va errno
is set to indicate the error.
.Sh ERRORS
The current implementation detects no error conditions.
.Sh SEE ALSO
.Xr ttyname 3
.Sh STANDARDS
The
.Fn ctermid
function conforms to
.St -p1003.1-88 .
.Sh BUGS
By default the
.Fn ctermid
function
writes all information to an internal static object.
Subsequent calls to
.Fn ctermid
will modify the same object.
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1990, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)ctermid.3 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
Reimplement ctermid(). Even though POSIX allows us to return simply /dev/tty as a pathname identifying the controlling terminal of the running process, it is nicer if this function were actually useful, by returning the actual pathname of the controlling terminal. Implement ctermid() by using the kern.devname sysctl to resolve the actual name of /dev/tty. Don't use devname(3), since it may return bogus strings like #C:0x123. 2011-10-01 12:19:48 +00:00			`.Dd October 1, 2011`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt CTERMID 3`
			`.Os`
			`.Sh NAME`
			`.Nm ctermid`
			`.Nd generate terminal pathname`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In stdio.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft char *`
			`.Fn ctermid "char *buf"`
Provide and document ctermid_r function. 1999-11-28 23:28:49 +00:00			`.Ft char *`
			`.Fn ctermid_r "char *buf"`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Fn ctermid`
			`function generates a string, that, when used as a pathname, refers to`
			`the current controlling terminal of the calling process.`
			`.Pp`
			`If`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Fa buf`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`is the`
			`.Dv NULL`
			`pointer, a pointer to a static area is returned.`
			`Otherwise, the pathname is copied into the memory referenced by`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Fa buf .`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`The argument`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Fa buf`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`is assumed to be at least`
			`.Dv L_ctermid`
			`(as defined in the include`
			`file`
mdoc(7): Use the new feature of the .In macro. 2003-09-08 19:57:22 +00:00			`.In stdio.h )`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`bytes long.`
			`.Pp`
mdoc(7) police: "The .Fn function". 2002-12-18 10:13:54 +00:00			`The`
Provide and document ctermid_r function. 1999-11-28 23:28:49 +00:00			`.Fn ctermid_r`
mdoc(7) police: "The .Fn function". 2002-12-18 10:13:54 +00:00			`function`
Provide and document ctermid_r function. 1999-11-28 23:28:49 +00:00			`provides the same functionality as`
			`.Fn ctermid`
			`except that if`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Fa buf`
Whitespace only change: trim trailing whitespace. 2000-10-30 13:23:19 +00:00			`is a`
Provide and document ctermid_r function. 1999-11-28 23:28:49 +00:00			`.Dv NULL`
Whitespace only change: trim trailing whitespace. 2000-10-30 13:23:19 +00:00			`pointer,`
Provide and document ctermid_r function. 1999-11-28 23:28:49 +00:00			`.Dv NULL`
			`is returned.`
			`.Pp`
Reimplement ctermid(). Even though POSIX allows us to return simply /dev/tty as a pathname identifying the controlling terminal of the running process, it is nicer if this function were actually useful, by returning the actual pathname of the controlling terminal. Implement ctermid() by using the kern.devname sysctl to resolve the actual name of /dev/tty. Don't use devname(3), since it may return bogus strings like #C:0x123. 2011-10-01 12:19:48 +00:00			`If no suitable lookup of the controlling terminal name can be performed,`
			`this implementation returns`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ql /dev/tty .`
			`.Sh RETURN VALUES`
			`Upon successful completion, a`
			`.Pf non- Dv NULL`
			`pointer is returned.`
			`Otherwise, a`
			`.Dv NULL`
			`pointer is returned and the global variable`
			`.Va errno`
			`is set to indicate the error.`
			`.Sh ERRORS`
			`The current implementation detects no error conditions.`
			`.Sh SEE ALSO`
			`.Xr ttyname 3`
			`.Sh STANDARDS`
			`The`
Added missing section numbers to a bunch of .Xr macros, or converted them into .Fn macros where appropriate. Also fixed up some minor formatting problems. 1996-03-27 20:49:07 +00:00			`.Fn ctermid`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`function conforms to`
			`.St -p1003.1-88 .`
			`.Sh BUGS`
			`By default the`
			`.Fn ctermid`
			`function`
			`writes all information to an internal static object.`
			`Subsequent calls to`
			`.Fn ctermid`
			`will modify the same object.`