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

sys_ipc.h.0p (2921B)

    

  1. '\" et
  2. .TH sys_ipc.h "0P" 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. sys/ipc.h
  12. \(em XSI interprocess communication access structure
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <sys/ipc.h>
  17. .fi
  18. .SH DESCRIPTION
  19. The
  20. .IR <sys/ipc.h> 
  21. header is used by three mechanisms for XSI interprocess communication
  22. (IPC):
  23. messages, semaphores, and shared memory. All use a common structure
  24. type,
  25. .BR ipc_perm ,
  26. to pass information used in determining permission to perform an IPC
  27. operation.
  28. .P
  29. The
  30. .IR <sys/ipc.h> 
  31. header shall define the
  32. .BR ipc_perm
  33. structure, which shall include the following members:
  34. .sp
  35. .RS 4
  36. .nf
  38. uid_t    uid    \fROwner's user ID.\fR
  39. gid_t    gid    \fROwner's group ID.\fR
  40. uid_t    cuid   \fRCreator's user ID.\fR
  41. gid_t    cgid   \fRCreator's group ID.\fR
  42. mode_t   mode   \fRRead/write permission.\fR
  43. .fi
  44. .P
  45. .RE
  46. .P
  47. The
  48. .IR <sys/ipc.h> 
  49. header shall define the
  50. .BR uid_t ,
  51. .BR gid_t ,
  52. .BR mode_t ,
  53. and
  54. .BR key_t
  55. types as described in
  56. .IR <sys/types.h> .
  57. .P
  58. The
  59. .IR <sys/ipc.h> 
  60. header shall define the following symbolic constants.
  61. .P
  62. Mode bits:
  63. .IP IPC_CREAT 12
  64. Create entry if key does not exist.
  65. .IP IPC_EXCL 12
  66. Fail if key exists.
  67. .IP IPC_NOWAIT 12
  68. Error if request must wait.
  69. .P
  70. Keys:
  71. .IP IPC_PRIVATE 12
  72. Private key.
  73. .P
  74. Control commands:
  75. .IP IPC_RMID 12
  76. Remove identifier.
  77. .IP IPC_SET 12
  78. Set options.
  79. .IP IPC_STAT 12
  80. Get options.
  81. .P
  82. The following shall be declared as a function and may also be defined
  83. as a macro. A function prototype shall be provided.
  84. .sp
  85. .RS 4
  86. .nf
  88. key_t  ftok(const char *, int);
  89. .fi
  90. .P
  91. .RE
  92. .LP
  93. .IR "The following sections are informative."
  94. .SH "APPLICATION USAGE"
  95. None.
  96. .SH RATIONALE
  97. None.
  98. .SH "FUTURE DIRECTIONS"
  99. None.
  100. .SH "SEE ALSO"
  101. .IR "\fB<sys_types.h>\fP"
  102. .P
  103. The System Interfaces volume of POSIX.1\(hy2017,
  104. .IR "\fIftok\fR\^(\|)"
  105. .\"
  106. .SH COPYRIGHT
  107. Portions of this text are reprinted and reproduced in electronic form
  108. from IEEE Std 1003.1-2017, Standard for Information Technology
  109. -- Portable Operating System Interface (POSIX), The Open Group Base
  110. Specifications Issue 7, 2018 Edition,
  111. Copyright (C) 2018 by the Institute of
  112. Electrical and Electronics Engineers, Inc and The Open Group.
  113. In the event of any discrepancy between this version and the original IEEE and
  114. The Open Group Standard, the original IEEE and The Open Group Standard
  115. is the referee document. The original Standard can be obtained online at
  116. http://www.opengroup.org/unix/online.html .
  117. .PP
  118. Any typographical or formatting errors that appear
  119. in this page are most likely
  120. to have been introduced during the conversion of the source files to
  121. man page format. To report such errors, see
  122. https://www.kernel.org/doc/man-pages/reporting_bugs.html .