doc/dbus-cleanup-sockets.1.xml.in

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
   4 <refentry id='dbuscleanupsockets1'>
   5
   6 <!--  dbus&bsol;-cleanup&bsol;-sockets manual page.
   7  Copyright (C) 2003 Red Hat, Inc. -->
   8
   9 <refmeta>
  10 <refentrytitle>dbus-cleanup-sockets</refentrytitle>
  11 <manvolnum>1</manvolnum>
  12 <refmiscinfo class="manual">User Commands</refmiscinfo>
  13 <refmiscinfo class="source">D-Bus</refmiscinfo>
  14 <refmiscinfo class="version">@DBUS_VERSION@</refmiscinfo>
  15 </refmeta>
  16 <refnamediv>
  17 <refname>dbus-cleanup-sockets</refname>
  18 <refpurpose>clean up leftover sockets in a directory</refpurpose>
  19 </refnamediv>
  20 <!-- body begins here -->
  21 <refsynopsisdiv id='synopsis'>
  22 <cmdsynopsis>
  23   <command>dbus-cleanup-sockets</command>    <arg choice='opt'><replaceable>DIRECTORY</replaceable></arg>
  24     <sbr/>
  25 </cmdsynopsis>
  26 </refsynopsisdiv>
  27
  28
  29 <refsect1 id='description'><title>DESCRIPTION</title>
  30 <para>The <command>dbus-cleanup-sockets</command> command cleans up unused D-Bus
  31 connection sockets. See <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink> for
  32 more information about the big picture.</para>
  33
  34
  35 <para>If given no arguments, <command>dbus-cleanup-sockets</command> cleans up sockets
  36 in the standard default socket directory for the
  37 per-user-login-session message bus; this is usually /tmp.
  38 Optionally, you can pass a different directory on the command line.</para>
  39
  40
  41 <para>On Linux, this program is essentially useless, because D-Bus defaults
  42 to using "abstract sockets" that exist only in memory and don't have a
  43 corresponding file in /tmp.</para>
  44
  45
  46 <para>On most other flavors of UNIX, it's possible for the socket files to
  47 leak when programs using D-Bus exit abnormally or without closing
  48 their D-Bus connections. Thus, it might be interesting to run
  49 dbus-cleanup-sockets in a cron job to mop up any leaked sockets.
  50 Or you can just ignore the leaked sockets, they aren't really hurting
  51 anything, other than cluttering the output of "ls /tmp"</para>
  52
  53 </refsect1>
  54
  55 <refsect1 id='author'><title>AUTHOR</title>
  56 <para>dbus-cleanup-sockets was adapted by Havoc Pennington from
  57 linc-cleanup-sockets written by Michael Meeks.</para>
  58
  59 </refsect1>
  60
  61 <refsect1 id='bugs'><title>BUGS</title>
  62 <para>Please send bug reports to the D-Bus mailing list or bug tracker,
  63 see <ulink url='http://www.freedesktop.org/software/dbus/'>http://www.freedesktop.org/software/dbus/</ulink></para>
  64 </refsect1>
  65 </refentry>