]> git.sur5r.net Git - i3/i3/blob - man/i3-input.man
do not check for NULL in FREE macro
[i3/i3] / man / i3-input.man
1 i3-input(1)
2 =========
3 Michael Stapelberg <michael+i3@stapelberg.de>
4 v4.1.2, April 2012
5
6 == NAME
7
8 i3-input - interactively take a command for i3 window manager
9
10 == SYNOPSIS
11
12 i3-input [-s <socket>] [-F <format>] [-l <limit>] [-P <prompt>] [-f <font>] [-v]
13
14 == DESCRIPTION
15
16 i3-input is a tool to take commands (or parts of a command) composed by
17 the user, and send it/them to i3. This is useful, for example, for the
18 mark/goto command.
19
20 You can press Escape to close i3-input without sending any commands.
21
22 == OPTIONS
23
24 -s <socket>::
25 Specify the path to the i3 IPC socket (it should not be necessary to use this
26 option, i3-input will figure out the path on its own).
27
28 -F <format>::
29 Every occurrence of "%s" in the <format> string is replaced by the user input,
30 and the result is sent to i3 as a command. Default value is "%s".
31
32 -l <limit>::
33 Set the maximum allowed length of the user input to <limit> characters.
34 i3-input will automatically issue the command when the user input reaches that
35 length.
36
37 -P <prompt>::
38 Display the <prompt> string in front of user input text field.
39 The prompt string is not included in the user input/command.
40
41 -f <font>::
42 Use the specified X11 core font (use +xfontsel+ to chose a font).
43
44 -v::
45 Show version and exit.
46
47 == EXAMPLES
48
49 Mark a container with a single character:
50 ------------------------------------------------
51 i3-input -F 'mark %s' -l 1 -P 'Mark: '
52 ------------------------------------------------
53
54 Go to the container marked with above example:
55 -----------------------------------------------------
56 i3-input -F '[con_mark="%s"] focus' -l 1 -P 'Go to: '
57 -----------------------------------------------------
58
59 == ENVIRONMENT
60
61 === I3SOCK
62
63 i3-input handles the different sources of socket paths in the following order:
64
65 * I3SOCK environment variable
66 * I3SOCK gets overwritten by the -s parameter, if specified
67 * if neither are available, i3-input reads the socket path from the X11
68   property, which is the recommended way
69 * if everything fails, i3-input tries +/tmp/i3-ipc.sock+
70
71 The socket path is necessary to connect to i3 and actually issue the command.
72
73 == SEE ALSO
74
75 i3(1)
76
77 == AUTHOR
78
79 Michael Stapelberg and contributors