<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!--ARC : LSARC 2006/368 D-BUS Message Bus System -->
<!ENTITY cmd "dbus-cleanup-sockets">
<!ENTITY % commonents SYSTEM "smancommon.ent">
%commonents;
<!ENTITY % booktitles SYSTEM "booktitles.ent">
%booktitles;
<!ENTITY suncopy "Copyright (c) 2007,2009 Sun Microsystems, Inc. All Rights Reserved.">
]>
<refentry id="dbus-cleanup-sockets-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">25 Feb 2009</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>&cmd;</primary></indexterm>
<indexterm><primary>clean up leftover sockets in a directory</primary></indexterm>
<refnamediv id="dbus-cleanup-sockets-1-name">
<refname>&cmd;</refname>
<refpurpose>clean up leftover sockets in a directory</refpurpose>
</refnamediv>
<refsynopsisdiv id="dbus-cleanup-sockets-1-synp"><title>&synp-tt;</title>
<cmdsynopsis><command>&cmd;</command>
<arg choice="opt"><option>-help</option></arg>
<arg choice="opt"><option>-version</option></arg>
<arg choice="opt"><option role="nodash"><replaceable>directory</replaceable></option></arg>
</cmdsynopsis></refsynopsisdiv>

<refsect1 id="dbus-cleanup-sockets-1-desc"><title>&desc-tt;</title>
<para>
The &cmd; command cleans up unused D\-Bus connection sockets.
</para>

<para>
If given no arguments, <command>&cmd;</command> cleans up sockets in the
standard default socket directory for the per-user-login-session message bus;
this is usually <filename>/tmp</filename>.  Optionally, you can pass a
different directory on the command line.
</para>

<para>
On Linux, this program is essentially useless, because D\-Bus defaults to using
&quot;abstract sockets&quot; that exist only in memory and do not have a
corresponding file in <filename>/tmp</filename>.
</para>

<para>
On most other flavors of UNIX, it is 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 <command>&cmd;</command> in a
cron job to clean up any leaked sockets.  Or you can just ignore the leaked
sockets, they are not really hurting anything, other than cluttering the
<filename>/tmp</filename> directory.
</para>
</refsect1>

<refsect1 id="dbus-send-1-opts"><title>&opts-tt;</title>
<para>
The following options are supported:
</para>

<variablelist termlength="wholeline">
<varlistentry>
<term><option>-help</option></term>
<listitem><para>
Show help information on standard output and exit.
</para></listitem></varlistentry>

<varlistentry>
<term><option>-version</option></term>
<listitem><para>
Print the version of <command>&cmd;</command>
</para></listitem></varlistentry>
</variablelist>
</refsect1>

<refsect1 id="dbus-cleanup-sockets-1-oper"><title>&oper-tt;</title>
<para>
The following operands are supported:
</para>

<variablelist termlength="narrow">
<varlistentry>
<term><option role="nodash"><replaceable>directory</replaceable></option></term>
<listitem><para>
Clean up sockets in the specified <replaceable>directory</replaceable>
rather than the default socket directory.
</para>
</listitem></varlistentry>
</variablelist>
</refsect1>

<refsect1 id="dbus-cleanup-sockets-1-exit"><title>&exit-tt;</title>
<para>
The following exit values are returned:
</para>

<variablelist termlength="xtranarrow">
<varlistentry>
<term><returnvalue>0</returnvalue></term>
<listitem><para>
Application exited successfully
</para>
</listitem></varlistentry>

<varlistentry>
<term><returnvalue>>0</returnvalue></term>
<listitem><para>
Application exited with failure
</para>
</listitem></varlistentry>
</variablelist>
</refsect1>

<refsect1 id="dbus-cleanup-sockets-1-file"><title>&file-tt;</title>
<para>
The following files are used by this application:
</para>

<variablelist termlength="wide">
<varlistentry>
<term><filename>/usr/bin/&cmd;</filename></term>
<listitem><para>
Executable for <command>&cmd;</command>
</para>
</listitem></varlistentry>

<varlistentry>
<term><filename>/tmp</filename></term>
<listitem><para>
Default location for D\-Bus connection sockets
</para>
</listitem></varlistentry>
</variablelist>
</refsect1>

<refsect1 id="dbus-cleanup-sockets-1-attr"><title>&attr-tt;</title>
<para>
See
<olink targetdocent="REFMAN5" localinfo="attributes-5">
<citerefentry><refentrytitle>attributes</refentrytitle>
<manvolnum>5</manvolnum></citerefentry></olink>
for descriptions of the following attributes:
</para>

<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="COLSPEC0" colwidth="1*">
<colspec colname="COLSPEC1" colwidth="1*">
<thead>
<row>
<entry align="center" valign="middle">ATTRIBUTE TYPE</entry>
<entry align="center" valign="middle">ATTRIBUTE VALUE</entry></row>
</thead>
<tbody>
<row>
<entry><para>Availability</para></entry>
<entry><para>system/library/dbus</para></entry>
</row>
<row>
<entry colname="COLSPEC0"><para>Interface stability</para></entry>
<entry colname="COLSPEC1"><para>Volatile</para></entry>
</row>
</tbody></tgroup>
</informaltable>
</refsect1>

<refsect1 id="dbus-cleanup-sockets-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
More information can be found at:
</para>

<para>
<literal>http://www.freedesktop.org/software/dbus/</literal>
</para>

<para>
<citerefentry><refentrytitle>dbus-binding-tool</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>dbus-launch</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>dbus-monitor</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>dbus-send</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>libdbus-glib-1</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>

<refsect1 id="dbus-cleanup-sockets-1-note"><title>&note-tt;</title>
<para>
For authorship information refer to
<literal>http://www.freedesktop.org/software/dbus/doc/AUTHORS</literal>.
Updated by Brian Cameron, Sun Microsystems Inc., 2007.
</para>

<para>
<command>&cmd;</command> was adapted by Havoc Pennington from 
linc-cleanup-sockets written by Michael Meeks.  Documentation updated by Brian
Cameron, Sun Microsystems Inc., 2007.
</para>

<para>
Please send bug reports to the D\-Bus mailing list or bug
tracker, see
<literal>http://www.freedesktop.org/software/dbus/</literal>
</para>
</refsect1>
</refentry>
