From: Michael Stapelberg <michael@stapelberg.de>
Date: Thu, 20 Oct 2011 18:46:57 +0000 (+0100)
Subject: docs/ipc: document i3 --get-socketpath
X-Git-Tag: 4.1~92^2~30
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=a33c720ce86ab05d85885e4a015a2dd36b3417ba;p=i3%2Fi3

docs/ipc: document i3 --get-socketpath
---

diff --git a/docs/ipc b/docs/ipc
index 4093ffce..12523d12 100644
--- a/docs/ipc
+++ b/docs/ipc
@@ -1,7 +1,7 @@
 IPC interface (interprocess communication)
 ==========================================
 Michael Stapelberg <michael+i3@stapelberg.de>
-March 2010
+October 2011
 
 This document describes how to interface with i3 from a separate process. This
 is useful for example to remote-control i3 (to write test cases for example) or
@@ -12,7 +12,7 @@ The method of choice for IPC in our case is a unix socket because it has very
 little overhead on both sides and is usually available without headaches in
 most languages. In the default configuration file, the ipc-socket gets created
 in +/tmp/i3-%u/ipc-socket.%p+ where +%u+ is your UNIX username and +%p+ is the
-PID of i3.
+PID of i3. You can get the socketpath from i3 by calling +i3 --get-socketpath+.
 
 All i3 utilities, like +i3-msg+ and +i3-input+ will read the +I3_SOCKET_PATH+
 X11 property, stored on the X11 root window.
@@ -24,7 +24,8 @@ snippet illustrates this in Perl:
 
 -------------------------------------------------------------
 use IO::Socket::UNIX;
-my $sock = IO::Socket::UNIX->new(Peer => '/tmp/i3-ipc.sock');
+chomp(my $path = qx(i3 --get-socketpath));
+my $sock = IO::Socket::UNIX->new(Peer => $path);
 -------------------------------------------------------------
 
 == Sending messages to i3