From a02482256896d7adc4746778655fdb1c648aaf4c Mon Sep 17 00:00:00 2001 From: Kirill Chibisov Date: Thu, 23 Nov 2023 21:46:13 +0400 Subject: Explicitly use `=` in alacritty(5) This should help with understanding how to write TOML without reading too much into specification. --- extra/man/alacritty.5.scd | 218 +++++++++++++++++++++++----------------------- 1 file changed, 109 insertions(+), 109 deletions(-) (limited to 'extra') diff --git a/extra/man/alacritty.5.scd b/extra/man/alacritty.5.scd index 14e1428d..3fe05905 100644 --- a/extra/man/alacritty.5.scd +++ b/extra/man/alacritty.5.scd @@ -13,7 +13,7 @@ can be found at _https://toml.io/en/v1.0.0_. This section documents the root level of the configuration file. -*import* [_""_,] +*import* = [_""_,] Import additional configuration files. @@ -30,7 +30,7 @@ This section documents the root level of the configuration file. _"~/.config/alacritty/keybindings.toml"_,++ ] -*shell* _""_ | { program = _""_, args = [_""_,] } +*shell* = _""_ | { program = _""_, args = [_""_,] } You can set _shell.program_ to the path of your favorite shell, e.g. _/bin/zsh_. Entries in _shell.args_ are passed as arguments to the shell. @@ -44,20 +44,20 @@ Windows: _"powershell"_ program = _"/bin/zsh"_++ args = [_"-l"_] -*working_directory* _""_ | _"None"_ +*working_directory* = _""_ | _"None"_ Directory the shell is started in. When this is unset, or _"None"_, the working directory of the parent process will be used. Default: _"None"_ -*live_config_reload* _true_ | _false_ +*live_config_reload* = _true_ | _false_ Live config reload (changes require restart) Default: _true_ -*ipc_socket* _true_ | _false_ # _(unix only)_ +*ipc_socket* = _true_ | _false_ # _(unix only)_ Offer IPC using _alacritty msg_ @@ -77,7 +77,7 @@ WINIT_X11_SCALE_FACTOR = _"1.0"_ This section documents the *[window]* table of the configuration file. -*dimensions* { columns = __, lines = __ } +*dimensions* = { columns = __, lines = __ } Window dimensions (changes require restart). @@ -88,7 +88,7 @@ This section documents the *[window]* table of the configuration file. Default: { column = _0_, lines = _0_ } -*position* _"None"_ | { x = __, y = __ } +*position* = _"None"_ | { x = __, y = __ } Window startup position. @@ -98,20 +98,20 @@ This section documents the *[window]* table of the configuration file. Default: _"None"_ -*padding* { x = __, y = __ } +*padding* = { x = __, y = __ } Blank space added around the window in pixels. This padding is scaled by DPI and the specified value is always added at both opposing sides. Default: { x = _0_, y = _0_ } -*dynamic_padding* _true_ | _false_ +*dynamic_padding* = _true_ | _false_ Spread additional padding evenly around the terminal content. Default: _false_ -*decorations* _"Full"_ | _"None"_ | _"Transparent"_ | _"Buttonless"_ +*decorations* = _"Full"_ | _"None"_ | _"Transparent"_ | _"Buttonless"_ Window decorations. @@ -126,38 +126,38 @@ This section documents the *[window]* table of the configuration file. Default: _"Full"_ -*opacity* __ +*opacity* = __ Background opacity as a floating point number from _0.0_ to _1.0_. The value \_0.0_ is completely transparent and _1.0_ is opaque. Default: _1.0_ -*blur* _true_ | _false_ # _(works on macOS/KDE Wayland)_ +*blur* = _true_ | _false_ # _(works on macOS/KDE Wayland)_ Request compositor to blur content behind transparent windows. Default: _false_ -*startup_mode* _"Windowed"_ | _"Maximized"_ | _"Fullscreen"_ | _"SimpleFullscreen"_ +*startup_mode* = _"Windowed"_ | _"Maximized"_ | _"Fullscreen"_ | _"SimpleFullscreen"_ Startup mode (changes require restart) Default: _"Windowed"_ -*title* _""_ +*title* = _""_ Window title. Default: _"Alacritty"_ -*dynamic_title* _true_ | _false_ +*dynamic_title* = _true_ | _false_ Allow terminal applications to change Alacritty's window title. Default: _true_ -*class* { instance = _""_, general = _""_ } # _(Linux/BSD only)_ +*class* = { instance = _""_, general = _""_ } # _(Linux/BSD only)_ Window class. @@ -165,20 +165,20 @@ This section documents the *[window]* table of the configuration file. Default: { instance = _"Alacritty"_, general = _"Alacritty"_ } -*decorations_theme_variant* _"Dark"_ | _"Light"_ | _"None"_ +*decorations_theme_variant* = _"Dark"_ | _"Light"_ | _"None"_ Override the variant of the System theme/GTK theme/Wayland client side decorations. Set this to _"None"_ to use the system's default theme variant. Default: _"None"_ -*resize_increments* _true_ | _false_ +*resize_increments* = _true_ | _false_ Prefer resizing window by discrete steps equal to cell dimensions. Default: _false_ -*option_as_alt* _"OnlyLeft"_ | _"OnlyRight"_ | _"Both"_ | _"None"_ # _(macos only)_ +*option_as_alt* = _"OnlyLeft"_ | _"OnlyRight"_ | _"Both"_ | _"None"_ # _(macos only)_ Make _Option_ key behave as _Alt_. @@ -188,7 +188,7 @@ This section documents the *[window]* table of the configuration file. This section documents the *[scrolling]* table of the configuration file. -*history* __ +*history* = __ Maximum number of lines in the scrollback buffer.++ Specifying _0_ will disable scrolling.++ @@ -196,7 +196,7 @@ Limited to _100000_. Default: _10000_ -*multiplier* __ +*multiplier* = __ Number of line scrolled for every input scroll increment. @@ -206,54 +206,54 @@ Limited to _100000_. This section documents the *[font]* table of the configuration file. -*normal* { family = _""_, style = _""_ } +*normal* = { family = _""_, style = _""_ } Default: Linux/BSD: { family = _"monospace"_, style = _"Regular"_ }++ Windows: { family = _"Consolas"_, style = _"Regular"_ }++ macOS: { family = _"Menlo"_, style = _"Regular"_ } -*bold* { family = _""_, style = _""_ } +*bold* = { family = _""_, style = _""_ } If the family is not specified, it will fall back to the value specified for the normal font. Default: { style = _"Bold"_ } -*italic* { family = _""_, style = _""_ } +*italic* = { family = _""_, style = _""_ } If the family is not specified, it will fall back to the value specified for the normal font. Default: { style = _"Italic"_ } -*bold_italic* { family = _""_, style = _""_ } +*bold_italic* = { family = _""_, style = _""_ } If the family is not specified, it will fall back to the value specified for the normal font. Default: { style = _"Bold Italic"_ } -*size* __ +*size* = __ Font size in points. Default: _11.0_ -*offset* { x = __, y = __ } +*offset* = { x = __, y = __ } Offset is the extra space around each character. _y_ can be thought of as modifying the line spacing, and _x_ as modifying the letter spacing. Default: { x = _0_, y = _0_ } -*glyph_offset* { x = __, y = __ } +*glyph_offset* = { x = __, y = __ } Glyph offset determines the locations of the glyphs within their cells with the default being at the bottom. Increasing _x_ moves the glyph to the right, increasing _y_ moves the glyph upward. -*builtin_box_drawing* _true_ | _false_ +*builtin_box_drawing* = _true_ | _false_ When _true_, Alacritty will use a custom built-in font for box drawing characters (Unicode points _U+2500_ - _U+259F_) and powerline symbols @@ -269,22 +269,22 @@ Colors are specified using their hexadecimal values with a _#_ prefix: _#RRGGBB_ *primary* - *foreground* _""_ + *foreground* = _""_ Default: _"#d8d8d8"_ - *background* _""_ + *background* = _""_ Default: _"#181818"_ - *dim_foreground* _""_ + *dim_foreground* = _""_ If this is not set, the color is automatically calculated based on the foreground color. Default: _"#828482"_ - *bright_foreground* _""_ + *bright_foreground* = _""_ This color is only used when _draw\_bold\_text\_with\_bright\_colors_ is _true_. @@ -293,7 +293,7 @@ Colors are specified using their hexadecimal values with a _#_ prefix: _#RRGGBB_ Default: _"None"_ -*cursor* { text = _""_, cursor = _""_ } +*cursor* = { text = _""_, cursor = _""_ } Colors which should be used to draw the terminal cursor. @@ -302,7 +302,7 @@ Colors are specified using their hexadecimal values with a _#_ prefix: _#RRGGBB_ Default: { text = _"CellBackground"_, cursor = _"CellForeground"_ } -*vi_mode_cursor* { text = _""_, cursor = _""_ } +*vi_mode_cursor* = { text = _""_, cursor = _""_ } Colors for the cursor when the vi mode is active. @@ -318,17 +318,17 @@ Colors are specified using their hexadecimal values with a _#_ prefix: _#RRGGBB_ Allowed values are hexadecimal colors like _#ff00ff_, or _CellForeground_/_CellBackground_, which references the affected cell. - *matches* { foreground = _""_, background = _""_ } + *matches* = { foreground = _""_, background = _""_ } Default: { foreground = _"#181818"_, background = _"#ac4242"_ } - *focused_match* { foreground = _""_, background = _""_ } + *focused_match* = { foreground = _""_, background = _""_ } Default: { foreground = _"#181818"_, background = _"#f4bf75"_ } *hints* - *start* { foreground = _""_, background = _""_ } + *start* = { foreground = _""_, background = _""_ } First character in the hint label. @@ -337,7 +337,7 @@ Colors are specified using their hexadecimal values with a _#_ prefix: _#RRGGBB_ Default: { foreground = _"#181818"_, background = _"#f4bf75"_ } - *end* { foreground = _""_, background = _""_ } + *end* = { foreground = _""_, background = _""_ } All characters after the first one in the hint label. @@ -346,7 +346,7 @@ Colors are specified using their hexadecimal values with a _#_ prefix: _#RRGGBB_ Default: { foreground = _"#181818"_, background = _"#ac4242"_ } -*line_indicator* { foreground = _""_, background = _""_ } +*line_indicator* = { foreground = _""_, background = _""_ } Color used for the indicator displaying the position in history during search and vi mode. @@ -355,14 +355,14 @@ Colors are specified using their hexadecimal values with a _#_ prefix: _#RRGGBB_ Default: { foreground = _"None"_, background = _"None"_ } -*footer_bar* { foreground = _""_, background = _""_ } +*footer_bar* = { foreground = _""_, background = _""_ } Color used for the footer bar on the bottom, used by search regex input, hyperlink URI preview, etc. Default: { foreground = _"#181818"_, background = _"#d8d8d8"_ } -*selection* { text = _""_, background = _""_ } +*selection* = { text = _""_, background = _""_ } Colors used for drawing selections. @@ -373,40 +373,40 @@ Colors are specified using their hexadecimal values with a _#_ prefix: _#RRGGBB_ *normal* - *black* _""_ + *black* = _""_ Default: _"#181818"_ - *red* _""_ + *red* = _""_ Default: _"#ac4242"_ - *green* _""_ + *green* = _""_ Default: _"#90a959"_ - *yellow* _""_ + *yellow* = _""_ Default: _"#f4bf75"_ - *blue* _""_ + *blue* = _""_ Default: _"#6a9fb5"_ - *magenta* _""_ + *magenta* = _""_ Default: _"#aa759f"_ - *cyan* _""_ + *cyan* = _""_ Default: _"#75b5aa"_ - *white* _""_ + *white* = _""_ Default: _"#d8d8d8"_ *bright* - *black* _""_ + *black* = _""_ Default: _"#6b6b6b"_ - *red* _""_ + *red* = _""_ Default: _"#c55555"_ - *green* _""_ + *green* = _""_ Default: _"#aac474"_ - *yellow* _""_ + *yellow* = _""_ Default: _"#feca88"_ - *blue* _""_ + *blue* = _""_ Default: _"#82b8c8"_ - *magenta* _""_ + *magenta* = _""_ Default: _"#c28cb8"_ - *cyan* _""_ + *cyan* = _""_ Default: _"#93d3c3"_ - *white* _""_ + *white* = _""_ Default: _"#f8f8f8"_ *dim* @@ -414,31 +414,31 @@ Colors are specified using their hexadecimal values with a _#_ prefix: _#RRGGBB_ If the dim colors are not set, they will be calculated automatically based on the _normal_ colors. - *black* _""_ + *black* = _""_ Default: _"#0f0f0f"_ - *red* _""_ + *red* = _""_ Default: _"#712b2b"_ - *green* _""_ + *green* = _""_ Default: _"#5f6f3a"_ - *yellow* _""_ + *yellow* = _""_ Default: _"#a17e4d"_ - *blue* _""_ + *blue* = _""_ Default: _"#456877"_ - *magenta* _""_ + *magenta* = _""_ Default: _"#704d68"_ - *cyan* _""_ + *cyan* = _""_ Default: _"#4d7770"_ - *white* _""_ + *white* = _""_ Default: _"#8e8e8e"_ -*indexed_colors* [{ index = __, color = _""_ },] +*indexed_colors* = [{ index = __, color = _""_ },] The indexed colors include all colors from 16 to 256. When these are not set, they're filled with sensible defaults. Default: _[]_ -*transparent_background_colors* _true_ | _false_ +*transparent_background_colors* = _true_ | _false_ Whether or not _window.opacity_ applies to all cell backgrounds, or only to the default background. When set to _true_ all cells will be transparent @@ -446,7 +446,7 @@ Colors are specified using their hexadecimal values with a _#_ prefix: _#RRGGBB_ Default: _false_ -*draw_bold_text_with_bright_colors* _true_ | _false_ +*draw_bold_text_with_bright_colors* = _true_ | _false_ When _true_, bold text is drawn using the bright color variants. @@ -456,27 +456,27 @@ Colors are specified using their hexadecimal values with a _#_ prefix: _#RRGGBB_ This section documents the *[bell]* table of the configuration file. -*animation* _"Ease"_ | _"EaseOut"_ | _"EaseOutSine"_ | _"EaseOutQuad"_ | _"EaseOutCubic"_ +*animation* = _"Ease"_ | _"EaseOut"_ | _"EaseOutSine"_ | _"EaseOutQuad"_ | _"EaseOutCubic"_ \| _"EaseOutQuart"_ | _"EaseOutQuint"_ | _"EaseOutExpo"_ | _"EaseOutCirc"_ | _"Linear"_ Visual bell animation effect for flashing the screen when the visual bell is rung. Default: _"Linear"_ -*duration* __ +*duration* = __ Duration of the visual bell flash in milliseconds. A `duration` of `0` will disable the visual bell animation. Default: _0_ -*color* _""_ +*color* = _""_ Visual bell animation color. Default: _"#ffffff"_ -*command* _""_ | { program = _""_, args = [_""_,] } +*command* = _""_ | { program = _""_, args = [_""_,] } This program is executed whenever the bell is rung. @@ -488,14 +488,14 @@ This section documents the *[bell]* table of the configuration file. This section documents the *[selection]* table of the configuration file. -*semantic_escape_chars* _""_ +*semantic_escape_chars* = _""_ This string contains all characters that are used as separators for "semantic words" in Alacritty. Default: _",│`|:\"' ()[]{}<>\t"_ -*save_to_clipboard* _true_ | _false_ +*save_to_clipboard* = _true_ | _false_ When set to _true_, selected text will be copied to the primary clipboard. @@ -507,11 +507,11 @@ This section documents the *[cursor]* table of the configuration file. *style* - *shape* _"Block"_ | _"Underline"_ | _"Beam"_ + *shape* = _"Block"_ | _"Underline"_ | _"Beam"_ Default: _"Block"_ - *blinking* _"Never"_ | _"Off"_ | _"On"_ | _"Always"_ + *blinking* = _"Never"_ | _"Off"_ | _"On"_ | _"Always"_ *Never* Prevent the cursor from ever blinking @@ -533,13 +533,13 @@ This section documents the *[cursor]* table of the configuration file. Default: _"None"_ -*blink_interval* __ +*blink_interval* = __ Cursor blinking interval in milliseconds. Default: _750_ -*blink_timeout* __ +*blink_timeout* = __ Time after which cursor stops blinking, in seconds. @@ -547,14 +547,14 @@ This section documents the *[cursor]* table of the configuration file. Default: _5_ -*unfocused_hollow* _true_ | _false_ +*unfocused_hollow* = _true_ | _false_ When this is _true_, the cursor will be rendered as a hollow box when the window is not focused. Default: _true_ -*thickness* __ +*thickness* = __ Thickness of the cursor relative to the cell width as floating point number from _0.0_ to _1.0_. @@ -565,7 +565,7 @@ This section documents the *[cursor]* table of the configuration file. This section documents the *[terminal]* table of the configuration file. -*osc52* _"Disabled"_ | _"OnlyCopy"_ | _"OnlyPaste"_ | _"CopyPaste"_ +*osc52* = _"Disabled"_ | _"OnlyCopy"_ | _"OnlyPaste"_ | _"CopyPaste"_ Controls the ability to write to the system clipboard with the _OSC 52_ escape sequence. While this escape sequence is useful to copy contents @@ -579,13 +579,13 @@ This section documents the *[terminal]* table of the configuration file. This section documents the *[mouse]* table of the configuration file. -*hide_when_typing* _true_ | _false_ +*hide_when_typing* = _true_ | _false_ When this is _true_, the cursor is temporarily hidden when typing. Default: _false_ -*bindings*: [{ **, **, **, ** | ** },] +*bindings* = [{ **, **, **, ** | ** },] See _keyboard.bindings_ for full documentation on _mods_, _mode_, _action_, and _chars_. @@ -595,11 +595,11 @@ This section documents the *[mouse]* table of the configuration file. the event, actions for the event without the `Shift` modifier are triggered instead. - *mouse* _"Middle"_ | _"Left"_ | _"Right"_ | _"Back"_ | _"Forward"_ | __ + *mouse* = _"Middle"_ | _"Left"_ | _"Right"_ | _"Back"_ | _"Forward"_ | __ Mouse button which needs to be pressed to trigger this binding. - *action* ** | _"ExpandSelection"_ + *action* = ** | _"ExpandSelection"_ *ExpandSelection* Expand the selection to the current mouse cursor location. @@ -617,39 +617,39 @@ This section documents the *[hints]* table of the configuration file. Terminal hints can be used to find text or hyperlinks in the visible part of the terminal and pipe it to other applications. -*alphabet* _""_ +*alphabet* = _""_ Keys used for the hint labels. Default: _"jfkdls;ahgurieowpq"_ -*enabled* [{ **, **, **, **, **, ** **, ** },] +*enabled* = [{ **, **, **, **, **, ** **, ** },] Array with all available hints. Each hint must have at least one of _regex_ or _hyperlinks_ and either an _action_ or a _command_. - *regex* _""_ + *regex* = _""_ Regex each line will be compared against. - *hyperlinks* _true_ | _false_ + *hyperlinks* = _true_ | _false_ When this is _true_, all OSC 8 escape sequence hyperlinks will be included in the hints. - *post_processing* _true_ | _false_ + *post_processing* = _true_ | _false_ When this is _true_, heuristics will be used to shorten the match if there are characters likely not to be part of the hint (e.g. a trailing _._). This is most useful for URIs and applies only to _regex_ matches. - *persist* _true_ | _false_ + *persist* = _true_ | _false_ When this is _true_, hints remain persistent after selection. - *action* _"Copy"_ | _"Paste"_ | _"Select"_ | _"MoveViModeCursor"_ + *action* = _"Copy"_ | _"Paste"_ | _"Select"_ | _"MoveViModeCursor"_ *Copy* Copy the hint's text to the clipboard. @@ -660,21 +660,21 @@ _action_ or a _command_. *MoveViModeCursor* Move the vi mode cursor to the beginning of the hint. - *command* _""_ | { program = _""_, args = [_""_,] } + *command* = _""_ | { program = _""_, args = [_""_,] } Command which will be executed when the hint is clicked or selected with the _binding_. The hint's text is always attached as the last argument. - *binding* { key = _""_, mods = _""_, mode = _""_ } + *binding* = { key = _""_, mods = _""_, mode = _""_ } See _keyboard.bindings_ for documentation on available values. This controls which key binding is used to start the keyboard hint selection process. - *mouse* { mods = _""_, enabled = _true_ | _false_ } + *mouse* = { mods = _""_, enabled = _true_ | _false_ } See _keyboard.bindings_ for documentation on available _mods_. @@ -694,7 +694,7 @@ binding = { key = _"U"_, mods = _"Control|Shift"_ },++ This section documents the *[keyboard]* table of the configuration file. -*bindings*: [{ **, **, **, ** | ** },] +*bindings* = [{ **, **, **, ** | ** },] To unset a default binding, you can use the action _"ReceiveChar"_ to remove it or _"None"_ to inhibit any action. @@ -702,7 +702,7 @@ This section documents the *[keyboard]* table of the configuration file. Multiple keybindings can be triggered by a single key press and will be executed in the order they are defined in. - *key* _""_ + *key* = _""_ The regular keys like _"A"_, _"0"_, and _"Я"_ can be mapped directly without any special syntax. Full list of named keys like _"F1"_ and the @@ -718,22 +718,22 @@ _https://docs.rs/winit/latest/winit/keyboard/enum.Key.html#variant.Dead_ The _key_ field also supports using scancodes, which are specified as a decimal number. - *mods* _"Command"_ | _"Control"_ | _"Option"_ | _"Super"_ | _"Shift"_ | _"Alt"_ + *mods* = _"Command"_ | _"Control"_ | _"Option"_ | _"Super"_ | _"Shift"_ | _"Alt"_ Multiple modifiers can be combined using _|_, like this: _"Control | Shift"_. - *mode* _"AppCursor"_ | _"AppKeypad"_ | _"Search"_ | _"Alt"_ | _"Vi"_ + *mode* = _"AppCursor"_ | _"AppKeypad"_ | _"Search"_ | _"Alt"_ | _"Vi"_ This defines a terminal mode which must be active for this binding to have an effect. - Prepending _~_ to a mode will require the mode to *not* be active for + Prepending _~_ to a mode will require the mode to *not* = be active for the binding to take effect. Multiple modes can be combined using _|_, like this: _"~Vi|Search"_. - *chars* _""_ + *chars* = _""_ Writes the specified string to the terminal. @@ -947,19 +947,19 @@ Debug options are meant to help troubleshoot issues with Alacritty. These can change or be removed entirely without warning, so their stability shouldn't be relied upon. -*render_timer* _true_ | _false_ +*render_timer* = _true_ | _false_ Display the time it takes to draw each frame. Default: _false_ -*persistent_logging* _true_ | _false_ +*persistent_logging* = _true_ | _false_ Keep the log file after quitting Alacritty. Default: _false_ -*log_level* _"Off"_ | _"Error"_ | _"Warn"_ | _"Info"_ | _"Debug"_ | _"Trace"_ +*log_level* = _"Off"_ | _"Error"_ | _"Warn"_ | _"Info"_ | _"Debug"_ | _"Trace"_ Default: _"Warn"_ @@ -969,26 +969,26 @@ relied upon. Example: _ALACRITTY_EXTRA_LOG_TARGETS="winit;vte" alacritty -vvv_ -*renderer* _"glsl3"_ | _"gles2"_ | _"gles2_pure"_ | _"None"_ +*renderer* = _"glsl3"_ | _"gles2"_ | _"gles2_pure"_ | _"None"_ Force use of a specific renderer, _"None"_ will use the highest available one. Default: _"None"_ -*print_events* _true_ | _false_ +*print_events* = _true_ | _false_ Log all received window events. Default: _false_ -*highlight_damage* _true_ | _false_ +*highlight_damage* = _true_ | _false_ Highlight window damage information. Default: _false_ -*prefer_egl* _true_ | _false_ +*prefer_egl* = _true_ | _false_ Use EGL as display API if the current platform allows it. Note that transparency may not work with EGL on Linux/BSD. -- cgit v1.2.3-54-g00ecf