update man pages

_docs/Makefile

@@ -1,5 +1,5 @@
 
-all: hacking-howto.html debugging.html debugging-release-version.html i3bar-protocol.html repositories.html buildbot.html userguide.html ipc.html multi-monitor.html wsbar.html i3status.html i3.html i3-config-wizard.html i3-nagbar.html i3-migrate-config-to-v4.html i3-msg.html testsuite.html gsoc2013-ideas.html tshirts.html layout-saving.html i3bar-workspace-protocol.html
+all: hacking-howto.html debugging.html debugging-release-version.html i3bar-protocol.html repositories.html buildbot.html userguide.html ipc.html multi-monitor.html wsbar.html i3status.html i3.html i3-config-wizard.html i3-nagbar.html i3-migrate-config-to-v4.html i3-msg.html testsuite.html gsoc2013-ideas.html tshirts.html layout-saving.html i3bar-workspace-protocol.html i3-input.html
 
 gsoc2013-ideas.html: gsoc2013-ideas
 	asciidoc -a linkcss -a stylesdir=/css -a scriptsdir=/js --backend=xhtml11 -f conf/i3html.conf -a toc -n $<
@@ -49,6 +49,9 @@ tshirts.html: tshirts
 i3status.html: i3status.man
 	asciidoc -a linkcss -a stylesdir=/css -a scriptsdir=/js --backend=xhtml11 -f conf/i3html.conf -a toc -n $<
 
+i3-input.html: i3-input.man
+	asciidoc -a linkcss -a stylesdir=/css -a scriptsdir=/js --backend=xhtml11 -f conf/i3html.conf -a toc -n $<
+
 %.html: %.man
 	asciidoc -a linkcss -a stylesdir=/css -a scriptsdir=/js --backend=xhtml11 -f conf/i3html.conf -a toc -n $<
 

_docs/i3-config-wizard.man

@@ -9,7 +9,21 @@ i3-config-wizard - creates a keysym based config based on your layout
 
 == SYNOPSIS
 
-i3-config-wizard
+i3-config-wizard [*-s* 'socket'] [*-m* 'modifier'] [*-v*] [*-h*]
+
+== OPTIONS
+
+*-s, --socket* 'socket'::
+Overwrites the path to the i3 IPC socket.
+
+*-m, --modifier* 'modifier'::
+Generates the configuration file headlessly. Accepts win or alt.
+
+*-v, --version*::
+Display version number and exit.
+
+*-h, --help*::
+Display a short help message and exit.
 
 == FILES
 
@@ -21,7 +35,7 @@ used.
 
 == DESCRIPTION
 
-i3-config-wizard is started by i3 in its default config, unless ~/.i3/config
+i3-config-wizard is started by i3 in its default config, unless \~/.i3/config
 exists. i3-config-wizard creates a keysym based i3 config file (based on
 /etc/i3/config.keycodes) in ~/.i3/config.
 

_docs/i3-input.man

@@ -1,7 +1,7 @@
 i3-input(1)
-=========
+===========
 Michael Stapelberg <[email protected]>
-v4.1, September 2011
+v4.1.2, April 2012
 
 == NAME
 
@@ -17,15 +17,45 @@ 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 -F option takes a format string. In this string, every occurence of %s is
-replaced by the user input.
+You can press Escape to close i3-input without sending any commands.
 
-== EXAMPLE
+== 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 choose a font).
+
+-v::
+Show version and exit.
+
+== 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

_docs/i3-msg.man

@@ -1,35 +1,130 @@
 i3-msg(1)
 =========
-Michael Stapelberg <michael[email protected]>
-v3.delta, November 2009
+Michael Stapelberg <michael@i3wm.org>
+v4.2, August 2012
 
 == NAME
 
 i3-msg - send messages to i3 window manager
 
 == SYNOPSIS
 
