logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

unlockpt.3p (2429B)


  1. '\" et
  2. .TH UNLOCKPT "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. unlockpt
  12. \(em unlock a pseudo-terminal master/slave pair
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <stdlib.h>
  17. .P
  18. int unlockpt(int \fIfildes\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. The
  22. \fIunlockpt\fR()
  23. function shall unlock the slave pseudo-terminal device associated with
  24. the master to which
  25. .IR fildes
  26. refers.
  27. .P
  28. Conforming applications shall ensure that they call
  29. \fIunlockpt\fR()
  30. before opening the slave side of a pseudo-terminal device.
  31. .SH "RETURN VALUE"
  32. Upon successful completion,
  33. \fIunlockpt\fR()
  34. shall return 0. Otherwise, it shall return \-1 and set
  35. .IR errno
  36. to indicate the error.
  37. .SH ERRORS
  38. The
  39. \fIunlockpt\fR()
  40. function may fail if:
  41. .TP
  42. .BR EBADF
  43. The
  44. .IR fildes
  45. argument is not a file descriptor open for writing.
  46. .TP
  47. .BR EINVAL
  48. The
  49. .IR fildes
  50. argument is not associated with a master pseudo-terminal device.
  51. .LP
  52. .IR "The following sections are informative."
  53. .SH EXAMPLES
  54. None.
  55. .SH "APPLICATION USAGE"
  56. None.
  57. .SH RATIONALE
  58. See the RATIONALE section for
  59. .IR "\fIposix_openpt\fR\^(\|)".
  60. .SH "FUTURE DIRECTIONS"
  61. None.
  62. .SH "SEE ALSO"
  63. .IR "\fIgrantpt\fR\^(\|)",
  64. .IR "\fIopen\fR\^(\|)",
  65. .IR "\fIposix_openpt\fR\^(\|)",
  66. .IR "\fIptsname\fR\^(\|)"
  67. .P
  68. The Base Definitions volume of POSIX.1\(hy2017,
  69. .IR "\fB<stdlib.h>\fP"
  70. .\"
  71. .SH COPYRIGHT
  72. Portions of this text are reprinted and reproduced in electronic form
  73. from IEEE Std 1003.1-2017, Standard for Information Technology
  74. -- Portable Operating System Interface (POSIX), The Open Group Base
  75. Specifications Issue 7, 2018 Edition,
  76. Copyright (C) 2018 by the Institute of
  77. Electrical and Electronics Engineers, Inc and The Open Group.
  78. In the event of any discrepancy between this version and the original IEEE and
  79. The Open Group Standard, the original IEEE and The Open Group Standard
  80. is the referee document. The original Standard can be obtained online at
  81. http://www.opengroup.org/unix/online.html .
  82. .PP
  83. Any typographical or formatting errors that appear
  84. in this page are most likely
  85. to have been introduced during the conversion of the source files to
  86. man page format. To report such errors, see
  87. https://www.kernel.org/doc/man-pages/reporting_bugs.html .