Merge branch 'monitor-ay-output'
[platform/upstream/dbus.git] / tools / dbus-cleanup-sockets.1
index 3f125dc..ca669f4 100644 (file)
@@ -11,8 +11,8 @@ dbus-cleanup-sockets \- clean up leftover sockets in a directory
 
 .SH DESCRIPTION
 
-The \fIdbus-cleanup-sockets\fP command cleans up sockets used for
-D-BUS connections. See http://www.freedesktop.org/software/dbus/ for
+The \fIdbus-cleanup-sockets\fP command cleans up unused D-Bus
+connection sockets. See http://www.freedesktop.org/software/dbus/ for
 more information about the big picture.
 
 .PP
@@ -21,10 +21,23 @@ in the standard default socket directory for the
 per-user-login-session message bus; this is usually /tmp. 
 Optionally, you can pass a different directory on the command line.
 
+.PP
+On Linux, this program is essentially useless, because D-Bus defaults
+to using "abstract sockets" that exist only in memory and don't have a
+corresponding file in /tmp. 
+
+.PP
+On most other flavors of UNIX, it's possible for the socket files to
+leak when programs using D-Bus exit abnormally or without closing
+their D-Bus connections. Thus, it might be interesting to run
+dbus-cleanup-sockets in a cron job to mop up any leaked sockets.
+Or you can just ignore the leaked sockets, they aren't really hurting
+anything, other than cluttering the output of "ls /tmp"
+
 .SH AUTHOR
 dbus-cleanup-sockets was adapted by Havoc Pennington from
 linc-cleanup-sockets written by Michael Meeks.
 
 .SH BUGS
-Please send bug reports to the D-BUS mailing list or bug tracker,
+Please send bug reports to the D-Bus mailing list or bug tracker,
 see http://www.freedesktop.org/software/dbus/