Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/ipc: document the I3SOCK environment variable #4419

Closed
perillo opened this issue May 6, 2021 · 0 comments · Fixed by #6063
Closed

docs/ipc: document the I3SOCK environment variable #4419

perillo opened this issue May 6, 2021 · 0 comments · Fixed by #6063
Labels
accepted Has been approved and is ok to start working on documentation good first issue

Comments

@perillo
Copy link

perillo commented May 6, 2021

I'm submitting a…

[ ] Bug
[ ] Feature Request
[x] Documentation Request
[ ] Other (Please describe in detail)

Current Behavior

https://i3wm.org/docs/ipc.html says:

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.

Desired Behavior

The IPC documentation should document that the socketpath can be get using the I3SOCK environment variable, available since #3476.

Note that I3SOCK is documented in i3-input.man, i3-msg.man, i3bar.man, i3.man and docs/userguide.

Impact

[ ] This feature requires new configuration and/or commands

Environment

Output of i3 --moreversion 2>&-:

i3 version: 
Binary i3 version:  4.19.2 (2021-02-27) © 2009 Michael Stapelberg and contributors
Running i3 version: 4.19.2 (2021-02-27) (pid 1086)
Loaded i3 config: /home/manlio/.config/i3/config (Last modified: Thu 13 Feb 2020 08:46:31 PM CET, 38696064 seconds ago)

The i3 binary you just called: /usr/bin/i3
The i3 binary you are running: i3
- Linux Distribution & Version:
- Are you using a compositor (e.g., xcompmgr or compton):
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted Has been approved and is ok to start working on documentation good first issue
Projects
None yet
3 participants