Skip to content

Commit

Permalink
docs: update for latest release
Browse files Browse the repository at this point in the history
  • Loading branch information
wez committed Sep 4, 2022
1 parent 3bb1ed6 commit ecd7bc9
Show file tree
Hide file tree
Showing 20 changed files with 34 additions and 30 deletions.
4 changes: 4 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ usually the best available version.

As features stabilize some brief notes about them will accumulate here.

* Not yet

### 20220903-194523-3bb1ed61

#### New

* Color schemes: [carbonfox](colorschemes/c/index.md#carbonfox), [DanQing Light (base16)](colorschemes/d/index.md#danqing-light-base16), [Dracula (Official)](colorschemes/d/index.md#dracula-official), [Poimandres](colorschemes/p/index.md#poimandres), [Poimandres Storm](colorschemes/p/index.md#poimandres-storm), [Sequoia Monochrome](colorschemes/s/index.md#sequoia-monochrome), [Sequoia Moonlight](colorschemes/s/index.md#sequoia-moonlight), [SynthwaveAlpha](colorschemes/s/index.md#synthwavealpha), [SynthwaveAlpha (Gogh)](colorschemes/s/index.md#synthwavealpha-gogh)
Expand Down
20 changes: 10 additions & 10 deletions docs/colorschemes/data.json
Original file line number Diff line number Diff line change
Expand Up @@ -4666,7 +4666,7 @@
"name": "carbonfox",
"origin_url": "https://github.com/EdenEast/nightfox.nvim",
"prefix": "c",
"wezterm_version": "nightly builds only"
"wezterm_version": "20220903-194523-3bb1ed61"
}
},
{
Expand Down Expand Up @@ -6381,7 +6381,7 @@
"name": "DanQing Light (base16)",
"origin_url": "https://github.com/CosmosAtlas/base16-danqing-scheme",
"prefix": "d",
"wezterm_version": "nightly builds only"
"wezterm_version": "20220903-194523-3bb1ed61"
}
},
{
Expand Down Expand Up @@ -7955,7 +7955,7 @@
"name": "Dracula (Official)",
"origin_url": "https://github.com/dracula/wezterm",
"prefix": "d",
"wezterm_version": "nightly builds only"
"wezterm_version": "20220903-194523-3bb1ed61"
}
},
{
Expand Down Expand Up @@ -20529,7 +20529,7 @@
"name": "Poimandres",
"origin_url": "https://github.com/olivercederborg/poimandres.nvim",
"prefix": "p",
"wezterm_version": "nightly builds only"
"wezterm_version": "20220903-194523-3bb1ed61"
}
},
{
Expand Down Expand Up @@ -20619,7 +20619,7 @@
"name": "Poimandres Storm",
"origin_url": "https://github.com/olivercederborg/poimandres.nvim",
"prefix": "p",
"wezterm_version": "nightly builds only"
"wezterm_version": "20220903-194523-3bb1ed61"
}
},
{
Expand Down Expand Up @@ -22517,7 +22517,7 @@
"name": "Sequoia Monochrome",
"origin_url": "https://github.com/Hiroya-W/wezterm-sequoia-theme",
"prefix": "s",
"wezterm_version": "nightly builds only"
"wezterm_version": "20220903-194523-3bb1ed61"
}
},
{
Expand Down Expand Up @@ -22557,7 +22557,7 @@
"name": "Sequoia Moonlight",
"origin_url": "https://github.com/Hiroya-W/wezterm-sequoia-theme",
"prefix": "s",
"wezterm_version": "nightly builds only"
"wezterm_version": "20220903-194523-3bb1ed61"
}
},
{
Expand Down Expand Up @@ -24984,7 +24984,7 @@
"name": "SynthwaveAlpha",
"origin_url": "https://github.com/mbadolato/iTerm2-Color-Schemes",
"prefix": "s",
"wezterm_version": "nightly builds only"
"wezterm_version": "20220903-194523-3bb1ed61"
}
},
{
Expand Down Expand Up @@ -25021,7 +25021,7 @@
"name": "SynthwaveAlpha (Gogh)",
"origin_url": "https://github.com/Gogh-Co/Gogh",
"prefix": "s",
"wezterm_version": "nightly builds only"
"wezterm_version": "20220903-194523-3bb1ed61"
}
},
{
Expand Down Expand Up @@ -29013,4 +29013,4 @@
"wezterm_version": "Always"
}
}
]
]
2 changes: 1 addition & 1 deletion docs/config/appearance.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The `color_scheme` option takes precedence over the `colors` section below,
and is mutually exclusive with it. If you want to merge/override colors
you need to use [wezterm.color.get_default_colors()](lua/wezterm.color/get_default_colors.md) and explicitly merge them.

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

