Add the DragonFly cvs id and perform general cleanups on cvs/rcs/sccs ids. Most
[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 .\" $DragonFly: src/usr.bin/ipcrm/ipcrm.1,v 1.2 2003/06/17 04:29:27 dillon Exp $
26 .\""
27 .Dd August 8, 1994
28 .Dt IPCRM 1
29 .Os
30 .Sh NAME
31 .Nm ipcrm
32 .Nd "remove the specified message queues, semaphore sets, and shared segments"
33 .Sh SYNOPSIS
34 .Nm
35 .Op Fl q Ar msqid
36 .Op Fl m Ar shmid
37 .Op Fl s Ar semid
38 .Op Fl Q Ar msgkey
39 .Op Fl M Ar shmkey
40 .Op Fl S Ar semkey
41 .Ar ...
42 .Sh DESCRIPTION
43 The
44 .Nm
45 utility removes the specified message queues, semaphores and shared memory
46 segments.  These System V IPC objects can be specified by their
47 creation id or any associated key.
48 .Pp
49 The following options are used to specify which IPC objects will be removed.
50 Any number and combination of these options can be used:
51 .Bl -tag -width indent
52 .It Fl q Ar msqid
53 Remove the message queue associated with the id
54 .Ar msqid
55 from the system.
56 .It Fl m Ar shmid
57 Mark the shared memory segment associated with id
58 .Ar shmid
59 for removal.
60 This marked segment will be destroyed after the last detach.
61 .It Fl s Ar semid
62 Remove the semaphore set associated with id
63 .Ar semid
64 from the system.
65 .It Fl Q Ar msgkey
66 Remove the message queue associated with key
67 .Ar msgkey
68 from the system.
69 .It Fl M Ar shmkey
70 Mark the shared memory segment associated with key
71 .Ar shmkey
72 for removal.
73 This marked segment will be destroyed after the last detach.
74 .It Fl S Ar semkey
75 Remove the semaphore set associated with key
76 .Ar semkey
77 from the system.
78 .El
79 .Pp
80 The identifiers and keys associated with these System V IPC objects can be
81 determined by using
82 .Xr ipcs 1 .
83 .Sh SEE ALSO
84 .Xr ipcs 1