Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.bin / ipcrm / ipcrm.1
1 .\" Copyright (c) 1994 Adam Glass
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. The name of the Author may not be used to endorse or promote products
10 .\"    derived from this software without specific prior written permission.
11 .\"
12 .\" THIS SOFTWARE IS PROVIDED BY Adam Glass ``AS IS'' AND
13 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Adam Glass BE LIABLE
16 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22 .\" SUCH DAMAGE.
23 .\"
24 .\" $FreeBSD: src/usr.bin/ipcrm/ipcrm.1,v 1.7.2.5 2003/02/24 23:04:38 trhodes Exp $
25 .\""
26 .Dd August 8, 1994
27 .Dt IPCRM 1
28 .Os
29 .Sh NAME
30 .Nm ipcrm
31 .Nd "remove the specified message queues, semaphore sets, and shared segments"
32 .Sh SYNOPSIS
33 .Nm
34 .Op Fl q Ar msqid
35 .Op Fl m Ar shmid
36 .Op Fl s Ar semid
37 .Op Fl Q Ar msgkey
38 .Op Fl M Ar shmkey
39 .Op Fl S Ar semkey
40 .Ar ...
41 .Sh DESCRIPTION
42 The
43 .Nm
44 utility removes the specified message queues, semaphores and shared memory
45 segments.  These System V IPC objects can be specified by their
46 creation id or any associated key.
47 .Pp
48 The following options are used to specify which IPC objects will be removed.
49 Any number and combination of these options can be used:
50 .Bl -tag -width indent
51 .It Fl q Ar msqid
52 Remove the message queue associated with the id
53 .Ar msqid
54 from the system.
55 .It Fl m Ar shmid
56 Mark the shared memory segment associated with id
57 .Ar shmid
58 for removal.
59 This marked segment will be destroyed after the last detach.
60 .It Fl s Ar semid
61 Remove the semaphore set associated with id
62 .Ar semid
63 from the system.
64 .It Fl Q Ar msgkey
65 Remove the message queue associated with key
66 .Ar msgkey
67 from the system.
68 .It Fl M Ar shmkey
69 Mark the shared memory segment associated with key
70 .Ar shmkey
71 for removal.
72 This marked segment will be destroyed after the last detach.
73 .It Fl S Ar semkey
74 Remove the semaphore set associated with key
75 .Ar semkey
76 from the system.
77 .El
78 .Pp
79 The identifiers and keys associated with these System V IPC objects can be
80 determined by using
81 .Xr ipcs 1 .
82 .Sh SEE ALSO
83 .Xr ipcs 1