Bring in GSoC code: SysV IPC in userspace
[dragonfly.git] / usr.sbin / sysvipcd / sysvipcd.8
1 .\"
2 .\" Copyright (c) 2013
3 .\"     The DragonFly Project.  All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in
13 .\"    the documentation and/or other materials provided with the
14 .\"    distribution.
15 .\" 3. Neither the name of The DragonFly Project nor the names of its
16 .\"    contributors may be used to endorse or promote products derived
17 .\"    from this software without specific, prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
23 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
29 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .Dd September 26, 2013
33 .Dt SYSVIPCD 8
34 .Os
35 .Sh NAME
36 .Nm sysvipcd
37 .Nd SysV IPC daemon
38 .Sh DESCRIPTION
39 The
40 .Nm
41 daemon handles the resource management for the userspace implementation of
42 the XSI Interprocess Communication functions.
43 It is responsible for mapping shared memory, semaphores and message queues
44 into the clients' address spaces and it has to be running for the
45 userspace implementation to work.
46 .Pp
47 Clients connect to it through a
48 .Ux socket .
49 The daemon also monitors the
50 .Xr fork 2
51 system call and any children of a process using the userspace
52 implementation automatically connect to the daemon too.
53 .Pp
54 The following options are available:
55 .Bl -tag -width indent
56 .It Fl d
57 run in debugging mode (prints debug messages)
58 .El
59 .Sh ENVIRONMENT
60 If the
61 .Ev USR_SYSVIPC
62 variable is set in a process' environment, the process and its children
63 will use the userspace implementation of the XSI Interprocess Communication
64 functions.
65 .Sh FILES
66 .Bl -tag -width ".Pa /var/run/sysvipc/sysvipc_socket" -compact
67 .It Pa /var/run/sysvipc/sysvipc_socket
68 name of the
69 .Ux
70 domain stream socket for client communication
71 .El
72 .Sh SEE ALSO
73 .Xr msgctl 2 ,
74 .Xr msgget 2 ,
75 .Xr msgrcv 2 ,
76 .Xr msgsnd 2 ,
77 .Xr semctl 2 ,
78 .Xr semget 2 ,
79 .Xr semop 2 ,
80 .Xr shmat 2 ,
81 .Xr shmctl 2 ,
82 .Xr shmget 2
83 .Sh HISTORY
84 The
85 .Nm
86 daemon was added in
87 .Dx 3.5
88 .Sh AUTHORS
89 .An Larisa Grigore