man2/vhangup.2

   1 .\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  26 .\"     Added notes on capability requirements
  27 .\"
  28 .TH VHANGUP 2 2021-03-22 "Linux" "Linux Programmer's Manual"
  29 .SH NAME
  30 vhangup \- virtually hangup the current terminal
  31 .SH SYNOPSIS
  32 .nf
  33 .B #include <unistd.h>
  34 .PP
  35 .B int vhangup(void);
  36 .fi
  37 .PP
  38 .RS -4
  39 Feature Test Macro Requirements for glibc (see
  40 .BR feature_test_macros (7)):
  41 .RE
  42 .PP
  43 .BR vhangup ():
  44 .nf
  45     Since glibc 2.21:
  46 .\"             commit 266865c0e7b79d4196e2cc393693463f03c90bd8
  47         _DEFAULT_SOURCE
  48     In glibc 2.19 and 2.20:
  49         _DEFAULT_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE < 500)
  50     Up to and including glibc 2.19:
  51         _BSD_SOURCE || (_XOPEN_SOURCE && _XOPEN_SOURCE < 500)
  52 .fi
  53 .SH DESCRIPTION
  54 .BR vhangup ()
  55 simulates a hangup on the current terminal.
  56 This call arranges for other
  57 users to have a \*(lqclean\*(rq terminal at login time.
  58 .SH RETURN VALUE
  59 On success, zero is returned.
  60 On error, \-1 is returned, and
  61 .I errno
  62 is set to indicate the error.
  63 .SH ERRORS
  64 .TP
  65 .B EPERM
  66 The calling process has insufficient privilege to call
  67 .BR vhangup ();
  68 the
  69 .B CAP_SYS_TTY_CONFIG
  70 capability is required.
  71 .SH CONFORMING TO
  72 This call is Linux-specific, and should not be used in programs
  73 intended to be portable.
  74 .SH SEE ALSO
  75 .BR init (1),
  76 .BR capabilities (7)