From 27b7f6a6e5e90f40655929ce2ed257c3a08556be Mon Sep 17 00:00:00 2001 From: Mateusz Poszwa Date: Sun, 22 Apr 2012 16:34:20 +0200 Subject: [PATCH] man/i3-input.man: Add description of options and improve examples. --- man/i3-input.man | 39 +++++++++++++++++++++++++++++++++------ 1 file changed, 33 insertions(+), 6 deletions(-) diff --git a/man/i3-input.man b/man/i3-input.man index df7c4d9c..5a00fae1 100644 --- a/man/i3-input.man +++ b/man/i3-input.man @@ -1,7 +1,7 @@ i3-input(1) ========= Michael Stapelberg -v4.1, September 2011 +v4.1.2, April 2012 == NAME @@ -14,18 +14,45 @@ i3-input [-s ] [-F ] [-l ] [-P ] [-f ] [-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. This is useful, for example, for the -mark/goto command. +the user, and send it/them to i3 (unles the user hits Escape before inputing characters. +This is useful, for example, for the mark/goto command. -The -F option takes a format string. In this string, every occurence of %s is -replaced by the user input. +== OPTIONS -== EXAMPLE +-s :: +Specify a path to an IPC socket for comunication with i3. +-F :: +Every occurence of "%s" in the string is replaced by the user input, +and the result is sent to i3 as a command. Default value is "%s". + +-l :: +Set the maximum allowed length of the user input to characters. +i3-input will automatically issues the command as if the user hit Return +when the user input length reaches that value. + +-P :: +Display the string in front of user input text field. +The prompt string is not included in the user input/command. + +-f :: +Use specified X11 font. + +-v:: +Show version and exit without issuing any commands. + +== EXAMPLES + +Mark a container with a single character: ------------------------------------------------ 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 -- 2.39.5