Promote the marshalling format to a top-level section
[platform/upstream/dbus.git] / doc / dbus-cleanup-sockets.1
1 .\" 
2 .\" dbus\-cleanup\-sockets manual page.
3 .\" Copyright (C) 2003 Red Hat, Inc.
4 .\"
5 .TH dbus\-cleanup\-sockets 1
6 .SH NAME
7 dbus\-cleanup\-sockets \- clean up leftover sockets in a directory
8 .SH SYNOPSIS
9 .PP
10 .B dbus\-cleanup\-sockets [DIRECTORY]
11
12 .SH DESCRIPTION
13
14 The \fIdbus\-cleanup\-sockets\fP command cleans up unused D\-Bus
15 connection sockets. See http://www.freedesktop.org/software/dbus/ for
16 more information about the big picture.
17
18 .PP
19 If given no arguments, \fIdbus\-cleanup\-sockets\fP cleans up sockets 
20 in the standard default socket directory for the
21 per\-user\-login\-session message bus; this is usually /tmp. 
22 Optionally, you can pass a different directory on the command line.
23
24 .PP
25 On Linux, this program is essentially useless, because D\-Bus defaults
26 to using "abstract sockets" that exist only in memory and don't have a
27 corresponding file in /tmp. 
28
29 .PP
30 On most other flavors of UNIX, it's possible for the socket files to
31 leak when programs using D\-Bus exit abnormally or without closing
32 their D\-Bus connections. Thus, it might be interesting to run
33 dbus\-cleanup\-sockets in a cron job to mop up any leaked sockets.
34 Or you can just ignore the leaked sockets, they aren't really hurting
35 anything, other than cluttering the output of "ls /tmp"
36
37 .SH AUTHOR
38 dbus\-cleanup\-sockets was adapted by Havoc Pennington from
39 linc\-cleanup\-sockets written by Michael Meeks.
40
41 .SH BUGS
42 Please send bug reports to the D\-Bus mailing list or bug tracker,
43 see http://www.freedesktop.org/software/dbus/