Up to [cvs.NetBSD.org] / pkgsrc / sysutils / tealdeer
Request diff between arbitrary revisions
Keyword substitution: kv
Default branch: MAIN
tealdeer: update to 1.9.1 (security) This patch release updates tealdeer's dependencies. Most notably, the zip crate and the webpki roots are updated to the latest version. This prevents a hypothetical attack on tealdeer in which an attacker uses the recently compromised TLS certificates to pose as the archive source for updating the cache, and then serves a malicious zip archive that exploits vulnerabilities in the zip crate. I am not aware of any such attacks in the wild, but it can't hurt to play it safe and update. If you are using tealdeer versions before 1.9, please check whether your distribution ships an up-to-date build of your tealdeer version, or build tealdeer from source yourself (without using the committed lockfile). Additionally, this release contains bug fixes for three edge cases.
sysutils/tealdeer: update to 1.9.0
v1.9.0 (2026-08-24)
This release of tealdeer adds support for placeholder escaping and placeholder variants, and contains various improvements for configuring tealdeer.
Escaped placeholders are a special form of placeholders which are needed to render pages like docker compose correctly. Placeholder variants are a new feature of tldr pages that allows to specify both the short and long form of program flags in a tldr page. Tealdeer now parses these placeholders correctly and allows users to choose which variant should be displayed.
On MacOS, tealdeer now uses XDG directories by default. For backwards compatibility, if tealdeer configuration files or a page cache is already present at the previously used locations, they will still be used going forward. A side effect of this is that the directories used on Windows have changed. However, the new paths are more canonical, so there is no automatic migration for Windows users. Please use tldr --show-paths to move your configuration files to the new location.
In addition to relative paths, the config file now supports tilde expansion for file paths. Furthermore, users can now override any settings from the config file using the --override-config command line flag.
For details, please refer to the user documentation. Note that the user documentation has been moved from GitHub pages to our own domain. The new site allows you to select for which version of tealdeer you want to view the documentation.
Changes:
[added] Support for placeholder escaping (#414)
[added] Suggest trying different TLS backend when update fails (#465)
[added] Add builtin tldr tealdeer page (#472)
[added] Add display.indent config option (#471)
[added] Support tilde (~) expansion on config paths (#476)
[added] Add updates.warn_cache_age config option (#492)
[added] Add --override-config flag (#458)
[added] Support for placeholder variants (#512)
[added] Add version support to published docs (#358)
[changed] Support XDG directory spec on macOS by switching app_dirs2 to etcetera (#467)
[changed] Silence the missing-cache message under --quiet (#500)
[changed] Allow --no-auto-update without a command (#501)
[changed] Bump edition to 2024 (#510)
[changed] Error on unknown config keys (#516)
[chore] Add native Windows ARM64 release and tests in CI (#502, #503)
[removed] Remove cleanup code for old pages directory (#514)
tealdeer: update to 1.8.1 This patch release tweaks the enabled features for ureq, the library we use to perform HTTP requests when updating the cache. In particular, support for socks proxies is now enabled.
tealdeer: update to 1.8.0 v1.8.0 (2025-10-03) One year and one day have passed since tealdeer version 1.7.0 was released, so it's time for an update! Tealdeer 1.8 comes with a complete rewrite of the page cache and contains many long awaited improvements around it. Firstly, tealdeer now supports language-specific downloads. This means that only the pages matching the configured languages are downloaded when updating the cache. The languages used for searching pages can be configured separately to the ones used for updating, so it is possible to download pages in languages that are not usually queried. Next to configuring which languages are used for searching, it is now also possible to specify which platforms are used in the config file. Importantly, the default behavior for page search has changed so that all platforms are searched if no page is found for the platform that tealdeer is running on. To restore the behavior of tealdeer 1.7, users should set [search] platforms = ["current", "common"] in their config file. Coming back to updating, the default build configuration of tealdeer now includes multiple TLS backends. This means that tealdeer does not have to be rebuilt to try out a different TLS backend. The used backend can be chosen in the config file. By default, tealdeer comes with support for rustls using webpki certificates or system certificates. Native TLS is supported, but not enabled by default to avoid build troubles with OpenSSL and musl.
sysutils/tealdeer: update to 1.7.2
v1.7.2 (2025-03-18)
This patch release updates the zip dependency to mitigate a potential security vulnerability. A successful attack against tealdeer users would require manipulation of the tldr pages archive downloaded during an update. As the archive is downloaded from a trusted source (the tldr-pages organization), it seems very unlikely that running a version of tealdeer prior to 1.7.2 poses a security risk. Nevertheless, it cannot hurt to rule out any chance of an attack by updating tealdeer to version 1.7.2.
For more details, please see https://github.com/advisories/GHSA-94vh-gphv-8pm8.
[security] Require zip >= 2.3.0
[chore] Run CI on backport branches and on dispatch
sysutils/tealdeer: needs sse2
sysutils/tealdear: not for i386
tealdeer: update to 1.7.1 This patch release updates the yansi dependency to version 1, so that the previous versions of yansi can be removed from the package sets of Linux distributions. This change should not impact the behavior of tealdeer.
sysutils/tealdeer: add MSRV
tealdeer: update to 1.7.0 Now comes with shortened manpages for FreeBSD, NetBSD and OpenBSD!
*: bump for openssl 3
tealdeer: update to 1.6.1 - [fixed] Fix path source for custom pages dir - [chore] Update dependendencies
sysutils/tealdeer: update to 1.6.0 v1.6.0 (2022-10-02) It's been 9 months since the last release already! This is not a huge update feature-wise, but it still contains a few nice new improvements and a few bugfixes, contributed by 11 different people. The most important new feature is probably the option to override the cache directory through the config file. The TEALDEER_CACHE_DIR env variable is now deprecated. A note to packagers: Shell completions have been moved to the completion/ subdirectory! Packaging scripst might need to be updated. Changes: [added] Allow overriding cache directory through config (#276) [added] Add --no-auto-update CLI flag (#257) [added] Show note about auto-updates when cache is missing (#254) [added] Add support for android platform (#274) [added] Add custom pages to list output (#285) [fixed] Cache: Return error if HTTP client cannot be created (#247) [fixed] Handle cache download errors (#253) [fixed] Do not page output of tldr --update (#231) [fixed] Create macOS release builds with bundled root certificates (#272) [fixed] Clean up and fix shell completions (#262) [deprecated] The TEALDEER_CACHE_DIR env variable is now deprecated (#276) [removed] The --config-path command was removed, use --show-paths instead (#290) [removed] The -o/--os command was removed, use -p/--platform instead (#290) [removed] The -m/--markdown command was removed, use -r/--raw instead (#290) [chore] Move shell completion scripts to their own directory (#259) [chore] Update dependencies (#271, #287, #291) [chore] Use anyhow for error handling (#249) [chore] Switch to Rust 2021 edition (#284)
tealdeer: update to 1.5.0. v1.5.0 (2021-12-31) This is quite a big release with many new features. In the 15 months since the last release, 59 pull requests from 16 different contributors were merged! The highlights: - Custom pages and patches: You can now create your own local-only tldr pages. But not just that, you can also extend existing upstream pages with your own examples. - Change argument parsing from docopt to clap: We replaced docopt.rs as argument parsing library with clap v3, resulting in almost 1 MiB smaller binaries and a 22% speed increase when rendering a tldr page. - Multi-language support: You can now override the language with -L/--language. - A new `--show-paths` command: By running tldr --show-paths, you can list the currently used config dir, cache dir, upstream pages dir and custom pages dir. - Compliance with the tldr client spec v1.5: We renamed -o/--os to -p/--platform and implemented transparent lowercasing of the page names. - Docs: The README based documentation has reached its limits. There are now new mdbook based docs over at https://dbrgn.github.io/tealdeer/, we hope these make using tealdeer easier. Of course, documentation improvements are welcome! Also, if you're confused about how to use a certain feature, feel free to open an issue, this way we can improve the docs.
Update tldr to 1.4.1. v1.4.1 (2020-09-04) - [fixed] Syntax error in zsh completion file v1.4.0 (2020-09-03) - [added] Configurable automatic cache updates - [added] Improved color detection and support for `--color` argument and `NO_COLOR` env variable - [changed] Make `--list` option comply with official spec - [changed] Move cache age warning to stderr
cargo users: drop do-build target where redundant
rust/cargo: replace "--frozen --locked" with "--offline" in various places The intent of "--frozen --locked" was to not use the network, but the new "--offline" option is better suited for this purpose. It for example allows us to patch Cargo.toml if necessary without having to regen checksums.
Rename rust-bin's PKGNAME to rust-bin. Add rust.mk for rust packages. This allows rust-bin and rust to coexist in bulk builds (for testing, etc), but the packages still may not be installed at the same time. rust.mk as a solution for picking the correct rust variant was suggested by gdt@. It is intended to be included directly by packages that do not use cargo.mk, and indirectly by packages that do use cargo.mk. rust.mk provides one user-settable variable: RUST_TYPE as before, whether to bootstrap rust from source or use official binaries. may be "src" or "bin" And two package-settable variables: RUST_REQ the minimum version of Rust required by the package. defaults to "1.20.0" RUST_RUNTIME whether Rust is a runtime dependency, may be "yes" or "no"
Add a package for tealdeer-1.3.0. Via wip. A very fast implementation of tldr in Rust: Simplified, example based and community-driven man pages. If you pronounce "tldr" in English, it sounds somewhat like "tealdeer". Hence the project name.