]> git.sur5r.net Git - i3/i3/blobdiff - man/i3-input.man
Merge pull request #3386 from orestisf1993/click-event
[i3/i3] / man / i3-input.man
index 5a00fae18acb4ca2c08e70a3b8f819b6fa020d5f..dc145914749ab758962729649be6bf73a3355b14 100644 (file)
@@ -1,5 +1,5 @@
 i3-input(1)
-=========
+===========
 Michael Stapelberg <michael+i3@stapelberg.de>
 v4.1.2, April 2012
 
@@ -14,32 +14,35 @@ i3-input [-s <socket>] [-F <format>] [-l <limit>] [-P <prompt>] [-f <font>] [-v]
 == DESCRIPTION
 
 i3-input is a tool to take commands (or parts of a command) composed by
-the user, and send it/them to i3 (unles the user hits Escape before inputing <limit> characters.
-This is useful, for example, for the mark/goto command.
+the user, and send it/them to i3. This is useful, for example, for the
+mark/goto command.
+
+You can press Escape to close i3-input without sending any commands.
 
 == OPTIONS
 
 -s <socket>::
-Specify a path to an IPC socket for comunication with i3.
+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 occurence of "%s" in the <format> string is replaced by the user input,
+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 issues the command as if the user hit Return
-when the user input length reaches that value.
+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 specified X11 font.
+Use the specified X11 core font (use +xfontsel+ to chose a font).
 
 -v::
-Show version and exit without issuing any commands.
+Show version and exit.
 
 == EXAMPLES