]> git.sur5r.net Git - i3/i3/blobdiff - man/i3-msg.man
travis: check spelling of binaries and manpages, use docker
[i3/i3] / man / i3-msg.man
index 891c6c283dd7ab17fa6db541f5a1007e96865361..e0c70c44e9231920e600573419a1712ce3c37d32 100644 (file)
@@ -1,7 +1,7 @@
 i3-msg(1)
 =========
-Michael Stapelberg <michael+i3@stapelberg.de>
-v4.2, January 2012
+Michael Stapelberg <michael@i3wm.org>
+v4.2, August 2012
 
 == NAME
 
@@ -9,7 +9,30 @@ i3-msg - send messages to i3 window manager
 
 == SYNOPSIS
 
-i3-msg [-t type] [message]
+i3-msg  [-q] [-v] [-h] [-s socket] [-t type] [message]
+
+== OPTIONS
+
+*-q, --quiet*::
+Only send ipc message and suppress the output of the response.
+
+*-v, --version*::
+Display version number and exit.
+
+*-h, --help*::
+Display a short help-message and exit.
+
+*-s, --socket* 'sock_path'::
+i3-msg will use the environment variable I3SOCK or the socket path
+given here. If both fail, it will try to get the socket information
+from the root window and then try /tmp/i3-ipc.sock before exiting
+with an error.
+
+*-t* 'type'::
+Send ipc message, see below.
+
+*message*::
+Send ipc message, see below.
 
 == IPC MESSAGE TYPES
 
@@ -24,7 +47,8 @@ workspaces.
 
 get_outputs::
 Gets the current outputs. The reply will be a JSON-encoded list of outputs (see
-the reply section).
+the reply section of docs/ipc, e.g. at
+http://i3wm.org/docs/ipc.html#_receiving_replies_from_i3).
 
 get_tree::
 Gets the layout tree. i3 uses a tree as data structure which includes every
@@ -38,6 +62,9 @@ get_bar_config::
 Gets the configuration (as JSON map) of the workspace bar with the given ID. If
 no ID is provided, an array with all configured bar IDs is returned instead.
 
+get_version::
+Gets the version of i3. The reply will be a JSON-encoded dictionary with the
+major, minor, patch and human-readable version.
 
 == DESCRIPTION
 
@@ -62,7 +89,7 @@ i3-msg -t get_tree
 === I3SOCK
 
 If no ipc-socket is specified on the commandline, this variable is used
-to determine the path, at wich the unix domain socket is expected, on which
+to determine the path, at which the unix domain socket is expected, on which
 to connect to i3.
 
 == SEE ALSO