applications/i3
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Made syntax of syntax descriptions consistent:

Browse Source 
* <xyz> denotes that some string must be used which is not a fixed value (e.g., a command), but a variable string (text, a number, ...)
* [xyz] denotes that the parameter is optional
* abc|xyz denotes that either abc or xyz must be given
This commit is contained in:
Ingo Bürk 2015-05-12 18:07:01 -04:00
parent 1aa42794ed
commit 94a46a1e35
2 changed files with 114 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

226
docs/userguide
View File

@ -320,7 +320,7 @@ and fall back to a working font.
*Syntax*: *Syntax*:
------------------------------ ------------------------------
font <X core font description> font <X core font description>
font pango:[family list] [style options] [size] font pango:<family list> [<style options>] <size>
------------------------------ ------------------------------
*Examples*: *Examples*:
@ -361,8 +361,8 @@ after the keys have been released.
*Syntax*: *Syntax*:
---------------------------------- ----------------------------------
bindsym [--release] [Modifiers+]keysym command bindsym [--release] [<Modifiers>+]<keysym> command
bindcode [--release] [Modifiers+]keycode command bindcode [--release] [<Modifiers>+]<keycode> command
---------------------------------- ----------------------------------
*Examples*: *Examples*:
@ -404,9 +404,9 @@ button in the scope of the clicked container (see <<command_criteria>>). You
can configure mouse bindings in a similar way to key bindings. can configure mouse bindings in a similar way to key bindings.
*Syntax*: *Syntax*:
---------------------------------- -------------------------------------------------------------------------------
bindsym [--release] [--border] [--whole-window] [Modifiers+]button[n] command bindsym [--release] [--border] [--whole-window] [<Modifiers>+]button<n> command
---------------------------------- -------------------------------------------------------------------------------
By default, the binding will only run when you click on the titlebar of the By default, the binding will only run when you click on the titlebar of the
window. If the +--release+ flag is given, it will run when the mouse button window. If the +--release+ flag is given, it will run when the mouse button
@ -451,7 +451,7 @@ ratio will be preserved).
*Syntax*: *Syntax*:
-------------------------------- --------------------------------
floating_modifier <Modifiers> floating_modifier <Modifier>
-------------------------------- --------------------------------
*Example*: *Example*:
@ -490,9 +490,9 @@ With the +default_orientation+ configuration directive, you can override that
behavior. behavior.
*Syntax*: *Syntax*:
---------------------------------------------- --------------------------------------------
default_orientation <horizontal|vertical|auto> default_orientation horizontal|vertical|auto
---------------------------------------------- --------------------------------------------
*Example*: *Example*:
---------------------------- ----------------------------
@ -509,7 +509,7 @@ See also <<stack-limit>>.
*Syntax*: *Syntax*:
--------------------------------------------- ---------------------------------------------
workspace_layout <default|stacking|tabbed> workspace_layout default|stacking|tabbed
--------------------------------------------- ---------------------------------------------
///////////////////////////////////////////// /////////////////////////////////////////////
new_container stack-limit <cols|rows> <value> new_container stack-limit <cols|rows> <value>
@ -528,8 +528,10 @@ floating windows, e.g. dialog windows.
*Syntax*: *Syntax*:
--------------------------------------------- ---------------------------------------------
new_window <normal|1pixel|none|pixel> new_window normal|1pixel|none|pixel
new_float <normal|1pixel|none|pixel> new_window normal|pixel <px>
new_float normal|1pixel|none|pixel
new_float normal|pixel <px>
--------------------------------------------- ---------------------------------------------
*Example*: *Example*:
@ -557,9 +559,9 @@ You can hide vertical borders adjacent to the screen edges using
to waste even two pixels in displayspace. Default is none. to waste even two pixels in displayspace. Default is none.
*Syntax*: *Syntax*:
---------------------------- -----------------------------------------------
hide_edge_borders <none|vertical|horizontal|both> hide_edge_borders none|vertical|horizontal|both
---------------------------- -----------------------------------------------
*Example*: *Example*:
---------------------- ----------------------
@ -573,9 +575,9 @@ encounters a specific window. This can be used to set windows to floating or to
change their border style, for example. change their border style, for example.
*Syntax*: *Syntax*:
----------------------------- -------------------------------
for_window <criteria> command for_window <criteria> <command>
----------------------------- -------------------------------
*Examples*: *Examples*:
------------------------------------------------ ------------------------------------------------
@ -622,9 +624,9 @@ yourself some typing and be able to change the modifier you use later,
variables can be handy. variables can be handy.
*Syntax*: *Syntax*:
-------------- -------------------
set $name value set $<name> <value>
-------------- -------------------
*Example*: *Example*:
------------------------ ------------------------
@ -660,7 +662,7 @@ considered.
*Syntax*: *Syntax*:
------------------------------------------------------------ ------------------------------------------------------------
assign <criteria> [→] workspace assign <criteria> [→] [workspace] <workspace>
------------------------------------------------------------ ------------------------------------------------------------
*Examples*: *Examples*:
@ -729,10 +731,10 @@ and +,+ (comma): they chain commands together in i3 and need to be escaped if
you want to use them in your command. you want to use them in your command.
*Syntax*: *Syntax*:
------------------- ---------------------------------------
exec [--no-startup-id] command exec [--no-startup-id] <command>
exec_always [--no-startup-id] command exec_always [--no-startup-id] <command>
------------------- ---------------------------------------
*Examples*: *Examples*:
-------------------------------- --------------------------------
@ -756,9 +758,9 @@ or when starting (e.g., by default it will use 1 for the first screen, 2 for
the second screen and so on). the second screen and so on).
*Syntax*: *Syntax*:
---------------------------------- -------------------------------------
workspace <workspace> output <output> workspace <workspace> output <output>
---------------------------------- -------------------------------------
The 'output' is the name of the RandR output you attach your screen to. On a The 'output' is the name of the RandR output you attach your screen to. On a
laptop, you might have VGA1 and LVDS1 as output names. You can see the laptop, you might have VGA1 and LVDS1 as output names. You can see the
@ -778,9 +780,9 @@ workspace "2: vim" output VGA1
You can change all colors which i3 uses to draw the window decorations. You can change all colors which i3 uses to draw the window decorations.
*Syntax*: *Syntax*:
-------------------------------------------- ------------------------------------------------------
colorclass border background text indicator <colorclass> <border> <background> <text> <indicator>
-------------------------------------------- ------------------------------------------------------
Where colorclass can be one of: Where colorclass can be one of:
@ -802,9 +804,9 @@ windows. This color will be used to paint the window on top of which the client
will be rendered. will be rendered.
*Syntax*: *Syntax*:
----------------------- -------------------------
client.background color client.background <color>
----------------------- -------------------------
Only clients that do not cover the whole area of this window expose the color Only clients that do not cover the whole area of this window expose the color
used to paint it. used to paint it.
@ -866,9 +868,9 @@ still be useful inside the currently active window (for example to click on
links in your browser window). links in your browser window).
*Syntax*: *Syntax*:
---------------------------- --------------------------
focus_follows_mouse <yes|no> focus_follows_mouse yes|no
---------------------------- --------------------------
*Example*: *Example*:
---------------------- ----------------------
@ -886,9 +888,9 @@ be warped. +none+ disables warping entirely, whereas +output+ is the default
behavior described above. behavior described above.
*Syntax*: *Syntax*:
--------------------------- -------------------------
mouse_warping <output|none> mouse_warping output|none
--------------------------- -------------------------
*Example*: *Example*:
------------------ ------------------
@ -910,9 +912,9 @@ There are three things which are possible to do in this situation:
3. Leave fullscreen mode. 3. Leave fullscreen mode.
*Syntax*: *Syntax*:
------------------------------------------------- -----------------------------------------------------
popup_during_fullscreen <smart|ignore|leave_fullscreen> popup_during_fullscreen smart|ignore|leave_fullscreen
------------------------------------------------- -----------------------------------------------------
*Example*: *Example*:
------------------------------ ------------------------------
@ -933,9 +935,9 @@ parent+ to switch to different containers, you can use the
will always wrap. will always wrap.
*Syntax*: *Syntax*:
----------------------------- ---------------------------
force_focus_wrapping <yes|no> force_focus_wrapping yes|no
----------------------------- ---------------------------
*Example*: *Example*:
------------------------ ------------------------
@ -955,9 +957,9 @@ For people who cannot modify their +~/.xsession+ to add the
+--force-xinerama+ commandline parameter, a configuration option is provided: +--force-xinerama+ commandline parameter, a configuration option is provided:
*Syntax*: *Syntax*:
----------------------- ---------------------
force_xinerama <yes|no> force_xinerama yes|no
----------------------- ---------------------
*Example*: *Example*:
------------------ ------------------
@ -977,9 +979,9 @@ mod+2 because somebody sent you a message. You don’t need to remember where yo
came from now, you can just press $mod+2 again to switch back to "1: www". came from now, you can just press $mod+2 again to switch back to "1: www".
*Syntax*: *Syntax*:
-------------------------------------- ------------------------------------
workspace_auto_back_and_forth <yes|no> workspace_auto_back_and_forth yes|no
-------------------------------------- ------------------------------------
*Example*: *Example*:
--------------------------------- ---------------------------------
@ -1021,9 +1023,9 @@ Note that this may not affect windows that are being opened. To prevent new wind
from being focused, see <<no_focus>>. from being focused, see <<no_focus>>.
*Syntax*: *Syntax*:
---------------------------------------------------- --------------------------------------------------
focus_on_window_activation <smart|urgent|focus|none> focus_on_window_activation smart|urgent|focus|none
---------------------------------------------------- --------------------------------------------------
The different modes will act as follows: The different modes will act as follows:
@ -1046,9 +1048,9 @@ this option is activated.
The default for this option is +yes+. The default for this option is +yes+.
*Syntax*: *Syntax*:
------------------- -----------------
show_marks [yes|no] show_marks yes|no
------------------- -----------------
*Example*: *Example*:
-------------- --------------
@ -1097,9 +1099,9 @@ The specified command will be passed to +sh -c+, so you can use globbing and
have to have correct quoting etc. have to have correct quoting etc.
*Syntax*: *Syntax*:
---------------------- -----------------------
i3bar_command command i3bar_command <command>
---------------------- -----------------------
*Example*: *Example*:
------------------------------------------------- -------------------------------------------------
@ -1119,9 +1121,9 @@ The specified command will be passed to +sh -c+, so you can use globbing and
have to have correct quoting etc. have to have correct quoting etc.
*Syntax*: *Syntax*:
---------------------- ------------------------
status_command command status_command <command>
---------------------- ------------------------
*Example*: *Example*:
------------------------------------------------- -------------------------------------------------
@ -1162,11 +1164,11 @@ The default mode is dock mode; in hide mode, the default modifier is Mod4 (usual
the windows key). The default value for the hidden_state is hide. the windows key). The default value for the hidden_state is hide.
*Syntax*: *Syntax*:
---------------- -------------------------
mode <dock|hide|invisible> mode dock|hide|invisible
hidden_state <hide|show> hidden_state hide|show
modifier <Modifier> modifier <Modifier>
---------------- ------------------------
*Example*: *Example*:
---------------- ----------------
@ -1226,9 +1228,9 @@ This option determines in which edge of the screen i3bar should show up.
The default is bottom. The default is bottom.
*Syntax*: *Syntax*:
--------------------- -------------------
position <top|bottom> position top|bottom
--------------------- -------------------
*Example*: *Example*:
--------------------- ---------------------
@ -1281,9 +1283,9 @@ You can configure on which output (monitor) the icons should be displayed or
you can turn off the functionality entirely. you can turn off the functionality entirely.
*Syntax*: *Syntax*:
------------------------- -------------------------------
tray_output <none|primary|output> tray_output none|primary|output
------------------------- -------------------------------
*Example*: *Example*:
------------------------- -------------------------
@ -1348,9 +1350,9 @@ you want to display a statusline-only bar containing additional information.
The default is to show workspace buttons. The default is to show workspace buttons.
*Syntax*: *Syntax*:
-------------------------- ------------------------
workspace_buttons <yes|no> workspace_buttons yes|no
-------------------------- ------------------------
*Example*: *Example*:
------------------------ ------------------------
@ -1373,9 +1375,9 @@ workspaces to "1:I", "2:II", "3:III", "4:IV", ...
The default is to display the full name within the workspace button. The default is to display the full name within the workspace button.
*Syntax*: *Syntax*:
---------------------------------- ------------------------------
strip_workspace_numbers <yes|no> strip_workspace_numbers yes|no
---------------------------------- ------------------------------
*Example*: *Example*:
---------------------------- ----------------------------
@ -1394,9 +1396,9 @@ For an example of a +mode+ definition, see <<resizingconfig>>.
The default is to show the mode indicator. The default is to show the mode indicator.
*Syntax*: *Syntax*:
------------------------------- -----------------------------
binding_mode_indicator <yes|no> binding_mode_indicator yes|no
------------------------------- -----------------------------
*Example*: *Example*:
----------------------------- -----------------------------
@ -1439,7 +1441,7 @@ colors {
statusline <color> statusline <color>
separator <color> separator <color>
colorclass <border> <background> <text> <colorclass> <border> <background> <text>
} }
---------------------------------------- ----------------------------------------
@ -1553,9 +1555,9 @@ and +,+ (comma): they chain commands together in i3 and need to be escaped if
you want to use them in your command. you want to use them in your command.
*Syntax*: *Syntax*:
------------------------------ --------------------------------
exec [--no-startup-id] command exec [--no-startup-id] <command>
------------------------------ --------------------------------
*Example*: *Example*:
------------------------------ ------------------------------
@ -1588,9 +1590,9 @@ orientation will be changed (if it does not have more than one window). Use
to splith or vice-versa. to splith or vice-versa.
*Syntax*: *Syntax*:
--------------------------- -------------------------
split <vertical|horizontal> split vertical|horizontal
--------------------------- -------------------------
*Example*: *Example*:
------------------------------ ------------------------------
@ -1613,10 +1615,10 @@ Likewise, to make the current window floating (or tiling again) use +floating
enable+ respectively +floating disable+ (or +floating toggle+): enable+ respectively +floating disable+ (or +floating toggle+):
*Syntax*: *Syntax*:
-------------- --------------------------------------------
layout <default|tabbed|stacking|splitv|splith> layout default|tabbed|stacking|splitv|splith
layout toggle [split|all] layout toggle [split|all]
-------------- --------------------------------------------
*Examples*: *Examples*:
-------------- --------------
@ -1737,14 +1739,14 @@ workspace using +move container to workspace back_and_forth+.
*Syntax*: *Syntax*:
----------------------------------- -----------------------------------
workspace <next|prev|next_on_output|prev_on_output> workspace next|prev|next_on_output|prev_on_output
workspace back_and_forth workspace back_and_forth
workspace <name> workspace <name>
workspace number <name> workspace number <name>
move [window|container] [to] workspace <name> move [window|container] [to] workspace <name>
move [window|container] [to] workspace number <name> move [window|container] [to] workspace number <name>
move [window|container] [to] workspace <prev|next|current> move [window|container] [to] workspace prev|next|current
----------------------------------- -----------------------------------
*Examples*: *Examples*:
@ -1836,10 +1838,10 @@ To move a container to another RandR output (addressed by names like +LVDS1+ or
+right+, +up+ or +down+), there are two commands: +right+, +up+ or +down+), there are two commands:
*Syntax*: *Syntax*:
-------------------------------------------------------- ----------------------------------------------------
move container to output <<left|right|down|up>|<output>> move container to output left|right|down|up|<output>
move workspace to output <<left|right|down|up>|<output>> move workspace to output left|right|down|up|<output>
-------------------------------------------------------- ----------------------------------------------------
*Examples*: *Examples*:
-------------------------------------------------------- --------------------------------------------------------
@ -1879,9 +1881,9 @@ If you want to resize containers/windows using your keyboard, you can use the
+resize+ command: +resize+ command:
*Syntax*: *Syntax*:
--------------------------------------------------------- -------------------------------------------------------
resize <grow|shrink> <direction> [<px> px [or <ppt> ppt]] resize grow|shrink <direction> [<px> px [or <ppt> ppt]]
--------------------------------------------------------- -------------------------------------------------------
Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
less specific and use +width+ or +height+, in which case i3 will take/give less specific and use +width+ or +height+, in which case i3 will take/give
@ -1968,9 +1970,9 @@ Refer to +show_marks+ if you don't want marks to be shown in the window decorati
*Syntax*: *Syntax*:
------------------------------ ------------------------------
mark [--toggle] identifier mark [--toggle] <identifier>
[con_mark="identifier"] focus [con_mark="identifier"] focus
unmark identifier unmark <identifier>
------------------------------ ------------------------------
*Example (in a terminal)*: *Example (in a terminal)*:
@ -2026,9 +2028,9 @@ in a stacking container. i3 will create columns or rows (depending on what
you limited) automatically as needed. you limited) automatically as needed.
*Syntax*: *Syntax*:
-------------------------------- -----------------------------
stack-limit <cols|rows> <value> stack-limit cols|rows <value>
-------------------------------- -----------------------------
*Examples*: *Examples*:
------------------- -------------------
@ -2056,7 +2058,7 @@ discarded and a new one will be started.
*Syntax*: *Syntax*:
------------------------------ ------------------------------
shmlog <size_in_bytes> shmlog <size_in_bytes>
shmlog <on|off|toggle> shmlog on|off|toggle
------------------------------ ------------------------------
*Examples*: *Examples*:
@ -2077,9 +2079,9 @@ command does not activate shared memory logging (shmlog), and as such is most
likely useful in combination with the above-described <<shmlog>> command. likely useful in combination with the above-described <<shmlog>> command.
*Syntax*: *Syntax*:
------------------------ ----------------------
debuglog <on|off|toggle> debuglog on|off|toggle
------------------------ ----------------------
*Examples*: *Examples*:
------------------------ ------------------------

2
parser-specs/config.spec
View File

@ -103,8 +103,6 @@ state WORKSPACE_LAYOUT:
# new_window <normal|1pixel|none> # new_window <normal|1pixel|none>
# new_float <normal|1pixel|none> # new_float <normal|1pixel|none>
# TODO: new_float is not in the userguide yet
# TODO: pixel is not in the userguide yet
state NEW_WINDOW: state NEW_WINDOW:
border = 'normal', 'pixel' border = 'normal', 'pixel'
-> NEW_WINDOW_PIXELS -> NEW_WINDOW_PIXELS