]> git.sur5r.net Git - i3/i3/commitdiff
Merge branch 'master' into next
authorMichael Stapelberg <michael@stapelberg.de>
Sat, 24 Dec 2011 14:37:13 +0000 (15:37 +0100)
committerMichael Stapelberg <michael@stapelberg.de>
Sat, 24 Dec 2011 14:37:13 +0000 (15:37 +0100)
1  2 
docs/userguide

diff --combined docs/userguide
index 5785eca9f4ce0dbc3d6e8076fc1156dbe69c1eda,e75f1ca10e7e2acb470402b10ec760b2031b2540..7145442d2d2659610574ea3a6013abde681ab482
@@@ -323,7 -323,7 +323,7 @@@ bindcode [Modifiers+]keycode comman
  *Examples*:
  --------------------------------
  # Fullscreen
- bindsym mod+f f
+ bindsym mod+f fullscreen
  
  # Restart
  bindsym mod+Shift+r restart
@@@ -519,7 -519,7 +519,7 @@@ use it, it has to be a UTF-8 encoded ar
  To get the class and instance, you can use +xprop+. After clicking on the
  window, you will see the following output:
  
- *xwininfo*:
+ *xprop*:
  -----------------------------------
  WM_CLASS(STRING) = "irssi", "URxvt"
  -----------------------------------
@@@ -619,7 -619,7 +619,7 @@@ Only clients that do not cover the whol
  used to paint it. If you use a color other than black for your terminals, you
  most likely want to set the client background color to the same color as your
  terminal program's background color to avoid black gaps between the rendered
- area of the termianal and the i3 border.
+ area of the terminal and the i3 border.
  
  Colors are in HTML hex format (#rrggbb), see the following example:
  
@@@ -799,28 -799,6 +799,28 @@@ bar 
  }
  ---------------------------
  
 +=== i3bar command
 +
 +By default i3 will just pass +i3bar+ and let your shell handle the execution,
 +searching your +$PATH+ for a correct version.
 +If you have a different +i3bar+ somewhere or the binary is not in your +$PATH+ you can
 +tell i3 what to execute.
 +
 +The specified command will be passed to +sh -c+, so you can use globbing and
 +have to have correct quoting etc.
 +
 +*Syntax*:
 +----------------------
 +i3bar_command command
 +----------------------
 +
 +*Example*:
 +-------------------------------------------------
 +bar {
 +    i3bar_command /home/user/bin/i3bar
 +}
 +-------------------------------------------------
 +
  === Statusline command
  
  i3bar can run a program and display every line of its +stdout+ output on the
@@@ -837,9 -815,7 +837,9 @@@ status_command comman
  
  *Example*:
  -------------------------------------------------
 -status_command i3status --config ~/.i3status.conf
 +bar {
 +    status_command i3status --config ~/.i3status.conf
 +}
  -------------------------------------------------
  
  === Display mode
@@@ -861,9 -837,7 +861,9 @@@ mode <dock|hide
  
  *Example*:
  ----------------
 -mode hide
 +bar {
 +    mode hide
 +}
  ----------------
  
  === Position
@@@ -879,9 -853,7 +879,9 @@@ position <top|bottom
  
  *Example*:
  ---------------------
 -position top
 +bar {
 +    position top
 +}
  ---------------------
  
  === Output(s)
@@@ -890,9 -862,6 +890,9 @@@ You can restrict i3bar to one or more o
  handle all outputs. Restricting the outputs is useful for using different
  options for different outputs by using multiple 'bar' blocks.
  
 +To make a particular i3bar instance handle multiple outputs, specify the output
 +directive multiple times.
 +
  *Syntax*:
  ---------------
  output <output>
  -------------------------------
  # big monitor: everything
  bar {
 -      output HDMI2
 -      status_command i3status
 +    # The display is connected either via HDMI or via DisplayPort
 +    output HDMI2
 +    output DP2
 +    status_command i3status
  }
  
  # laptop monitor: bright colors and i3status with less modules.
  bar {
 -      output LVDS1
 -      status_command i3status --config ~/.i3status-small.conf
 -      colors {
 -              background #000000
 -              statusline #ffffff
 -      }
 +    output LVDS1
 +    status_command i3status --config ~/.i3status-small.conf
 +    colors {
 +        background #000000
 +        statusline #ffffff
 +    }
  }
  -------------------------------
  
