Fix documentation for border styles.

This commit is contained in:
Ingo Bürk 2015-06-09 23:13:40 +02:00
parent 9571200baa
commit 9940571069
4 changed files with 26 additions and 17 deletions

View File

@ -517,20 +517,20 @@ workspace_layout tabbed
=== Border style for new windows
This option determines which border style new windows will have. The default is
"normal". Note that new_float applies only to windows which are starting out as
floating windows, e.g. dialog windows.
+normal+. Note that new_float applies only to windows which are starting out as
floating windows, e.g., dialog windows, but not windows that are floated later on.
*Syntax*:
---------------------------------------------
new_window normal|1pixel|none|pixel
new_window normal|none|pixel
new_window normal|pixel <px>
new_float normal|1pixel|none|pixel
new_float normal|none|pixel
new_float normal|pixel <px>
---------------------------------------------
*Example*:
---------------------
new_window 1pixel
new_window pixel
---------------------
The "normal" and "pixel" border styles support an optional border width in
@ -579,7 +579,7 @@ for_window <criteria> <command>
for_window [class="XTerm"] floating enable
# Make all urxvts use a 1-pixel border:
for_window [class="urxvt"] border 1pixel
for_window [class="urxvt"] border pixel 1
# A less useful, but rather funny example:
# makes the window floating as soon as I change
@ -2045,21 +2045,29 @@ seperate bindings for a specific set of labels and then only use those labels.
=== Changing border style
To change the border of the current client, you can use +border normal+ to use the normal
border (including window title), +border 1pixel+ to use a 1-pixel border (no window title)
border (including window title), +border pixel 1+ to use a 1-pixel border (no window title)
and +border none+ to make the client borderless.
There is also +border toggle+ which will toggle the different border styles.
*Examples*:
----------------------------
bindsym $mod+t border normal
bindsym $mod+y border 1pixel
bindsym $mod+u border none
----------------------------
*Syntax*:
-----------------------------------------------
border normal|pixel [<n>]
border none|toggle
# legacy syntax, equivalent to "border pixel 1"
border 1pixel
-----------------------------------------------
*Examples*:
----------------------------------------------
# use window title, but no border
bindsym $mod+t border normal 0
# use no window title and a thick border
bindsym $mod+y border pixel 3
# use neither window title nor border
bindsym $mod+u border none
----------------------------------------------
[[shmlog]]

View File

@ -67,7 +67,7 @@ void cmd_move_con_to_workspace_number(I3_CMD, char *which);
void cmd_resize(I3_CMD, char *way, char *direction, char *resize_px, char *resize_ppt);
/**
* Implementation of 'border normal|none|1pixel|toggle'.
* Implementation of 'border normal|pixel [<n>]', 'border none|1pixel|toggle'.
*
*/
void cmd_border(I3_CMD, char *border_style_str, char *border_width);

View File

@ -77,7 +77,8 @@ state DEBUGLOG:
argument = 'toggle', 'on', 'off'
-> call cmd_debuglog($argument)
# border normal|none|1pixel|toggle|1pixel
# border normal|pixel [<n>]
# border none|1pixel|toggle
state BORDER:
border_style = 'normal', 'pixel'
-> BORDER_WIDTH

View File

@ -816,7 +816,7 @@ void cmd_resize(I3_CMD, char *way, char *direction, char *resize_px, char *resiz
}
/*
* Implementation of 'border normal|none|1pixel|toggle|pixel'.
* Implementation of 'border normal|pixel [<n>]', 'border none|1pixel|toggle'.
*
*/
void cmd_border(I3_CMD, char *border_style_str, char *border_width) {