dbus/doc/dbus-cleanup-sockets.1
Will Thompson 46b9961be7 Move manpages to doc/
This will make integrating the building of HTML versions of these
manpages into the build system way easier, at the cost of keeping
manpages in a different directory to the source for the program they
describe. I think this is an acceptable trade-off.
2010-10-05 11:45:59 +01:00

43 lines
1.5 KiB
Groff

.\"
.\" dbus-cleanup-sockets manual page.
.\" Copyright (C) 2003 Red Hat, Inc.
.\"
.TH dbus-cleanup-sockets 1
.SH NAME
dbus-cleanup-sockets \- clean up leftover sockets in a directory
.SH SYNOPSIS
.PP
.B dbus-cleanup-sockets [DIRECTORY]
.SH DESCRIPTION
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
If given no arguments, \fIdbus-cleanup-sockets\fP cleans up sockets
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,
see http://www.freedesktop.org/software/dbus/