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