xref: /openbsd/usr.bin/ipcrm/ipcrm.1 (revision fc61954a)
1.\" $OpenBSD: ipcrm.1,v 1.17 2015/09/09 21:23:31 schwarze Exp $
2.\"
3.\" Copyright (c) 1994 Adam Glass
4.\" 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. The name of the Author may not be used to endorse or promote products
12.\"    derived from this software without specific prior written permission.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY Adam Glass ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL Adam Glass BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\""
27.Dd $Mdocdate: September 9 2015 $
28.Dt IPCRM 1
29.Os
30.Sh NAME
31.Nm ipcrm
32.Nd remove the specified message queues, semaphore sets, and shared \
33memory segments
34.Sh SYNOPSIS
35.Nm ipcrm
36.Bk -words
37.Op Fl M Ar shmkey
38.Op Fl m Ar shmid
39.Op Fl Q Ar msgkey
40.Op Fl q Ar msqid
41.Op Fl S Ar semkey
42.Op Fl s Ar semid
43.Ar ...
44.Ek
45.Sh DESCRIPTION
46.Nm
47removes the specified message queues, semaphores, and shared memory
48segments.
49These System V IPC objects can be specified by their
50creation ID or any associated key.
51.Pp
52The options are as follows:
53.Bl -tag -width Ds
54.It Fl M Ar shmkey
55Mark the shared memory segment associated with key
56.Nm shmkey
57for removal.
58This marked segment will be destroyed after the last detach.
59.It Fl m Ar shmid
60Mark the shared memory segment associated with ID
61.Nm shmid
62for removal.
63This marked segment will be destroyed after the last detach.
64.It Fl Q Ar msgkey
65Remove the message queue associated with key
66.Nm msgkey
67from the system.
68.It Fl q Ar msqid
69Remove the message queue associated with the ID
70.Nm msqid
71from the system.
72.It Fl S Ar semkey
73Remove the semaphore set associated with key
74.Nm semkey
75from the system.
76.It Fl s Ar semid
77Removes the semaphore set associated with ID
78.Nm semid
79from the system.
80.El
81.Pp
82The identifiers and keys associated with these System V IPC objects can be
83determined by using
84.Xr ipcs 1 .
85.Sh EXIT STATUS
86.Ex -std ipcrm
87.Sh SEE ALSO
88.Xr ipcs 1
89.Sh STANDARDS
90The
91.Nm
92utility is compliant with the
93X/Open System Interfaces option of the
94.St -p1003.1-2008
95specification.
96