@@@ -935,14 -902,10 +935,14 @@@ tray_output <none|output
  *Example*:
  -------------------------
  # disable system tray
 -tray_output none
 +bar {
 +    tray_output none
 +}
  
  # show tray icons on the big monitor
 -tray_output HDMI2
 +bar {
 +    tray_output HDMI2
 +}
  -------------------------
  
  === Font
@@@ -957,9 -920,7 +957,9 @@@ font <font
  
  *Example*:
  --------------------------------------------------------------
 -font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
 +bar {
 +    font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
 +}
  --------------------------------------------------------------
  
  === Workspace buttons
@@@ -976,9 -937,7 +976,9 @@@ workspace_buttons <yes|no
  
  *Example*:
  --------------------
 -workspace_buttons no
 +bar {
 +    workspace_buttons no
 +}
  --------------------
  
  === Colors
@@@ -1018,16 -977,14 +1018,16 @@@ colors 
  
  *Example*:
  --------------------------------------
 -colors {
 -    background #000000
 -    statusline #ffffff
 -
 -    focused_workspace  #ffffff #285577
 -    active_workspace   #ffffff #333333
 -    inactive_workspace #888888 #222222
 -    urgent_workspace   #ffffff #900000
 +bar {
 +    colors {
 +        background #000000
 +        statusline #ffffff
 +
 +        focused_workspace  #ffffff #285577
 +        active_workspace   #ffffff #333333
 +        inactive_workspace #888888 #222222
 +        urgent_workspace   #ffffff #900000
 +    }
  }
  --------------------------------------
  
@@@ -1109,7 -1066,7 +1109,7 @@@ exec [--no-startup-id] comman
  bindsym mod+g exec gimp
  
  # Start the terminal emulator urxvt which is not yet startup-notification-aware
 -bindsym mod+enter exec --no-startup-id urxvt
 +bindsym mod+Return exec --no-startup-id urxvt
  ------------------------------
  
  The +--no-startup-id+ parameter disables startup-notification support for this
@@@ -1228,7 -1185,7 +1228,7 @@@ number or name of the workspace. To mov
  You can also switch to the next and previous workspace with the commands
  +workspace next+ and +workspace prev+, which is handy, for example, if you have
  workspace 1, 3, 4 and 9 and you want to cycle through them with a single key
- combination. Similarily, you can use +move workspace next+ and +move workspace
+ combination. Similarly, you can use +move workspace next+ and +move workspace
  prev+ to move a container to the next/previous workspace.
  
  [[back_and_forth]]
@@@ -1238,7 -1195,7 +1238,7 @@@ back_and_forth+
  To move a container to another xrandr output such as +LVDS1+ or +VGA1+, you can
  use the +move output+ command followed by the name of the target output. You
  may also use +left+, +right+, +up+, +down+ instead of the xrandr output name to
- move to the the next output in the specified direction.
+ move to the next output in the specified direction.
  
  *Examples*:
  -------------------------
@@@ -1456,40 -1413,6 +1456,40 @@@ bindsym mod+Shift+w reloa
  bindsym mod+Shift+e exit
  ----------------------------
  
 +=== Scratchpad
 +
 +There are two commands to use any existing window as scratchpad window. +move
 +scratchpad+ will move a window to the scratchpad workspace. This will make it
 +invisible until you show it again. There is no way to open that workspace.
 +Instead, when using +scratchpad show+, the window will be shown again, as a
 +floating window, centered on your current workspace (using +scratchpad show+ on
 +a visible scratchpad window will make it hidden again, so you can have a
 +keybinding to toggle).
 +
 +As the name indicates, this is useful for having a window with your favorite
 +editor always at hand. However, you can also use this for other permanently
 +running applications which you don’t want to see all the time: Your music
 +player, alsamixer, maybe even your mail client…?
 +
 +*Syntax*:
 +---------------
 +move scratchpad
 +
 +scratchpad show
 +---------------
 +
 +*Examples*:
 +------------------------------------------------
 +# Make the currently focused window a scratchpad
 +bindsym mod+Shift+minus move scratchpad
 +
 +# Show the first scratchpad window
 +bindsym mod+minus scratchpad show
 +
 +# Show the sup-mail scratchpad window, if any.
 +bindsym mod4+s [title="^Sup ::"] scratchpad show
 +------------------------------------------------
 +
  [[multi_monitor]]
  
  == Multiple monitors