The behavior has been changed so that the `color_scheme` you have selected, if
any, is used to define the colors, and then any colors you define in the
Expand Down
4 changes: 2 additions & 2 deletions docs/config/default-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ in a form that you can copy and paste into your own configuration.
| `SUPER` | `k` | `ClearScrollback="ScrollbackOnly"` |
| `CTRL+SHIFT` | `K` | `ClearScrollback="ScrollbackOnly"` |
| `CTRL+SHIFT` | `L` | `ShowDebugOverlay` (*Since: 20210814-124438-54e29167*)|
| `CTRL+SHIFT` | `P` | `PaneSelect` (*Since: nightly builds only*)|
| `CTRL+SHIFT` | `U` | `CharSelect` (*Since: nightly builds only*)|
| `CTRL+SHIFT` | `P` | `PaneSelect` (*Since: 20220903-194523-3bb1ed61*)|
| `CTRL+SHIFT` | `U` | `CharSelect` (*Since: 20220903-194523-3bb1ed61*)|
| `SUPER` | `f` | `Search={CaseSensitiveString=""}` |
| `CTRL+SHIFT` | `F` | `Search={CaseSensitiveString=""}` |
| `CTRL+SHIFT` | `X` | `ActivateCopyMode` |
Expand Down
2 changes: 1 addition & 1 deletion docs/config/launch.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ have `$SHELL` set in the environment, you will need to sign out and
sign back in again for the environment to pick up your new `$SHELL`
value.

*Since: nightly builds only*: wezterm will now always resolve the shell via the
*Since: 20220903-194523-3bb1ed61*: wezterm will now always resolve the shell via the
password database.

### On Windows Systems
Expand Down
2 changes: 1 addition & 1 deletion docs/config/lua/config/detect_password_input.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `detect_password_input = true`

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

When set to `true`, on unix systems, for local panes, wezterm will query the
*termios* associated with the PTY to see whether local echo is disabled and
Expand Down
4 changes: 2 additions & 2 deletions docs/config/lua/config/max_fps.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ Defaults to `60`.
|-------------|-----------------|
| Wayland | Ignored; instead, uses information from the compositor to schedule painting frames |
| X11 | Since: 20211204-082213-a66c61ee9 |
| macOS | Since: nightly builds only |
| Windows | Since: nightly builds only |
| macOS | Since: 20220903-194523-3bb1ed61 |
| Windows | Since: 20220903-194523-3bb1ed61 |

2 changes: 1 addition & 1 deletion docs/config/lua/config/window_frame.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ return {
}
```

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

You may explicitly add a border around the window area:

Expand Down
2 changes: 1 addition & 1 deletion docs/config/lua/keyassignment/ActivatePaneDirection.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ if the active pane is already the highest pane index.
`"Prev"` moves to the next lowest pane index, wrapping around to
the highest of the active pane is already the lowest pane index.

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

Ambiguous moves are now resolved by selecting the most recently activated pane
in a given direction, instead of based on the edge intersection.
2 changes: 1 addition & 1 deletion docs/config/lua/keyassignment/CharSelect.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CharSelect

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

Activates *Character Selection Mode*, which is a pop-over modal that allows you
to browse characters by category as well as fuzzy search by name or hex unicode
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CopyMode 'MoveBackwardSemanticZone'

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

Moves the CopyMode cursor position one semantic zone to the left.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CopyMode { MoveBackwardSemanticZone = ZONE }

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

Moves the CopyMode cursor position to the first semantic zone of the specified
type that precedes the current zone.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CopyMode 'MoveForewardSemanticZone'

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

Moves the CopyMode cursor position one semantic zone to the right.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CopyMode { MoveForwardSemanticZone = ZONE }

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

Moves the CopyMode cursor position to the next semantic zone of the specified
type that follows the current zone.
Expand Down
2 changes: 1 addition & 1 deletion docs/config/lua/keyassignment/CopyMode/SetSelectionMode.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ MODE can be one of:
* `"Word"` - selection expands by a word at a time
* `"Line"` - selection expands by a line at a time
* `"Block"` - selection expands to define a rectangular block using the starting point and current cursor position as the corners
* `"SemanticZone"` - selection expands to the current semantic zone. See [Shell Integration](../../../../shell-integration.md). (*Since: nightly builds only*).
* `"SemanticZone"` - selection expands to the current semantic zone. See [Shell Integration](../../../../shell-integration.md). (*Since: 20220903-194523-3bb1ed61*).

```lua
local wezterm = require 'wezterm'
Expand Down
2 changes: 1 addition & 1 deletion docs/config/lua/pane/get_metadata.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `pane:get_metadata()`

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

Returns metadata about a pane. The return value depends on the instance of the
underlying pane. If the pane doesn't support this method, `nil` will be returned.
Expand Down
2 changes: 1 addition & 1 deletion docs/config/lua/wezterm.gui/screens.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,4 @@ The screen information is a table with the following keys:

* `name` - the name of the screen.
* `x`, `y`, `width`, `height` - the bounds of this screen
* `max_fps` - the maximum refresh rate supported by the screen, if known, or `nil` otherwise. (*Since: nightly builds only*)
* `max_fps` - the maximum refresh rate supported by the screen, if known, or `nil` otherwise. (*Since: 20220903-194523-3bb1ed61*)
2 changes: 1 addition & 1 deletion docs/config/lua/window-events/update-right-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ if the hook takes longer than the
`wezterm` won't schedule another call until `status_update_interval`
milliseconds have elapsed since the last call completed.

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

This event is considered to be deprecated and you should migrate
to using [update-status](update-status.md), which behaves the
Expand Down
2 changes: 1 addition & 1 deletion docs/config/lua/window-events/update-status.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `update-status`

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

The `update-status` event is emitted periodically (based on the
interval specified by the [status_update_interval](../config/status_update_interval.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/config/lua/window-events/user-var-changed.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `user-var-changed`

*Since: nightly builds only*
*Since: 20220903-194523-3bb1ed61*

The `user-var-changed` event is emitted when a *user var* escape sequence is
used to set a user var.
Expand Down

0 comments on commit ecd7bc9

Please sign in to comment.