From: Michael Stapelberg Date: Mon, 12 Aug 2013 07:15:03 +0000 (+0200) Subject: fix userguide formatting X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=c6bab3de8575c29f42f57a2709bf7672769cdfaf;p=i3%2Fi3.github.io fix userguide formatting --- diff --git a/_docs/userguide b/_docs/userguide index f264599..76ac73a 100644 --- a/_docs/userguide +++ b/_docs/userguide @@ -570,11 +570,12 @@ set $m Mod1 bindsym $m+Shift+r restart ------------------------ -Variables are directly replaced in the file when parsing. There is no fancy -handling and there are absolutely no plans to change this. If you need a more -dynamic configuration you should create a little script which generates a -configuration file and run it before starting i3 (for example in your -+~/.xsession+ file). +Variables are directly replaced in the file when parsing. Variables expansion +is not recursive so it is not possible to define a variable with a value +containing another variable. There is no fancy handling and there are +absolutely no plans to change this. If you need a more dynamic configuration +you should create a little script which generates a configuration file and run +it before starting i3 (for example in your +~/.xsession+ file). === Automatically putting clients on specific workspaces @@ -1805,10 +1806,10 @@ debuglog ------------------------ *Examples*: ------------- +------------------------ # Enable/disable logging bindsym $mod+x debuglog toggle ------------- +------------------------ === Reloading/Restarting/Exiting diff --git a/docs/userguide.html b/docs/userguide.html index b203978..45d0f03 100644 --- a/docs/userguide.html +++ b/docs/userguide.html @@ -631,11 +631,12 @@ variables can be handy.

set $m Mod1
 bindsym $m+Shift+r restart
-

Variables are directly replaced in the file when parsing. There is no fancy -handling and there are absolutely no plans to change this. If you need a more -dynamic configuration you should create a little script which generates a -configuration file and run it before starting i3 (for example in your -~/.xsession file).

+

Variables are directly replaced in the file when parsing. Variables expansion +is not recursive so it is not possible to define a variable with a value +containing another variable. There is no fancy handling and there are +absolutely no plans to change this. If you need a more dynamic configuration +you should create a little script which generates a configuration file and run +it before starting i3 (for example in your ~/.xsession file).

4.12. Automatically putting clients on specific workspaces

@@ -1923,56 +1924,50 @@ likely useful in combination with the above-described [shmlog] 
debuglog <on|off|toggle>
- - - -
-

7. Examples:

-
-

# Enable/disable logging -bindsym $mod+x debuglog toggle

+

Examples:

-
=== Reloading/Restarting/Exiting
-
-You can make i3 reload its configuration file with +reload+. You can also
-restart i3 inplace with the +restart+ command to get it out of some weird state
-(if that should ever happen) or to perform an upgrade without having to restart
-your X session. To exit i3 properly, you can use the +exit+ command,
-however you don’t need to (simply killing your X session is fine as well).
-
-*Examples*:
+
# Enable/disable logging
+bindsym $mod+x debuglog toggle
-

bindsym $mod+Shift+r restart -bindsym $mod+Shift+w reload -bindsym $mod+Shift+e exit

+
+
+

6.14. Reloading/Restarting/Exiting

+

You can make i3 reload its configuration file with reload. You can also +restart i3 inplace with the restart command to get it out of some weird state +(if that should ever happen) or to perform an upgrade without having to restart +your X session. To exit i3 properly, you can use the exit command, +however you don’t need to (simply killing your X session is fine as well).

+

Examples:

-
=== 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
+
bindsym $mod+Shift+r restart
+bindsym $mod+Shift+w reload
+bindsym $mod+Shift+e exit

+
+
+
+

6.15. 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 +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). Note that this is just a normal floating window, so if you want to "remove it from scratchpad", you can simple make it tiling again -(+floating toggle+). - -As the name indicates, this is useful for having a window with your favorite +(floating 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…? +player, alsamixer, maybe even your mail client…?

+

Syntax:

+
+
+
move scratchpad
 
-*Syntax*:
+scratchpad show
-

move scratchpad

-
-
-
-

8. scratchpad show

-

Examples:

@@ -1985,8 +1980,9 @@ bindsym $mod+minus scratchpad show # Show the sup-mail scratchpad window, if any. bindsym mod4+s [title="^Sup ::"] scratchpad show
+
-

8.1. i3bar control

+

6.16. i3bar control

There are two options in the configuration of each i3bar instance that can be changed during runtime by invoking a command through i3. The commands bar hidden_state and bar mode allow setting the current hidden_state @@ -2020,7 +2016,7 @@ bindsym $mod+Shift+b bar mode invisible bar-1

-

9. Multiple monitors

+

7. Multiple monitors

As you can see in the goal list on the website, i3 was specifically developed with support for multiple monitors in mind. This section will explain how to @@ -2043,7 +2039,7 @@ create an unlimited number of workspaces in i3 and tie them to specific screens, you can have the "traditional" approach of having X workspaces per screen by changing your configuration (using modes, for example).

-

9.1. Configuring your monitors

+

7.1. Configuring your monitors

To help you get going if you have never used multiple monitors before, here is a short overview of the xrandr options which will probably be of interest to you. It is always useful to get an overview of the current screen configuration. @@ -2106,7 +2102,7 @@ only what you can see in xrandr.

See also [presentations] for more examples of multi-monitor setups.

-

9.2. Interesting configuration for multi-monitor environments

+

7.2. Interesting configuration for multi-monitor environments

There are several things to configure in i3 which may be interesting if you have more than one monitor:

    @@ -2143,10 +2139,10 @@ For information on how to move existing workspaces between monitors,
-

10. i3 and the rest of your software world

+

8. i3 and the rest of your software world

-

10.1. Displaying a status line

+

8.1. Displaying a status line

A very common thing amongst users of exotic window managers is a status line at some corner of the screen. It is an often superior replacement to the widget approach you have in the task bar of a traditional desktop environment.

@@ -2163,14 +2159,14 @@ on which hint the application sets. With i3bar, you can configure its position, see [i3bar_position].

-

10.2. Giving presentations (multi-monitor)

+

8.2. Giving presentations (multi-monitor)

When giving a presentation, you typically want the audience to see what you see on your screen and then go through a series of slides (if the presentation is simple). For more complex presentations, you might want to have some notes which only you can see on your screen, while the audience can only see the slides.

-

10.2.1. Case 1: everybody gets the same output

+

8.2.1. Case 1: everybody gets the same output

This is the simple case. You connect your computer to the video projector, turn on both (computer and video projector) and configure your X server to clone the internal flat panel of your computer to the video output:

@@ -2183,7 +2179,7 @@ your screen will be left untouched (it will show the X background). So, in our example, this would be 1024x768 (my notebook has 1280x800).

-

10.2.2. Case 2: you can see more than your audience

+

8.2.2. Case 2: you can see more than your audience

This case is a bit harder. First of all, you should configure the VGA output somewhere near your internal flat panel, say right of it: