X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=man%2Fi3-input.man;h=dc145914749ab758962729649be6bf73a3355b14;hb=0ed29f567866ad00a2cb14ce2e6eb5a29b277011;hp=cd85c92c622e62d0b82a50c43128e12cb57882ea;hpb=4caf85aa0be4b5d60213fbe2b8f8115df1607c6d;p=i3%2Fi3

diff --git a/man/i3-input.man b/man/i3-input.man
index cd85c92c..dc145914 100644
--- a/man/i3-input.man
+++ b/man/i3-input.man
@@ -1,7 +1,7 @@
 i3-input(1)
-=========
+===========
 Michael Stapelberg <michael+i3@stapelberg.de>
-v3.delta, November 2009
+v4.1.2, April 2012
 
 == NAME
 
@@ -9,7 +9,7 @@ i3-input - interactively take a command for i3 window manager
 
 == SYNOPSIS
 
-i3-input [-s <socket>] [-p <prefix>] [-l <limit>] [-P <prompt>] [-f <font>] [-v]
+i3-input [-s <socket>] [-F <format>] [-l <limit>] [-P <prompt>] [-f <font>] [-v]
 
 == DESCRIPTION
 
@@ -17,19 +17,58 @@ i3-input is a tool to take commands (or parts of a command) composed by
 the user, and send it/them to i3. This is useful, for example, for the
 mark/goto command.
 
-== EXAMPLE
+You can press Escape to close i3-input without sending any commands.
 
+== OPTIONS
+
+-s <socket>::
+Specify the path to the i3 IPC socket (it should not be necessary to use this
+option, i3-input will figure out the path on its own).
+
+-F <format>::
+Every occurrence of "%s" in the <format> string is replaced by the user input,
+and the result is sent to i3 as a command. Default value is "%s".
+
+-l <limit>::
+Set the maximum allowed length of the user input to <limit> characters.
+i3-input will automatically issue the command when the user input reaches that
+length.
+
+-P <prompt>::
+Display the <prompt> string in front of user input text field.
+The prompt string is not included in the user input/command.
+
+-f <font>::
+Use the specified X11 core font (use +xfontsel+ to chose a font).
+
+-v::
+Show version and exit.
+
+== EXAMPLES
+
+Mark a container with a single character:
 ------------------------------------------------
-i3-input -p 'mark ' -l 1 -P 'Mark: '
+i3-input -F 'mark %s' -l 1 -P 'Mark: '
 ------------------------------------------------
 
+Go to the container marked with above example:
+-----------------------------------------------------
+i3-input -F '[con_mark="%s"] focus' -l 1 -P 'Go to: '
+-----------------------------------------------------
+
 == ENVIRONMENT
 
 === 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 connect to i3.
+i3-input handles the different sources of socket paths in the following order:
+
+* I3SOCK environment variable
+* I3SOCK gets overwritten by the -s parameter, if specified
+* if neither are available, i3-input reads the socket path from the X11
+  property, which is the recommended way
+* if everything fails, i3-input tries +/tmp/i3-ipc.sock+
+
+The socket path is necessary to connect to i3 and actually issue the command.
 
 == SEE ALSO