Skip to content

Commit

Permalink
update documentation for terminal_title
Browse files Browse the repository at this point in the history
  • Loading branch information
Canop committed Nov 20, 2023
1 parent b75a590 commit fdfc94a
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 2 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
### next
- `terminal_title` option in configuration - Fix #794
- `:toggle_tree` internal and `--tree` and `--no-tree` launch flags (experimental, feedback welcome) - Fix #670 - Thanks @eldad
- `{git-name}` verb argument

### v1.28.1 - 2023-11-13
<a name="v1.28.1"></a>
Expand Down
3 changes: 1 addition & 2 deletions resources/default-conf/conf.hjson
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,9 @@
# If you want the terminal's title to be updated when you change
# directory, set a terminal_title pattern by uncommenting one of
# the examples below and tuning it to your taste.
# Note that this may slow down some systems.
#
# terminal_title: "[broot] {git-name}"
# terminal_title: "🐄 {file}"
# terminal_title: "{file} 🐄"
# terminal_title: "-= {file-name} =-"

###############################################################
Expand Down
14 changes: 14 additions & 0 deletions website/docs/conf_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,20 @@ syntax_theme = "OceanLight"

Those themes come from [syntect](https://github.com/trishume/syntect) and are bundled in broot.


# Terminal title

If you set the `terminal_title` parameter, broot will change the title of the terminal when the current tree root changes.

The pattern allows using the same arguments than verb execution patterns, eg {file} or {git-name}.

```Hjson
terminal_title: "{file} 🐄"
```
```TOML
terminal_title = "{file} 🐄"
```

# Miscellaneous


Expand Down
1 change: 1 addition & 0 deletions website/docs/conf_verbs.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,7 @@ name | expanded to
`{other-panel-directory}` | closest directory, either `{file}` or `{parent}` in the other panel
`{root}` | current tree root (top of the displayed files tree)
`{git-root}` | The working directory of the Git repository containing the current selection
`{git-name}` | Name of the working directory of the current Git repository

!!! Note
when you're in the help screen, `{file}` is the configuration file, while `{directory}` is the configuration directory.
Expand Down

0 comments on commit fdfc94a

Please sign in to comment.