1.\" $OpenBSD: ctermid.3,v 1.10 2014/01/21 03:15:45 schwarze Exp $ 2.\" 3.\" Copyright (c) 1990, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. Neither the name of the University nor the names of its contributors 15.\" may be used to endorse or promote products derived from this software 16.\" without specific prior written permission. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.Dd $Mdocdate: January 21 2014 $ 31.Dt CTERMID 3 32.Os 33.Sh NAME 34.Nm ctermid 35.Nd generate terminal pathname 36.Sh SYNOPSIS 37.In stdio.h 38.Ft char * 39.Fn ctermid "char *buf" 40.Sh DESCRIPTION 41The 42.Fn ctermid 43function generates a string that, when used as a pathname, refers to 44the current controlling terminal of the calling process. 45.Pp 46If 47.Ar buf 48is a null pointer, a pointer to a static area is returned. 49Otherwise, the pathname is copied into the memory referenced by 50.Ar buf . 51The argument 52.Ar buf 53is assumed to point to an array at least 54.Dv L_ctermid 55(as defined in the include 56file 57.In stdio.h ) 58bytes long. 59.Pp 60The current implementation simply generates 61.Qq /dev/tty . 62.Sh RETURN VALUES 63The 64.Fn ctermid 65function returns a non-null pointer, which is equal to the 66.Ar buf 67argument if it is not 68.Dv NULL . 69.Sh ERRORS 70The current implementation detects no error conditions. 71.Sh SEE ALSO 72.Xr ttyname 3 73.Sh STANDARDS 74The 75.Fn ctermid 76function conforms to 77.St -p1003.1-88 . 78