-i3-msg "message"
+i3-msg  [-q] [-v] [-h] [-s socket] [-t type] [-r] [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. This option defaults to "command".
+
+*-m*, *--monitor*::
+Instead of exiting right after receiving the first subscribed event,
+wait indefinitely for all of them. Can only be used with "-t subscribe".
+See the "subscribe" IPC message type below for details.
+
+*-r, --raw*::
+Display the raw JSON reply instead of pretty-printing errors (for commands) or
+displaying the top-level config file contents (for GET_CONFIG).
+
+*message*::
+Send ipc message, see below.
+
+== IPC MESSAGE TYPES
+
+command::
+The payload of the message is a command for i3 (like the commands you can bind
+to keys in the configuration file) and will be executed directly after
+receiving it.
+
+get_workspaces::
+Gets the current workspaces. The reply will be a JSON-encoded list of
+workspaces.
+
+get_outputs::
+Gets the current outputs. The reply will be a JSON-encoded list of outputs (see
+the reply section of docs/ipc, e.g. at
+https://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
+container. The reply will be the JSON-encoded tree.
+
+get_marks::
+Gets a list of marks (identifiers for containers to easily jump to them later).
+The reply will be a JSON-encoded list of window marks.
+
+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_binding_modes::
+Gets a list of configured binding modes.
+
+get_version::
+Gets the version of i3. The reply will be a JSON-encoded dictionary with the
+major, minor, patch and human-readable version.
+
+get_config::
+Gets the currently loaded i3 configuration.
+
+send_tick::
+Sends a tick to all IPC connections which subscribe to tick events.
+
+subscribe::
+The payload of the message describes the events to subscribe to.
+Upon reception, each event will be dumped as a JSON-encoded object.
+See the -m option for continuous monitoring.
 
 == DESCRIPTION
 
 i3-msg is a sample implementation for a client using the unix socket IPC
-interface to i3. At the moment, it can only be used for sending commands
-(like in configuration file for key bindings), but this may change in the
-future (staying backwards-compatible, of course).
+interface to i3.
+
+=== Exit status:
+
+0:
+if OK,
+1:
+if invalid syntax or unable to connect to ipc-socket
+2:
+if i3 returned an error processing your command(s)
 
-== EXAMPLE
+== EXAMPLES
 
 ------------------------------------------------
-i3-msg "bp" # Use 1-px border for current client
+# Use 1-px border for current client
+i3-msg "border 1pixel"
+
+# You can leave out the quotes
+i3-msg border normal
+
+# Dump the layout tree
+i3-msg -t get_tree
+
+# Monitor window changes
+i3-msg -t subscribe -m '[ "window" ]'
 ------------------------------------------------
 
 == 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 determine the path, at which the unix domain socket is expected, on which
 to connect to i3.
 
 == SEE ALSO

_docs/i3-nagbar.man

@@ -9,7 +9,39 @@ i3-nagbar - displays an error bar on top of your screen
 
 == SYNOPSIS
 
-i3-nagbar -m 'message' -b 'label' 'action'
+i3-nagbar [-m <message>] [-b <button> <action>] [-B <button> <action>] [-t warning|error] [-f <font>] [-v] [-p]
+
+== OPTIONS
+
+*-v, --version*::
+Display version number and exit.
+
+*-h, --help*::
+Display a short help-message and exit.
+
+*-t, --type* 'type'::
+Display either a warning or error message. This only changes the color scheme
+for the i3-nagbar. Default: error.
+
+*-m, --message* 'message'::
+Display 'message' as text on the left of the i3-nagbar.
+
+*-f, --font* 'font'::
+Select font that is being used.
+
+*-b, --button* 'button' 'action'::
+Create a button with text 'button'. The 'action' are the shell commands that
+will be executed by this button. Multiple buttons can be defined.
+Will launch the shell commands inside a terminal emulator, using
+i3-sensible-terminal.
+
+*-B, --button-no-terminal* 'button' 'action'::
+Same as above, but will execute the shell commands directly, without launching a
+terminal emulator.
+
+*-p, --primary*::
+Always opens the i3-nagbar on the primary monitor. By default it opens on the
+focused monitor.
 
 == DESCRIPTION
 
@@ -22,7 +54,7 @@ after modifying the configuration file.
 
 ------------------------------------------------
 i3-nagbar -m 'You have an error in your i3 config file!' \
--b 'edit config' 'xterm $EDITOR ~/.i3/config'
+-b 'edit config' 'i3-sensible-editor ~/.config/i3/config'
 ------------------------------------------------
 
 == SEE ALSO