mirror/i3
3
0
Fork 0
mirror of https://github.com/i3/i3.git synced 2025-12-01 12:06:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs/ipc: Update information on IPC socket

Browse Source
This commit is contained in:
Orestis Floros
2024-05-19 11:15:54 +02:00
parent 00aaa84ab0
commit 093e3cf1f7
1 changed files with 14 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/ipc
View File

@ -10,15 +10,21 @@ workspace bar.
The method of choice for IPC in our case is a unix socket because it has very 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 little overhead on both sides and is usually available without headaches in
most languages. In the default configuration file, the ipc-socket gets created most languages.
in +/tmp/i3-%u.XXXXXX/ipc-socket.%p+ where +%u+ is your UNIX username, +%p+ is By default i3 will set the path of the IPC socket based on:
the PID of i3 and XXXXXX is a string of random characters from the portable 1. The +ipc-socket+ configuration directive if it is used
filename character set (see mkdtemp(3)). You can get the socketpath from i3 by 2. The +I3SOCK+ environmental variable if it is set
executing +i3 --get-socketpath+, which will print the path to the standard 3. +$XDG_RUNTIME_DIR/i3/ipc-socket.%p+ if the directory is available where +%p+
output (plus a newline). is the PID of i3 and XXXXXX is a string of random characters
4. +/tmp/i3-%u.XXXXXX/ipc-socket.%p+ where +%u+ is your UNIX username
All i3 utilities, like +i3-msg+ and +i3-input+ will read the +I3_SOCKET_PATH+ You can get the socketpath from i3 by executing +i3 --get-socketpath+, which
X11 property, stored on the X11 root window. will print the path to the standard output (plus a newline) or by reading the
+I3SOCK+ environmental variable.
All i3 utilities, like +i3-msg+ and +i3-input+ will determine the path of the
IPC socket frome the +I3SOCK+ environmental variable if it is set or the
+I3_SOCKET_PATH+ X11 property, stored on the X11 root window.
[WARNING] [WARNING]
.Use an existing library! .Use an existing library!