]> git.ipfire.org Git - thirdparty/man-pages.git/blobdiff - man2/msgctl.2
Wrapped long lines, wrapped at sentence boundaries; stripped trailing
[thirdparty/man-pages.git] / man2 / msgctl.2
index 6af880df7953d6d98aeb1c651ee7070a414b16e6..675ed744c1c82ad10a59f026b1fcfd2bfdcb66f0 100644 (file)
@@ -9,7 +9,7 @@
 .\" manual under the conditions for verbatim copying, provided that the
 .\" entire resulting derived work is distributed under the terms of a
 .\" permission notice identical to this one.
-.\" 
+.\"
 .\" Since the Linux kernel and libraries are constantly changing, this
 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
 .\" responsibility for errors or omissions, or for damages resulting from
@@ -17,7 +17,7 @@
 .\" have taken the same level of care in the production of this manual,
 .\" which is licensed free of charge, as they might when working
 .\" professionally.
-.\" 
+.\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
 .\"
@@ -66,11 +66,11 @@ struct msqid_ds {
     time_t         msg_stime;    /* Time of last msgsnd() */
     time_t         msg_rtime;    /* Time of last msgrcv() */
     time_t         msg_ctime;    /* Time of last change */
-    unsigned long  __msg_cbytes; /* Current number of bytes in 
+    unsigned long  __msg_cbytes; /* Current number of bytes in
                                     queue (non-standard) */
-    msgqnum_t      msg_qnum;     /* Current number of messages 
+    msgqnum_t      msg_qnum;     /* Current number of messages
                                     in queue */
-    msglen_t       msg_qbytes;   /* Maximum number of bytes 
+    msglen_t       msg_qbytes;   /* Maximum number of bytes
                                     allowed in queue */
     pid_t          msg_lspid;    /* PID of last msgsnd() */
     pid_t          msg_lrpid;    /* PID of last msgrcv() */
@@ -120,7 +120,7 @@ to the kernel data structure associated with this message queue,
 updating also its
 .I msg_ctime
 member.
-The following members of the structure are updated: 
+The following members of the structure are updated:
 .IR msg_qbytes ,
 .IR msg_perm.uid ,
 .IR msg_perm.gid ,
@@ -128,7 +128,7 @@ and (the least significant 9 bits of)
 .IR msg_perm.mode .
 The effective UID of the calling process must match the owner
 .RI ( msg_perm.uid )
-or creator 
+or creator
 .RI ( msg_perm.cuid )
 of the message queue, or the caller must be privileged.
 Appropriate privilege (Linux: the
@@ -150,11 +150,11 @@ or its effective user ID must be either that of the creator or owner
 of the message queue.
 .TP
 .BR IPC_INFO " (Linux specific)"
-Returns information about system-wide message queue limits and 
+Returns information about system-wide message queue limits and
 parameters in the structure pointed to by
 .IR buf .
 This structure is of type
-.IR msginfo 
+.IR msginfo
 (thus, a cast is required),
 defined in
 .I <sys/msg.h>
@@ -163,18 +163,18 @@ if the _GNU_SOURCE feature test macro is defined:
 .in +2n
 
 struct msginfo {
-    int msgpool; /* Size in bytes of buffer pool used 
+    int msgpool; /* Size in bytes of buffer pool used
                     to hold message data; unused */
     int msgmap;  /* Max. # of entries in message
                     map; unused */
     int msgmax;  /* Max. # of bytes that can be
                     written in a single message */
     int msgmnb;  /* Max. # of bytes that can be written to
-                    queue; used to initialize msg_qbytes 
+                    queue; used to initialize msg_qbytes
                     during queue creation (msgget()) */
     int msgmni;  /* Max. # of message queues */
     int msgssz;  /* Message segment size; unused */
-    int msgtql;  /* Max. # of messages on all queues 
+    int msgtql;  /* Max. # of messages on all queues
                     in system; unused */
     unsigned short int msgseg;
                  /* Max. # of segments; unused */
@@ -182,15 +182,15 @@ struct msginfo {
 
 .in -2n
 .fi
-The 
+The
 .IR msgmni ,
 .IR msgmax ,
 and
 .I msgmnb
 settings can be changed via
-.I /proc 
+.I /proc
 files of the same name; see
-.BR proc (5) 
+.BR proc (5)
 for details.
 .TP
 .BR MSG_INFO " (Linux specific)"
@@ -198,21 +198,21 @@ Returns a
 .I msginfo
 structure containing the same information as for
 .BR IPC_INFO ,
-except that the following fields are returned with information 
+except that the following fields are returned with information
 about system resources consumed by message queues: the
 .I msgpool
-field returns the number of message queues that currently exist 
+field returns the number of message queues that currently exist
 on the system; the
 .I msgmap
-field returns the total number of messages in all queues 
+field returns the total number of messages in all queues
 on the system; and the
 .I msgtql
-field returns the total number of bytes in all messages 
+field returns the total number of bytes in all messages
 in all queues on the system.
 .TP
 .BR MSG_STAT " (Linux specific)"
-Returns a 
-.I msqid_ds 
+Returns a
+.I msqid_ds
 structure as for
 .BR IPC_STAT .
 However, the
@@ -229,13 +229,13 @@ and
 return 0.
 A successful
 .B IPC_INFO
-or 
+or
 .B MSG_INFO
 operation returns the index of the highest used entry in the
 kernel's internal array recording information about all
 message queues.
 (This information can be used with repeated
-.B MSG_STAT 
+.B MSG_STAT
 operations to obtain information about all queues on the system.)
 A successful
 .B MSG_STAT
@@ -284,7 +284,7 @@ or
 .IR msqid .
 Or: for a
 .B MSG_STAT
-operation, the index value specified in 
+operation, the index value specified in
 .I msqid
 referred to an array slot that is currently unused.
 .TP