Remove cleanup code for old pages directory (#514)

In preparation for 1.9 release.

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/ci.yml

@@ -1,95 +1,92 @@
+name: CI
 on:
   push:
     branches:
       - main
+      - "v*.x"
   pull_request:
   schedule:
     - cron: '30 3 * * 2'
-
+  workflow_dispatch:
-name: CI
 
 jobs:
   test:
     name: run tests
     strategy:
       matrix:
-        platform: [ubuntu-latest, macos-latest, windows-latest]
+        platform: [ubuntu-latest, macos-latest, windows-latest, windows-11-arm]
-        rust: ['1.62', stable]
+        toolchain: [stable, 1.88.0] # MSRV
+        include:
+          - platform: windows-latest
+            exe_suffix: .exe
+          - platform: windows-11-arm
+            exe_suffix: .exe
     runs-on: ${{ matrix.platform }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v7
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: ${{ matrix.rust }}
+          toolchain: ${{ matrix.toolchain }}
-          profile: minimal
+      - run: mkdir artifacts
-          default: true
       - name: Build with default features
-        uses: actions-rs/cargo@v1
+        run: |
+          cargo build --locked
+          cp target/debug/tldr${{ matrix.exe_suffix}} artifacts/tldr-default${{ matrix.exe_suffix}}
+      - name: Build with logging and Rustls with webpki roots
+        run: |
+          cargo build --locked --features logging,rustls-with-webpki-roots --no-default-features
+          cp target/debug/tldr${{ matrix.exe_suffix}} artifacts/tldr-logging-rustls-webpki${{ matrix.exe_suffix}}
+      - name: Build with native TLS backend
+        run: |
+          # expects runners have the proper Native SSL library
+          cargo build --locked --features native-tls --no-default-features
+          cp target/debug/tldr${{ matrix.exe_suffix}} artifacts/tldr-native-tls${{ matrix.exe_suffix}}
+      - uses: actions/upload-artifact@v7
         with:
-          command: build
+          name: tldr-debug-build-${{ matrix.platform }}-rust-${{ matrix.toolchain }}
-      - name: Build with logging and webpki roots
+          path: artifacts/
-        uses: actions-rs/cargo@v1
-        with:
-          command: build
-          args: --features logging,webpki-roots --no-default-features
       - name: Run tests
-        uses: actions-rs/cargo@v1
+        run: cargo test --locked -- --test-threads 1
-        with:
-          command: test
 
   clippy:
     name: run clippy lints
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+       - uses: actions/checkout@v7
-      - uses: actions-rs/toolchain@v1
+       - uses: dtolnay/rust-toolchain@master
-        with:
+         with:
-          toolchain: stable
+           toolchain: 1.88.0 # MSRV
-          profile: minimal
+           components: clippy
-          default: true
+       - name: run clippy lints
-          components: clippy
+         run: cargo clippy --locked --all-targets --features logging
-      - uses: actions-rs/clippy-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --features logging
 
   fmt:
     name: run rustfmt
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+      - uses: actions/checkout@v7
-    - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@master
-      with:
+        with:
-        toolchain: stable
+          toolchain: stable
-        profile: minimal
+          components: rustfmt
-        default: true
+      - name: run rustfmt
-        components: rustfmt
+        run: cargo fmt --all -- --check
-    - uses: actions-rs/cargo@v1
-      with:
-        command: fmt
-        args: --all -- --check
 
   docs:
     name: build docs
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v7
-      - name: Setup mdBook
+      - run: ./scripts/get-mdbook.sh
-        uses: peaceiris/actions-mdbook@v1
+      - name: Setup toolchain
+        uses: dtolnay/rust-toolchain@master
         with:
-          mdbook-version: '0.4.4'
+            toolchain: stable
-      - uses: actions-rs/toolchain@v1
-        with:
-          toolchain: stable
-          profile: minimal
-          default: true
       - name: Build
-        uses: actions-rs/cargo@v1
+        run: cargo build --locked
-        with:
-          command: build
       - name: Ensure that docs can be built
-        run: cd docs && mdbook build
+        run: ./mdbook build docs
       - name: Generate usage string
-        run: cargo run -- --help > docs/src/usage-actual.txt
+        run: cargo run --locked -- --help > docs/src/usage-actual.txt
       - name: Ensure that usage string is up to date
         run: diff docs/src/usage{,-actual}.txt

.github/workflows/gh-pages.yml

@@ -1,25 +0,0 @@
-name: github pages
-
-on:
-  push:
-    branches:
-      - main
-
-jobs:
-  deploy:
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v2
-
-      - name: Setup mdBook
-        uses: peaceiris/actions-mdbook@v1
-        with:
-          mdbook-version: '0.4.4'
-
-      - run: cd docs && mdbook build
-
-      - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./docs/book

.github/workflows/release.yml

@@ -1,3 +1,4 @@
+name: Release
 on:
   push:
     tags:
@@ -5,25 +6,25 @@ on:
 
 jobs:
   create-release:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v7
       - name: Create release for tag
         if: startsWith(github.ref, 'refs/tags/')
         run: |
           source ./scripts/upload-asset.sh
           # Create:      <token>                     <repo>                   <tag>
-          create_release ${{ secrets.GITHUB_TOKEN }} ${{ github.repository }} ${GITHUB_REF#refs/*/} "Tealdeer version ${GITHUB_REF#refs/*/v}.\n\nFor the full changelog, see https://github.com/dbrgn/tealdeer/blob/main/CHANGELOG.md.\n\nBinaries were generated automatically in CI, and are therefore unsigned. For a fully trusted release, please build from source."
+          create_release ${{ secrets.GITHUB_TOKEN }} ${{ github.repository }} ${GITHUB_REF#refs/*/} "Tealdeer version ${GITHUB_REF#refs/*/v}.\n\nFor the full changelog, see https://github.com/tealdeer-rs/tealdeer/blob/main/CHANGELOG.md.\n\nBinaries were generated automatically in CI, and are therefore unsigned. For a fully trusted release, please build from source."
 
   upload-completions:
     needs:
       - create-release
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         target: ["bash", "fish", "zsh"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v7
       - name: Upload completion
         if: startsWith(github.ref, 'refs/tags/')
         run: |
@@ -34,12 +35,12 @@ jobs:
   upload-license:
     needs:
       - create-release
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         target: ["MIT", "APACHE"]
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v7
       - name: Upload license
         if: startsWith(github.ref, 'refs/tags/')
         run: |
@@ -48,12 +49,14 @@ jobs:
           upload_release_file ${{ secrets.GITHUB_TOKEN }} ${{ github.repository }} ${GITHUB_REF#refs/*/} LICENSE-${{ matrix.target }} LICENSE-${{ matrix.target }}.txt
 
   build-linux:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         include:
           - arch: "x86_64"
             libc: "musl"
+          - arch: "aarch64"
+            libc: "musl"
           - arch: "i686"
             libc: "musl"
           - arch: "armv7"
@@ -63,45 +66,61 @@ jobs:
           - arch: "arm"
             libc: "musleabihf"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v7
       - name: Pull Docker image
         run: docker pull messense/rust-musl-cross:${{ matrix.arch }}-${{ matrix.libc }}
       - name: Build in Docker
-        run: docker run --rm -i -v "$(pwd)":/home/rust/src messense/rust-musl-cross:${{ matrix.arch }}-${{ matrix.libc }} cargo build --release
+        run: docker run --rm -i -v "$(pwd)":/home/rust/src messense/rust-musl-cross:${{ matrix.arch }}-${{ matrix.libc }} cargo build --locked --release
       - name: Strip binary
         run: docker run --rm -i -v "$(pwd)":/home/rust/src messense/rust-musl-cross:${{ matrix.arch }}-${{ matrix.libc }} musl-strip -s /home/rust/src/target/${{ matrix.arch }}-unknown-linux-${{ matrix.libc }}/release/tldr
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v7
         with:
           name: "tealdeer-linux-${{ matrix.arch }}-${{ matrix.libc }}"
           path: "target/${{ matrix.arch }}-unknown-linux-${{ matrix.libc }}/release/tldr"
 
   build-macos:
-    runs-on: macos-11
+    runs-on: macos-latest
+    strategy:
+      matrix:
+        include:
+          - arch: "x86_64"
+          - arch: "aarch64"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v7
+      - name: Setup toolchain
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+          targets: "${{ matrix.arch }}-apple-darwin"
       - name: Build
-        uses: actions-rs/cargo@v1
+        run: cargo build --locked --release --target ${{ matrix.arch }}-apple-darwin
+      - uses: actions/upload-artifact@v7
         with:
-          command: build
+          name: "tealdeer-macos-${{ matrix.arch }}"
-          args: --release --target x86_64-apple-darwin --no-default-features --features webpki-roots
+          path: "target/${{ matrix.arch }}-apple-darwin/release/tldr"
-      - uses: actions/upload-artifact@v2
-        with:
-          name: "tealdeer-macos-x86_64"
-          path: "target/x86_64-apple-darwin/release/tldr"
 
   build-windows:
-    runs-on: windows-2022
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - arch: "x86_64"
+            os: windows-latest
+          - arch: "aarch64"
+            os: windows-11-arm
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v7
+      - name: Setup toolchain
+        uses: dtolnay/rust-toolchain@master
+        with:
+            toolchain: stable
+            targets: "${{ matrix.arch }}-pc-windows-msvc"
       - name: Build
-        uses: actions-rs/cargo@v1
+        run: cargo build --locked --release --target ${{ matrix.arch }}-pc-windows-msvc
+      - uses: actions/upload-artifact@v7
         with:
-          command: build
+          name: "tealdeer-windows-${{ matrix.arch }}-msvc"
-          args: --release --target x86_64-pc-windows-msvc
+          path: "target/${{ matrix.arch }}-pc-windows-msvc/release/tldr.exe"
-      - uses: actions/upload-artifact@v2
-        with:
-          name: "tealdeer-windows-x86_64-msvc"
-          path: "target/x86_64-pc-windows-msvc/release/tldr.exe"
 
   upload-release:
     needs:
@@ -109,20 +128,23 @@ jobs:
       - build-linux
       - build-macos
       - build-windows
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     strategy:
       matrix:
         target:
           - linux-x86_64-musl
+          - linux-aarch64-musl
           - linux-i686-musl
           - linux-armv7-musleabihf
           - linux-arm-musleabi
           - linux-arm-musleabihf
           - macos-x86_64
+          - macos-aarch64
           - windows-x86_64-msvc
+          - windows-aarch64-msvc
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v7
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v8
       - name: Upload binary
         if: startsWith(github.ref, 'refs/tags/')
         run: |

.readthedocs.yaml

@@ -0,0 +1,7 @@
+ version: 2
+
+ build:
+   os: ubuntu-26.04
+   commands:
+     - ./scripts/get-mdbook.sh
+     - ./mdbook build docs --dest-dir $READTHEDOCS_OUTPUT/html

CHANGELOG.md

@@ -13,6 +13,253 @@ Possible log types:
 - `[docs]` for documentation changes.
 - `[chore]` for maintenance work.
 
+### [v1.5.1][v1.5.1], [v1.6.2][v1.6.2], [v1.7.3][v1.7.3] (2026-01-25)
+
+Today I am releasing three patch updates for outdated versions of tealdeer.
+They are minimal patches for Linux distributions that ship old versions of
+tealdeer which recently broke due to an upstream change. If you can choose
+freely which version of tealdeer to use, I recommend using the latest version of
+tealdeer, 1.8.1. For more details, see the "Notes to package maintainers"
+section below.
+
+All three updates contain only a single change compared to their respective
+previous versions which changes the `ARCHIVE_URL` constant used for updating the
+page cache. The reason for this change is that the upstream tldr-pages
+repository shut down the domain that clients were previously required to use.
+
+Note that this issue is already fixed in tealdeer 1.8.0 where we introduced a
+config file option for changing the URL used at runtime. The versions 1.8.0 and
+1.8.1 also use the new domain of the tldr-pages archive by default, so no action
+is needed for users of those versions.
+
+#### Changes
+
+- [fixed] Update `ARCHIVE_URL`
+
+#### Notes to package maintainers
+
+I have _not_ updated the lockfile for any of these releases, so the locked
+dependency versions are still the same as they were for the previous release in
+the respective v1.x series. Updating the lockfile for tealdeer 1.5.0 to remove
+any `cargo audit` warnings while also maintaining compatibility with Rust 1.54
+also brings larger changes through transitive dependencies, which contradicts my
+plan to make this update easy to plug into existing build pipelines.
+
+If you want to build / distribute tealdeer v1.5.1, v1.6.2, or v1.7.3, please use
+an up to date Rust toolchain to permit updates to newer versions of (transitive)
+dependencies. Do not use the lockfile, instead update to the newest available
+dependency versions.
+
+For the same reason, there are no artifacts attached to the GitHub releases of
+these versions.
+
+### [v1.8.1][v1.8.1] (2025-11-11)
+
+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.
+
+#### Changes:
+
+- [added] Enable ureq's socks-proxy feature ([#451])
+
+### [v1.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
+```toml
+[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.
+
+For details, please refer to the [user documentation].
+
+#### Changes:
+
+- [added] Resolve paths in config `[directories]` relative to the config directory ([#306])
+- [added] Add `common` platform to CLI ([#401])
+- [added] Add configuration option for `archive_source` ([#337])
+- [added] Allows configuring TLS backend ([#386])
+- [added] Add args: `--edit-page` and `--edit-patch` ([#388])
+- [added] Add an option to specify a custom config file to be used ([#422])
+- [added] Upload binaries from build step as artifact ([#423])
+- [added] Add `search.languages` and `updates.download_languages` settings ([#430])
+- [added] Add `search.platforms` config option and search all platforms by default ([#435])
+- [added] Add `display.show_title` option to display command titles in output ([#439])
+- [chore] Various test improvements ([#399])
+- [chore] Add tests for osx/macos alias ([#407])
+- [chore] Move most of `main` to `try_main` ([#400])
+- [chore] Only create a single temporary directory in integration tests ([#411])
+- [chore] Replace reqwest with ureq ([#417])
+- [chore] Introduce Language struct ([#425])
+- [chore] Cache rewrite ([#416])
+- [chore] Allow references in `Config` ([#429])
+- [docs] Highlight code examples in user docs ([#440])
+- [removed] Remove native-tls from default feature set ([#436])
+
+#### Contributors to this version:
+
+- [Christoph Loy][@beatbrot]
+- [Erick Guan][@erickguan]
+- [@MHS-0][@MHS-0]
+- [Matěj Kafka][@MatejKafka]
+- [Nachiket Kanore][@nachiketkanore]
+- [Niklas Mohrin][@niklasmohrin]
+- [Predrag Minic][@mipedja]
+- [@hex1c][@hex1c]
+- [lyj][@lengyijun]
+
+Thanks!
+
+#### Notes to package maintainers
+
+1. The MSRV has been bumped to 1.85.
+2. Consider whether you want to include the `native-tls` feature in your build
+   of tealdeer. The feature is disabled for the binaries in the GitHub release
+   because we target musl, but it might work out of the box for your
+   distribution.
+3. We have added the `ignore-online-tests` feature to automatically mark all
+   tests that require an internet connection as skipped, so you can use this
+   feature instead of maintaining a list of these tests yourself.
+
+### [v1.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
+
+### [v1.7.1][v1.7.1] (2024-11-14)
+
+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.
+
+#### Changes:
+
+- [chore] Upgrade yansi: 0.5.1 -> 1.0.1 ([#389])
+
+#### Contributors to this version:
+
+- [Blair Noctis][@nc7s]
+
+Thanks!
+
+### [v1.7.0][v1.7.0] (2024-10-02)
+
+It's been 24 months since the last release, time for tealdeer 1.7.0! Thanks to
+16 individual contributors, a few nice changes and features are included in
+this release.
+
+One change is that you can **query multiple platforms at once**. For example:
+
+    tldr --platform openbsd --platform linux df
+
+This will show the `df` page for OpenBSD (if available), followed by Linux (if
+available), with fallback to the current platform on which tealdeer runs.
+
+What's that `openbsd` thing up there? Yes, there's now **support for the BSD
+platforms `freebsd`, `netbsd` and `openbsd`**.
+
+And since we're already talking about platform support: Our **binary releases
+now include builds for ARM64 (aka `aarch64`) on macOS (Apple Silicon, M1/M2/M3)
+and Linux**. _(Keep in mind that binary releases are generated in CI and are
+unsigned. For a trusted build, please compile from source.)_
+
+There's also a breaking change for the folks using [custom pages and
+patches](https://tealdeer-rs.github.io/tealdeer/usage_custom_pages.html): These
+files now use a `.md` extension. Old files will continue to work, but will
+result a deprecation warning being printed when used.
+
+On a personal note, this will be the last release from me
+([Danilo](https://github.com/dbrgn/)) as primary maintainer of tealdeer. For
+details, see [#376](https://github.com/tealdeer-rs/tealdeer/issues/376).
+
+#### Changes:
+
+- [added] Allow querying multiple platforms ([#300])
+- [added] Add BSD platform support ([#354])
+- [added] Allow building with native-tls in addition to rustls ([#303])
+- [changed] Change custom page files to use a `.md` file extension ([#322])
+- [changed] Update to clap v4 for doing command line parsing ([#298])
+- [changed] Performance optimization in LineIterator ([#314])
+- [changed] Performance optimizations by tweaking Cargo flags ([#355])
+- [changed] Include completions in published crate ([#333])
+- [changed] Minimal supported Rust version is now 1.75 ([#298])
+- [fixed] Fix bash/zsh/fish completions when cache is empty ([#327], [#331])
+- [docs] Publish docs only when tagging a release ([#362])
+- [docs] List Scoop and Debian packages ([#305], [#315])
+- [docs] Add "Tips and Tricks" chapter to user manual ([#342])
+- [docs] Various docs improvements ([#293])
+- [chore] Improvements to CI workflows ([#324])
+- [chore] Update Cargo.toml license field following SPDX 2.1 ([#336])
+- [chore] Dependency updates
+
+#### Contributors to this version:
+
+- [Adam Henley][@adamazing]
+- [Andrea Frigido][@frisoft]
+- [Blair Noctis][@nc7s]
+- [Danilo Bargen][@dbrgn]
+- [Felix Yan][@felixonmars]
+- [Iliia Maleki][@iliya-malecki]
+- [JJ Style][@jj-style]
+- [K.B.Dharun Krishna][@kbdharun]
+- [Linus Walker][@Walker-00]
+- [Mohit Raj][@agrmohit]
+- [Nicolai Fröhlich][@nifr]
+- [Niklas Mohrin][@niklasmohrin]
+- [@qknogxxb][@qknogxxb]
+- [@tveness][@tveness]
+- [Y.D.X.][@YDX-2147483647]
+- [Zacchary Dempsey-Plante][@zedseven]
+
+Thanks!
+
+
+### [v1.6.1][v1.6.1] (2022-10-24)
+
+#### Changes:
+
+- [fixed] Fix path source for custom pages dir ([#297])
+- [chore] Update dependendencies ([#299])
+
+#### Contributors to this version:
+
+- [Cyrus Yip][@CyrusYip]
+- [Danilo Bargen][@dbrgn]
+
+Thanks!
+
 
 ### [v1.6.0][v1.6.0] (2022-10-02)
 
@@ -23,9 +270,9 @@ 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.
+subdirectory! Packaging scripts might need to be updated.
 
-Changes:
+#### Changes:
 
 - [added] Allow overriding cache directory through config ([#276])
 - [added] Add `--no-auto-update` CLI flag ([#257])
@@ -46,7 +293,7 @@ Changes:
 - [chore] Use anyhow for error handling ([#249])
 - [chore] Switch to Rust 2021 edition ([#284])
 
-Contributors to this version:
+#### Contributors to this version:
 
 - [@bagohart][@bagohart]
 - [@cyqsimon][@cyqsimon]
@@ -73,7 +320,7 @@ 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. For more details, see
-  [the docs](https://dbrgn.github.io/tealdeer/usage_custom_pages.html).
+  [the docs](https://tealdeer-rs.github.io/tealdeer/usage_custom_pages.html).
 - **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.
@@ -84,7 +331,7 @@ The highlights:
   `-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
-  [dbrgn.github.io/tealdeer/](https://dbrgn.github.io/tealdeer/), we hope these
+  [tealdeer-rs.github.io/tealdeer/](https://tealdeer-rs.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.
@@ -92,10 +339,10 @@ The highlights:
 Note that the MSRV (Minimal Supported Rust Version) of the project
 [changed][i190]:
 
-> When publishing a Tealdeer release, the Rust version required to build it
+> When publishing a tealdeer release, the Rust version required to build it
 > should be stable for at least a month.
 
-Changes:
+#### Changes:
 
 - [added] Support custom pages and patches ([#142][i142])
 - [added] Multi-language support ([#125][i125], [#161][i161])
@@ -118,15 +365,15 @@ Changes:
 - [deprecated] The `--config-path` command is deprecated, use `--show-paths` instead ([#162][i162])
 - [deprecated] The `-o/--os` command is deprecated, use `-p/--platform` instead ([#217][i217])
 - [deprecated] The `-m/--markdown` command is deprecated, use `-r/--raw` instead ([#108][i108])
-- [docs] New docs at [dbrgn.github.io/tealdeer/](https://dbrgn.github.io/tealdeer/)
+- [docs] New docs at [tealdeer-rs.github.io/tealdeer/](https://tealdeer-rs.github.io/tealdeer/)
-- [docs] Add comparative benchmarks with hyperfine ([#163][i163], [README](https://github.com/dbrgn/tealdeer#goals))
+- [docs] Add comparative benchmarks with hyperfine ([#163][i163], [README](https://github.com/tealdeer-rs/tealdeer#goals))
 - [chore] Download tldr pages archive from their website, not from GitHub ([#213][i213])
 - [chore] Bump MSRV to 1.54 and change MSRV policy ([#190][i190])
 - [chore] The `master` branch was renamed to `main`
 - [chore] All release binaries are now generated in CI. Binaries for macOS and Windows are also provided. ([#240][i240])
 - [chore] Update all dependencies
 
-Contributors to this version:
+#### Contributors to this version:
 
 - [@bl-ue][@bl-ue]
 - [Cameron Tod][@cam8001]
@@ -155,7 +402,7 @@ co-maintainer. Thank you for your help!
 
 - [fixed] Syntax error in zsh completion file ([#138][i138])
 
-Contributors to this version:
+#### Contributors to this version:
 
 - [Danilo Bargen][@dbrgn]
 - [Bruno A. Muciño][@mucinoab]
@@ -172,7 +419,7 @@ Thanks!
 - [changed] Make `--list` option comply with official spec ([#112][i112])
 - [changed] Move cache age warning to stderr ([#113][i113])
 
-Contributors to this version:
+#### Contributors to this version:
 
 - [Atul Bhosale][@Atul9]
 - [Danilo Bargen][@dbrgn]
@@ -198,7 +445,7 @@ Thanks!
 - [fixed] Fix Fish autocompletion on macOS ([#87][i87])
 - [fixed] Fix compilation on Windows by disabling pager ([#99][i99])
 
-Contributors to this version:
+#### Contributors to this version:
 
 - [Bruno Heridet][@Delapouite]
 - [Danilo Bargen][@dbrgn]
@@ -224,7 +471,7 @@ Thanks!
 - [changed] Move to Rust 2018, require Rust 1.32 ([#69][i69] / [#84][i84])
 - [fixed] Add (back) support for proxies ([#68][i68])
 
-Contributors to this version:
+#### Contributors to this version:
 
 - [Bar Hatsor][@Bassets]
 - [Danilo Bargen][@dbrgn]
@@ -247,7 +494,7 @@ Thanks!
 - [changed] Require at least Rust 1.28 to build (previous: 1.19)
 - [fixed] Fix building on systems with openssl 1.1.1 ([#47][i47])
 
-Contributors to this version:
+#### Contributors to this version:
 
 - [Danilo Bargen][@dbrgn]
 - [@equal-l2][@equal-l2]
@@ -280,8 +527,11 @@ Thanks!
 
 - First crates.io release
 
+[user documentation]: https://docs.tealdeer.org
 
 [@0ndorio]: https://github.com/0ndorio
+[@adamazing]: https://github.com/adamazing
+[@agrmohit]: https://github.com/agrmohit
 [@aldanor]: https://github.com/aldanor
 [@Atul9]: https://github.com/Atul9
 [@BachoSeven]: https://github.com/BachoSeven
@@ -291,22 +541,28 @@ Thanks!
 [@bl-ue]: https://github.com/bl-ue
 [@Calinou]: https://github.com/Calinou
 [@cam8001]: https://github.com/cam8001
-[@cyqsimon]: https://github.com/cyqsimon
 [@cho-m]: https://github.com/cho-m
+[@cyqsimon]: https://github.com/cyqsimon
+[@CyrusYip]: https://github.com/CyrusYip
 [@das-g]: https://github.com/das-g
 [@dbrgn]: https://github.com/dbrgn
 [@Delapouite]: https://github.com/Delapouite
 [@dmaahs2017]: https://github.com/dmaahs2017
 [@equal-l2]: https://github.com/equal-l2
+[@felixonmars]: https://github.com/felixonmars
+[@frisoft]: https://github.com/frisoft
 [@gagarine]: https://github.com/gagarine
 [@hgaiser]: https://github.com/hgaiser
 [@ilai-deutel]: https://github.com/ilai-deutel
+[@iliya-malecki]: https://github.com/iliya-malecki
 [@invakid404]: https://github.com/invakid404
 [@james2doyle]: https://github.com/james2doyle
 [@jcgruenhage]: https://github.com/jcgruenhage
 [@jdvr]: https://github.com/jdvr
 [@jedahan]: https://github.com/jedahan
 [@jesdazrez]: https://github.com/jesdazrez
+[@jj-style]: https://github.com/jj-style
+[@kbdharun]: https://github.com/kbdharun
 [@kianmeng]: https://github.com/kianmeng
 [@kornelski]: https://github.com/kornelski
 [@korrat]: https://github.com/korrat
@@ -317,10 +573,13 @@ Thanks!
 [@mucinoab]: https://github.com/mucinoab
 [@mystal]: https://github.com/mystal
 [@natpen]: https://github.com/natpen
+[@nc7s]: https://github.com/nc7s
 [@newsch]: https://github.com/newsch
+[@nifr]: https://github.com/nifr
 [@niklasmohrin]: https://github.com/niklasmohrin
 [@Olavhaasie]: https://github.com/Olavhaasie
 [@Plommonsorbet]: https://github.com/Plommonsorbet
+[@qknogxxb]: https://github.com/qknogxxb
 [@rithvikvibhu]: https://github.com/rithvikvibhu
 [@SimplyDanny]: https://github.com/SimplyDanny
 [@sondr3]: https://github.com/sondr3
@@ -328,76 +587,138 @@ Thanks!
 [@tranzystorek-io]: https://github.com/tranzystorek-io
 [@tveness]: https://github.com/tveness
 [@Voultapher]: https://github.com/Voultapher
+[@Walker-00]: https://github.com/Walker-00
+[@YDX-2147483647]: https://github.com/YDX-2147483647
+[@zedseven]: https://github.com/zedseven
+[@beatbrot]: https://github.com/beatbrot
+[@erickguan]: https://github.com/erickguan
+[@MHS-0]: https://github.com/MHS-0
+[@MatejKafka]: https://github.com/MatejKafka
+[@nachiketkanore]: https://github.com/nachiketkanore
+[@mipedja]: https://github.com/mipedja
+[@hex1c]: https://github.com/hex1c
+[@lengyijun]: https://github.com/lengyijun
 
-[v1.0.0]: https://github.com/dbrgn/tealdeer/compare/v0.4.0...v1.0.0
+[v1.0.0]: https://github.com/tealdeer-rs/tealdeer/compare/v0.4.0...v1.0.0
-[v1.1.0]: https://github.com/dbrgn/tealdeer/compare/v1.0.0...v1.1.0
+[v1.1.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.0.0...v1.1.0
-[v1.2.0]: https://github.com/dbrgn/tealdeer/compare/v1.1.0...v1.2.0
+[v1.2.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.1.0...v1.2.0
-[v1.3.0]: https://github.com/dbrgn/tealdeer/compare/v1.2.0...v1.3.0
+[v1.3.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.2.0...v1.3.0
-[v1.4.0]: https://github.com/dbrgn/tealdeer/compare/v1.3.0...v1.4.0
+[v1.4.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.3.0...v1.4.0
-[v1.4.1]: https://github.com/dbrgn/tealdeer/compare/v1.4.0...v1.4.1
+[v1.4.1]: https://github.com/tealdeer-rs/tealdeer/compare/v1.4.0...v1.4.1
-[v1.5.0]: https://github.com/dbrgn/tealdeer/compare/v1.4.1...v1.5.0
+[v1.5.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.4.1...v1.5.0
-[v1.6.0]: https://github.com/dbrgn/tealdeer/compare/v1.5.0...v1.6.0
+[v1.5.1]: https://github.com/tealdeer-rs/tealdeer/compare/v1.5.0...v1.5.1
+[v1.6.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.5.0...v1.6.0
+[v1.6.1]: https://github.com/tealdeer-rs/tealdeer/compare/v1.6.0...v1.6.1
+[v1.6.2]: https://github.com/tealdeer-rs/tealdeer/compare/v1.6.1...v1.6.2
+[v1.7.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.6.1...v1.7.0
+[v1.7.1]: https://github.com/tealdeer-rs/tealdeer/compare/v1.7.0...v1.7.1
+[v1.7.2]: https://github.com/tealdeer-rs/tealdeer/compare/v1.7.1...v1.7.2
+[v1.7.3]: https://github.com/tealdeer-rs/tealdeer/compare/v1.7.2...v1.7.3
+[v1.8.0]: https://github.com/tealdeer-rs/tealdeer/compare/v1.7.2...v1.8.0
+[v1.8.1]: https://github.com/tealdeer-rs/tealdeer/compare/v1.8.0...v1.8.1
 
-[i34]: https://github.com/dbrgn/tealdeer/issues/34
+[i34]: https://github.com/tealdeer-rs/tealdeer/issues/34
-[i43]: https://github.com/dbrgn/tealdeer/issues/43
+[i43]: https://github.com/tealdeer-rs/tealdeer/issues/43
-[i44]: https://github.com/dbrgn/tealdeer/issues/44
+[i44]: https://github.com/tealdeer-rs/tealdeer/issues/44
-[i47]: https://github.com/dbrgn/tealdeer/issues/47
+[i47]: https://github.com/tealdeer-rs/tealdeer/issues/47
-[i48]: https://github.com/dbrgn/tealdeer/issues/48
+[i48]: https://github.com/tealdeer-rs/tealdeer/issues/48
-[i57]: https://github.com/dbrgn/tealdeer/issues/57
+[i57]: https://github.com/tealdeer-rs/tealdeer/issues/57
-[i58]: https://github.com/dbrgn/tealdeer/issues/58
+[i58]: https://github.com/tealdeer-rs/tealdeer/issues/58
-[i61]: https://github.com/dbrgn/tealdeer/issues/61
+[i61]: https://github.com/tealdeer-rs/tealdeer/issues/61
-[i68]: https://github.com/dbrgn/tealdeer/issues/68
+[i68]: https://github.com/tealdeer-rs/tealdeer/issues/68
-[i69]: https://github.com/dbrgn/tealdeer/issues/69
+[i69]: https://github.com/tealdeer-rs/tealdeer/issues/69
-[i71]: https://github.com/dbrgn/tealdeer/issues/71
+[i71]: https://github.com/tealdeer-rs/tealdeer/issues/71
-[i75]: https://github.com/dbrgn/tealdeer/issues/75
+[i75]: https://github.com/tealdeer-rs/tealdeer/issues/75
-[i77]: https://github.com/dbrgn/tealdeer/issues/77
+[i77]: https://github.com/tealdeer-rs/tealdeer/issues/77
-[i84]: https://github.com/dbrgn/tealdeer/issues/84
+[i84]: https://github.com/tealdeer-rs/tealdeer/issues/84
-[i86]: https://github.com/dbrgn/tealdeer/issues/86
+[i86]: https://github.com/tealdeer-rs/tealdeer/issues/86
-[i87]: https://github.com/dbrgn/tealdeer/issues/87
+[i87]: https://github.com/tealdeer-rs/tealdeer/issues/87
-[i89]: https://github.com/dbrgn/tealdeer/issues/89
+[i89]: https://github.com/tealdeer-rs/tealdeer/issues/89
-[i95]: https://github.com/dbrgn/tealdeer/issues/95
+[i95]: https://github.com/tealdeer-rs/tealdeer/issues/95
-[i97]: https://github.com/dbrgn/tealdeer/issues/97
+[i97]: https://github.com/tealdeer-rs/tealdeer/issues/97
-[i99]: https://github.com/dbrgn/tealdeer/issues/99
+[i99]: https://github.com/tealdeer-rs/tealdeer/issues/99
-[i108]: https://github.com/dbrgn/tealdeer/pull/108
+[i108]: https://github.com/tealdeer-rs/tealdeer/pull/108
-[i111]: https://github.com/dbrgn/tealdeer/issues/111
+[i111]: https://github.com/tealdeer-rs/tealdeer/issues/111
-[i112]: https://github.com/dbrgn/tealdeer/issues/112
+[i112]: https://github.com/tealdeer-rs/tealdeer/issues/112
-[i113]: https://github.com/dbrgn/tealdeer/issues/113
+[i113]: https://github.com/tealdeer-rs/tealdeer/issues/113
-[i115]: https://github.com/dbrgn/tealdeer/issues/115
+[i115]: https://github.com/tealdeer-rs/tealdeer/issues/115
-[i125]: https://github.com/dbrgn/tealdeer/pull/125
+[i125]: https://github.com/tealdeer-rs/tealdeer/pull/125
-[i138]: https://github.com/dbrgn/tealdeer/issues/138
+[i138]: https://github.com/tealdeer-rs/tealdeer/issues/138
-[i142]: https://github.com/dbrgn/tealdeer/pull/142
+[i142]: https://github.com/tealdeer-rs/tealdeer/pull/142
-[i148]: https://github.com/dbrgn/tealdeer/pull/148
+[i148]: https://github.com/tealdeer-rs/tealdeer/pull/148
-[i157]: https://github.com/dbrgn/tealdeer/pull/157
+[i157]: https://github.com/tealdeer-rs/tealdeer/pull/157
-[i161]: https://github.com/dbrgn/tealdeer/pull/161
+[i161]: https://github.com/tealdeer-rs/tealdeer/pull/161
-[i162]: https://github.com/dbrgn/tealdeer/pull/162
+[i162]: https://github.com/tealdeer-rs/tealdeer/pull/162
-[i163]: https://github.com/dbrgn/tealdeer/pull/163
+[i163]: https://github.com/tealdeer-rs/tealdeer/pull/163
-[i168]: https://github.com/dbrgn/tealdeer/pull/168
+[i168]: https://github.com/tealdeer-rs/tealdeer/pull/168
-[i171]: https://github.com/dbrgn/tealdeer/pull/171
+[i171]: https://github.com/tealdeer-rs/tealdeer/pull/171
-[i174]: https://github.com/dbrgn/tealdeer/pull/174
+[i174]: https://github.com/tealdeer-rs/tealdeer/pull/174
-[i176]: https://github.com/dbrgn/tealdeer/pull/176
+[i176]: https://github.com/tealdeer-rs/tealdeer/pull/176
-[i187]: https://github.com/dbrgn/tealdeer/pull/187
+[i187]: https://github.com/tealdeer-rs/tealdeer/pull/187
-[i190]: https://github.com/dbrgn/tealdeer/issues/190
+[i190]: https://github.com/tealdeer-rs/tealdeer/issues/190
-[i197]: https://github.com/dbrgn/tealdeer/pull/197
+[i197]: https://github.com/tealdeer-rs/tealdeer/pull/197
-[i210]: https://github.com/dbrgn/tealdeer/pull/210
+[i210]: https://github.com/tealdeer-rs/tealdeer/pull/210
-[i213]: https://github.com/dbrgn/tealdeer/pull/213
+[i213]: https://github.com/tealdeer-rs/tealdeer/pull/213
-[i215]: https://github.com/dbrgn/tealdeer/pull/215
+[i215]: https://github.com/tealdeer-rs/tealdeer/pull/215
-[i217]: https://github.com/dbrgn/tealdeer/pull/217
+[i217]: https://github.com/tealdeer-rs/tealdeer/pull/217
-[i227]: https://github.com/dbrgn/tealdeer/pull/227
+[i227]: https://github.com/tealdeer-rs/tealdeer/pull/227
-[#231]: https://github.com/dbrgn/tealdeer/pull/231
+[#231]: https://github.com/tealdeer-rs/tealdeer/pull/231
-[i240]: https://github.com/dbrgn/tealdeer/pull/240
+[i240]: https://github.com/tealdeer-rs/tealdeer/pull/240
-[#247]: https://github.com/dbrgn/tealdeer/pull/247
+[#247]: https://github.com/tealdeer-rs/tealdeer/pull/247
-[#249]: https://github.com/dbrgn/tealdeer/pull/249
+[#249]: https://github.com/tealdeer-rs/tealdeer/pull/249
-[#253]: https://github.com/dbrgn/tealdeer/pull/253
+[#253]: https://github.com/tealdeer-rs/tealdeer/pull/253
-[#254]: https://github.com/dbrgn/tealdeer/pull/254
+[#254]: https://github.com/tealdeer-rs/tealdeer/pull/254
-[#257]: https://github.com/dbrgn/tealdeer/pull/257
+[#257]: https://github.com/tealdeer-rs/tealdeer/pull/257
-[#259]: https://github.com/dbrgn/tealdeer/pull/259
+[#259]: https://github.com/tealdeer-rs/tealdeer/pull/259
-[#262]: https://github.com/dbrgn/tealdeer/pull/262
+[#262]: https://github.com/tealdeer-rs/tealdeer/pull/262
-[#271]: https://github.com/dbrgn/tealdeer/pull/271
+[#271]: https://github.com/tealdeer-rs/tealdeer/pull/271
-[#272]: https://github.com/dbrgn/tealdeer/pull/272
+[#272]: https://github.com/tealdeer-rs/tealdeer/pull/272
-[#274]: https://github.com/dbrgn/tealdeer/pull/274
+[#274]: https://github.com/tealdeer-rs/tealdeer/pull/274
-[#276]: https://github.com/dbrgn/tealdeer/pull/276
+[#276]: https://github.com/tealdeer-rs/tealdeer/pull/276
-[#284]: https://github.com/dbrgn/tealdeer/pull/284
+[#284]: https://github.com/tealdeer-rs/tealdeer/pull/284
-[#285]: https://github.com/dbrgn/tealdeer/pull/285
+[#285]: https://github.com/tealdeer-rs/tealdeer/pull/285
-[#287]: https://github.com/dbrgn/tealdeer/pull/287
+[#287]: https://github.com/tealdeer-rs/tealdeer/pull/287
-[#290]: https://github.com/dbrgn/tealdeer/pull/290
+[#290]: https://github.com/tealdeer-rs/tealdeer/pull/290
-[#291]: https://github.com/dbrgn/tealdeer/pull/291
+[#291]: https://github.com/tealdeer-rs/tealdeer/pull/291
+[#293]: https://github.com/tealdeer-rs/tealdeer/pull/293
+[#297]: https://github.com/tealdeer-rs/tealdeer/pull/297
+[#298]: https://github.com/tealdeer-rs/tealdeer/pull/298
+[#299]: https://github.com/tealdeer-rs/tealdeer/pull/299
+[#300]: https://github.com/tealdeer-rs/tealdeer/pull/300
+[#303]: https://github.com/tealdeer-rs/tealdeer/pull/303
+[#305]: https://github.com/tealdeer-rs/tealdeer/pull/305
+[#306]: https://github.com/tealdeer-rs/tealdeer/pull/306
+[#314]: https://github.com/tealdeer-rs/tealdeer/pull/314
+[#315]: https://github.com/tealdeer-rs/tealdeer/pull/315
+[#322]: https://github.com/tealdeer-rs/tealdeer/pull/322
+[#324]: https://github.com/tealdeer-rs/tealdeer/pull/324
+[#327]: https://github.com/tealdeer-rs/tealdeer/pull/327
+[#331]: https://github.com/tealdeer-rs/tealdeer/pull/331
+[#333]: https://github.com/tealdeer-rs/tealdeer/pull/333
+[#336]: https://github.com/tealdeer-rs/tealdeer/pull/336
+[#337]: https://github.com/tealdeer-rs/tealdeer/pull/337
+[#342]: https://github.com/tealdeer-rs/tealdeer/pull/342
+[#354]: https://github.com/tealdeer-rs/tealdeer/pull/354
+[#355]: https://github.com/tealdeer-rs/tealdeer/pull/355
+[#362]: https://github.com/tealdeer-rs/tealdeer/pull/362
+[#386]: https://github.com/tealdeer-rs/tealdeer/pull/386
+[#388]: https://github.com/tealdeer-rs/tealdeer/pull/388
+[#389]: https://github.com/tealdeer-rs/tealdeer/pull/389
+[#399]: https://github.com/tealdeer-rs/tealdeer/pull/399
+[#400]: https://github.com/tealdeer-rs/tealdeer/pull/400
+[#401]: https://github.com/tealdeer-rs/tealdeer/pull/401
+[#407]: https://github.com/tealdeer-rs/tealdeer/pull/407
+[#411]: https://github.com/tealdeer-rs/tealdeer/pull/411
+[#416]: https://github.com/tealdeer-rs/tealdeer/pull/416
+[#417]: https://github.com/tealdeer-rs/tealdeer/pull/417
+[#422]: https://github.com/tealdeer-rs/tealdeer/pull/422
+[#423]: https://github.com/tealdeer-rs/tealdeer/pull/423
+[#425]: https://github.com/tealdeer-rs/tealdeer/pull/425
+[#426]: https://github.com/tealdeer-rs/tealdeer/pull/426
+[#429]: https://github.com/tealdeer-rs/tealdeer/pull/429
+[#430]: https://github.com/tealdeer-rs/tealdeer/pull/430
+[#435]: https://github.com/tealdeer-rs/tealdeer/pull/435
+[#436]: https://github.com/tealdeer-rs/tealdeer/pull/436
+[#439]: https://github.com/tealdeer-rs/tealdeer/pull/439
+[#440]: https://github.com/tealdeer-rs/tealdeer/pull/440
+[#451]: https://github.com/tealdeer-rs/tealdeer/pull/451

Cargo.toml

@@ -4,16 +4,16 @@ authors = [
     "Niklas Mohrin <dev@niklasmohrin.de>",
 ]
 description = "Fetch and show tldr help pages for many CLI commands. Full featured offline client with caching support."
-homepage = "https://github.com/dbrgn/tealdeer/"
+homepage = "https://github.com/tealdeer-rs/tealdeer/"
-license = "MIT/Apache-2.0"
+license = "MIT OR Apache-2.0"
 name = "tealdeer"
 readme = "README.md"
-repository = "https://github.com/dbrgn/tealdeer/"
+repository = "https://github.com/tealdeer-rs/tealdeer/"
-documentation = "https://dbrgn.github.io/tealdeer/"
+documentation = "https://docs.tealdeer.org"
-version = "1.6.0"
+version = "1.8.1"
-include = ["/src/**/*", "/tests/**/*", "/Cargo.toml", "/README.md", "/LICENSE-*", "/screenshot.png"]
+include = ["/src/**/*", "/tests/**/*", "/Cargo.toml", "/README.md", "/LICENSE-*", "/screenshot.png", "completion/*"]
-rust-version = "1.62"
+rust-version = "1.88"  # MSRV
-edition = "2021"
+edition = "2024"
 
 [[bin]]
 name = "tldr"
@@ -21,18 +21,16 @@ path = "src/main.rs"
 
 [dependencies]
 anyhow = "1"
-app_dirs = { version = "2", package = "app_dirs2" }
+clap = { version = "4", features = ["std", "derive", "help", "usage", "cargo", "error-context", "color", "wrap_help"], default-features = false }
-atty = "0.2"
+env_logger = { version = "0.11", optional = true }
-clap = { version = "3", features = ["std", "derive", "suggestions", "color"], default-features = false }
+etcetera = "0.11.0"
-env_logger = { version = "0.9", optional = true }
 log = "0.4"
-reqwest = { version = "0.11.3", features = ["blocking"], default-features = false }
 serde = "1.0.21"
 serde_derive = "1.0.21"
-toml = "0.5.1"
+ureq = { version = "3.0.8", default-features = false, features = ["gzip", "socks-proxy"] }
-walkdir = "2.0.1"
+toml = "1"
-yansi = "0.5"
+yansi = "1"
-zip = { version = "0.6", default-features = false, features = ["deflate"] }
+zip = { version = "5.1.1", default-features = false, features = ["deflate"] }
 
 [target.'cfg(not(windows))'.dependencies]
 pager = "0.16"
@@ -40,15 +38,24 @@ pager = "0.16"
 [dev-dependencies]
 assert_cmd = "2.0.1"
 escargot = "0.5"
-predicates = "2.0.2"
+predicates = "3.1.2"
 tempfile = "3.1.0"
 filetime = "0.2.10"
 
 [features]
-default = ["native-roots"]
+# native-tls is not enabled by default, because it is difficult to build for musl
-native-roots = ["reqwest/rustls-tls-native-roots"]
+default = ["rustls-with-webpki-roots", "rustls-with-native-roots"]
-webpki-roots = ["reqwest/rustls-tls-webpki-roots"]
 logging = ["env_logger"]
 
+# At least one of variants for `ureq` HTTP client must be selected.
+native-tls = ["ureq/native-tls", "ureq/platform-verifier"]
+rustls-with-webpki-roots = ["ureq/rustls"] # ureq uses WebPKI roots by default
+rustls-with-native-roots = ["ureq/rustls", "ureq/platform-verifier"]
+
+ignore-online-tests = []
+
 [profile.release]
+strip = true
+opt-level = 3
 lto = true
+codegen-units = 1

README.md

@@ -14,12 +14,12 @@ Rust: Simplified, example based and community-driven man pages.
 If you pronounce "tldr" in English, it sounds somewhat like "tealdeer". Hence the project name :)
 
 In case you're in a hurry and just want to quickly try tealdeer, you can find static
-binaries on the [GitHub releases page](https://github.com/dbrgn/tealdeer/releases/)!
+binaries on the [GitHub releases page](https://github.com/tealdeer-rs/tealdeer/releases/)!
 
 
 ## Docs (Installing, Usage, Configuration)
 
-User documentation is available at <https://dbrgn.github.io/tealdeer/>!
+User documentation is available at <https://docs.tealdeer.org>!
 
 The docs are generated using [mdbook](https://rust-lang.github.io/mdBook/index.html).
 They can be edited through the markdown files in the `docs/src/` directory.
@@ -31,7 +31,6 @@ High level project goals:
 
 - [x] Download and cache pages
 - [x] Don't require a network connection for anything besides updating the cache
-- [x] Command line interface similar or equivalent to the [NodeJS client][node-gh]
 - [x] Comply with the [tldr client specification][client-spec]
 - [x] Advanced highlighting and configuration
 - [x] Be fast
@@ -39,29 +38,6 @@ High level project goals:
 A tool like `tldr` should be as frictionless as possible to use and show the
 output as fast as possible.
 
-We think that `tealdeer` reaches these goals. We put together a (more or less)
-reproducible benchmark that compiles a handful of clients from source and
-measures the execution times on a cold disk cache. The benchmarking is run in a
-Docker container using sharkdp's [`hyperfine`][hyperfine-gh]
-([Dockerfile][benchmark-dockerfile]).
-
-| Client (50 runs, 17.10.2021)      | Programming Language | Mean in ms | Deviation in ms | Comments                |
-| :---:                             | :---:                | :---:      | :---:           | :---:                   |
-| [`outfieldr`][outfieldr-gh]       | Zig                  | 9.1        | 0.5             | no user configuration   |
-| `tealdeer`                        | Rust                 | 13.2       | 0.5             |                         |
-| [`fast-tldr`][fast-tldr-gh]       | Haskell              | 17.0       | 0.6             | no example highlighting |
-| [`tldr-hs`][hs-gh]                | Haskell              | 25.1       | 0.5             | no example highlighting |
-| [`tldr-bash`][bash-gh]            | Bash                 | 30.0       | 0.8             |                         |
-| [`tldr-c`][c-gh]                  | C                    | 38.4       | 1.0             |                         |
-| [`tldr-python-client`][python-gh] | Python               | 87.0       | 2.4             |                         |
-| [`tldr-node-client`][node-gh]     | JavaScript / NodeJS  | 407.1      | 12.9            |                         |
-
-As you can see, `tealdeer` is one of the fastest of the tested clients.
-However, we strive for useful features and code quality over raw performance,
-even if that means that we don't come out on top in this friendly competition.
-That said, we are still optimizing the code, for example when the `outfieldr`
-developers [suggested to switch][outfieldr-comment-tls] to a native TLS
-implementation instead of the native libraries.
 
 ## Development
 
@@ -87,10 +63,22 @@ To run lints:
     $ cargo clean && cargo clippy
 
 
+### AI Policy
+
+Using AI is generally discouraged. However, if it is used as part of a contribution, the contributor MUST:
+
+1. Clearly mark what parts (if any) of a contribution were created with the help of AI tools. This includes issue and pull request comments.
+2. Check all output of AI tools before sharing it with others in the tealdeer project.
+3. Not post slop, spam, or low quality contributions. This includes pull request descriptions and comments with excessive text and markdown flair.
+4. Leave small or easy tasks to new contributors who want to learn without the use of AI. This is to maintain the presence of the `good-first-issue` tag.
+5. Be respectful of everyone's time: *maintainers and other contributors will be reviewing your PRs.*
+
+
 ## MSRV (Minimally Supported Rust Version)
 
-When publishing a Tealdeer release, the Rust version required to build it
+When publishing a tealdeer release, the Rust version required to build it
-should be stable for at least a month.
+should be stable for at least a month. The current MSRV can always be found in
+the `rust-version` field in `Cargo.toml`.
 
 
 ## License
@@ -112,21 +100,10 @@ be dual licensed as above, without any additional terms or conditions.
 Thanks to @severen for coming up with the name "tealdeer"!
 
 
-[node-gh]: https://github.com/tldr-pages/tldr-node-client
-[c-gh]: https://github.com/tldr-pages/tldr-c-client
-[hs-gh]: https://github.com/psibi/tldr-hs
-[fast-tldr-gh]: https://github.com/gutjuri/fast-tldr
-[bash-gh]: https://4e4.win/tldr
-[outfieldr-gh]: https://gitlab.com/ve-nt/outfieldr
-[python-gh]: https://github.com/tldr-pages/tldr-python-client
-
-[benchmark-dockerfile]: https://github.com/dbrgn/tealdeer/blob/main/benchmarks/Dockerfile
 [client-spec]: https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md
-[hyperfine-gh]: https://github.com/sharkdp/hyperfine
-[outfieldr-comment-tls]: https://github.com/dbrgn/tealdeer/issues/129#issuecomment-833596765
 
 <!-- Badges -->
-[github-actions]: https://github.com/dbrgn/tealdeer/actions?query=branch%3Amain
+[github-actions]: https://github.com/tealdeer-rs/tealdeer/actions?query=branch%3Amain
-[github-actions-badge]: https://github.com/dbrgn/tealdeer/workflows/CI/badge.svg
+[github-actions-badge]: https://github.com/tealdeer-rs/tealdeer/actions/workflows/ci.yml/badge.svg?branch=main
 [crates-io]: https://crates.io/crates/tealdeer
 [crates-io-badge]: https://img.shields.io/crates/v/tealdeer.svg

RELEASING.md

@@ -7,7 +7,7 @@ Run linting:
 Set variables:
 
     $ export VERSION=X.Y.Z
-    $ export GPG_KEY=EA456E8BAF0109429583EED83578F667F2F3A5FA
+    $ export GPG_KEY=20EE002D778AE197EF7D0D2CB993FF98A90C9AB1
 
 Update version numbers:
 

benchmarks/Dockerfile

@@ -1,139 +0,0 @@
-# Benchmark Dockerfile for tealdeer
-#
-# To run the benchmarks, execute
-#
-#     docker build --pull -t tldr-benchmark .
-#     docker run --privileged --rm -it tldr-benchmark
-#
-# as root in the directory of this Dockerfile. This will build the compared
-# clients and benchmark them with `hyperfine` at the end.
-#
-# The `--privileged` flag is needed to drop the disk caches before every run. If
-# you want to test with hot caches or don't want to use this flag, you will have
-# to remove the `--prepare` line from the `hyperfine` command at the end of this
-# file and rebuild the image.
-
-################################################################################
-
-FROM rust AS tealdeer-builder
-
-WORKDIR /build
-RUN git clone https://github.com/dbrgn/tealdeer.git \
-        && cd tealdeer \
-        && cargo build --release \
-        && mkdir /build-outputs \
-        && cp target/release/tldr /build-outputs/tealdeer
-
-################################################################################
-
-FROM ubuntu:latest AS tldr-c-builder
-
-WORKDIR /build
-RUN apt-get update && apt-get install -y build-essential git && rm -rf /var/lib/apt/lists/*
-RUN git clone https://github.com/tldr-pages/tldr-c-client.git \
-        && cd tldr-c-client \
-        && DEBIAN_FRONTEND=noninteractive ./deps.sh \
-        && make \
-        && mkdir /build-outputs /deps \
-        && cp tldr /build-outputs/tldr-c \
-        && cp deps.sh /deps/tldr-c-deps.sh
-
-################################################################################
-
-FROM haskell AS haskell-builder
-
-WORKDIR /build
-
-RUN git clone https://github.com/psibi/tldr-hs.git \
-        && cd tldr-hs \
-        && stack build --install-ghc
-
-RUN git clone https://github.com/gutjuri/fast-tldr \
-        && cd fast-tldr \
-        && stack build --install-ghc
-
-RUN mkdir /build-outputs \
-        && find tldr-hs/.stack-work/dist -type f -iname tldr -exec mv '{}' /build-outputs/tldr-hs \; \
-        && find fast-tldr/.stack-work/dist -type f -iname tldr -exec mv '{}' /build-outputs/fast-tldr \;
-
-################################################################################
-
-FROM node:slim AS node-builder
-
-WORKDIR /build-outputs
-RUN npm install tldr \
-        && cp $(which node) . \
-        && echo './node -- ./node_modules/.bin/tldr "$@"' > tldr-node \
-        && chmod +x tldr-node
-
-################################################################################
-
-FROM euantorano/zig:0.8.0 AS zig-builder
-
-WORKDIR /build
-RUN apk add git \
-        && git clone https://gitlab.com/ve-nt/outfieldr.git \
-        && cd outfieldr \
-        && git submodule init \
-        && git submodule update \
-        && zig build -Drelease-safe \
-        && mkdir /build-outputs \
-        && cp bin/tldr /build-outputs/outfieldr
-
-################################################################################
-
-FROM ubuntu:latest AS benchmark
-
-ENV LANG="en_US.UTF-8"
-
-WORKDIR /deps
-RUN apt-get update && apt-get install -y wget unzip python3 python3-venv && rm -rf /var/lib/apt/lists/*
-COPY --from=tldr-c-builder /deps/* ./
-RUN for file in *; do DEBIAN_FRONTEND=noninteractive sh $file; done
-
-WORKDIR /clients
-COPY --from=tealdeer-builder /build-outputs/* ./
-COPY --from=tldr-c-builder /build-outputs/* ./
-COPY --from=haskell-builder /build-outputs/* ./
-RUN wget -qO tldr-bash https://4e4.win/tldr && chmod +x tldr-bash
-COPY --from=node-builder /build-outputs/node /build-outputs/tldr-node ./
-COPY --from=node-builder /build-outputs/node_modules/ ./node_modules/
-COPY --from=zig-builder /build-outputs/* ./
-
-# python is really hard to isolate in a package, using pyinstaller didn't really work either, so for now we just use it like this
-RUN python3 -m venv tldr-python \
-        && cd tldr-python \
-        && bash -c 'source bin/activate; pip install wheel; pip install tldr; deactivate' \
-        && cd .. \
-        && echo '#!/bin/bash' > tldr-python.bash \
-        && echo 'source tldr-python/bin/activate; tldr $@' >> tldr-python.bash \
-        && chmod +x tldr-python.bash
-
-# Update all the individual caches
-RUN bash -c 'mkdir -p /caches/{tealdeer,tldr-c,tldr-hs,fast-tldr,tldr-bash,tldr-node,tldr-python,outfieldr/.local/share}' \
-        && TEALDEER_CACHE_DIR=/caches/tealdeer ./tealdeer -u \
-        && TLDR_CACHE_DIR=/caches/tldr-c ./tldr-c -u \
-        && XDG_DATA_HOME=/caches/tldr-hs ./tldr-hs -u \
-        && XDG_DATA_HOME=/caches/fast-tldr ./fast-tldr -u \
-        && XDG_DATA_HOME=/caches/tldr-bash ./tldr-bash -u \
-        && HOME=/caches/tldr-node ./tldr-node -u \
-        && HOME=/caches/tldr-python ./tldr-python.bash -u \
-        && HOME=/caches/outfieldr ./outfieldr -u
-
-WORKDIR /tools
-RUN wget -q https://github.com/sharkdp/hyperfine/releases/download/v1.11.0/hyperfine_1.11.0_amd64.deb && dpkg -i hyperfine_1.11.0_amd64.deb
-
-ENV PAGE="tar"
-WORKDIR /clients
-CMD hyperfine \
-        --warmup 10 \
-        --runs 50 \
-        --prepare 'sync; echo 3 | tee /proc/sys/vm/drop_caches' \
-        "TEALDEER_CACHE_DIR=/caches/tealdeer ./tealdeer $PAGE" \
-        "TLDR_CACHE_DIR=/caches/tldr-c ./tldr-c $PAGE" \
-        "XDG_DATA_HOME=/caches/tldr-hs ./tldr-hs $PAGE" \
-        "XDG_DATA_HOME=/caches/fast-tldr ./fast-tldr $PAGE" \
-        "XDG_DATA_HOME=/caches/tldr-bash TLDR_LESS=0 ./tldr-bash $PAGE" \
-        "HOME=/caches/tldr-python ./tldr-python.bash $PAGE" \
-        "HOME=/caches/outfieldr ./outfieldr $PAGE" \
-        "HOME=/caches/tldr-node ./tldr-node $PAGE"

completion/bash_tealdeer

@@ -14,7 +14,7 @@ _tealdeer()
 			return
 			;;
 		-p|--platform)
-			COMPREPLY=( $(compgen -W 'linux macos sunos windows android' -- "${cur}") )
+			COMPREPLY=( $(compgen -W 'linux macos sunos windows android freebsd netbsd openbsd' -- "${cur}") )
 			return
 			;;
 		--color)
@@ -27,8 +27,9 @@ _tealdeer()
 		COMPREPLY=( $( compgen -W '$( _parse_help "$1" )' -- "$cur" ) )
 		return
 	fi
-
+	if tldrlist=$(tldr -l 2>/dev/null); then
-	COMPREPLY=( $(compgen -W '$( tldr -l | tr -d , )' -- "${cur}") )
+		COMPREPLY=( $(compgen -W '$( echo "$tldrlist" | tr -d , )' -- "${cur}") )
+	fi
 }
 
 complete -F _tealdeer tldr

completion/fish_tealdeer

@@ -1,26 +1,34 @@
 #
 # Completions for the tealdeer implementation of tldr
-# https://github.com/dbrgn/tealdeer/
+# https://github.com/tealdeer-rs/tealdeer/
 #
 
-complete -c tldr -s h -l help           -d 'Print the help message.' -f
+complete -c tldr -s h -l help                 -d 'Print the help message' -f
-complete -c tldr -s v -l version        -d 'Show version information.' -f
+complete -c tldr -s v -l version              -d 'Show version information' -f
-complete -c tldr -s l -l list           -d 'List all commands in the cache.' -f
+complete -c tldr -s l -l list                 -d 'List all commands in the cache' -f
-complete -c tldr -s f -l render         -d 'Render a specific markdown file.' -r
+complete -c tldr      -l edit-page            -d 'Edit custom page with `EDITOR`' -f
-complete -c tldr -s p -l platform       -d 'Override the operating system.' -xa 'linux macos sunos windows android'
+complete -c tldr      -l edit-patch           -d 'Edit custom patch with `EDITOR`' -f
-complete -c tldr -s L -l language       -d 'Override the language' -x
+complete -c tldr -s f -l render               -d 'Render a specific markdown file' -r
-complete -c tldr -s u -l update         -d 'Update the local cache.' -f
+complete -c tldr -s p -l platform             -d 'Override the operating system' -xa 'linux macos sunos windows android freebsd netbsd openbsd common'
-complete -c tldr      -l no-auto-update -d 'If auto update is configured, disable it for this run.' -f
+complete -c tldr -s L -l language             -d 'Override the language' -x
-complete -c tldr -s c -l clear-cache    -d 'Clear the local cache.' -f
+complete -c tldr -s u -l update               -d 'Update the local cache' -f
-complete -c tldr      -l pager          -d 'Use a pager to page output.' -f
+complete -c tldr      -l no-auto-update       -d 'If auto update is configured, disable it for this run' -f
-complete -c tldr -s r -l raw            -d 'Display the raw markdown instead of rendering it.' -f
+complete -c tldr -s c -l clear-cache          -d 'Clear the local cache' -f
-complete -c tldr -s q -l quiet          -d 'Suppress informational messages.' -f
+complete -c tldr -s L -l config-path          -d 'Override config file location' -r
-complete -c tldr      -l show-paths     -d 'Show file and directory paths used by tealdeer.' -f
+complete -c tldr -s L -l override-config      -d 'Override config values after reading config file' -x
-complete -c tldr      -l seed-config    -d 'Create a basic config.' -f
+complete -c tldr      -l pager                -d 'Use a pager to page output' -f
-complete -c tldr      -l color          -d 'Controls when to use color.' -xa 'always auto never'
+complete -c tldr -s r -l raw                  -d 'Display the raw markdown instead of rendering it' -f
+complete -c tldr -s q -l quiet                -d 'Suppress informational messages' -f
+complete -c tldr      -l show-paths           -d 'Show file and directory paths used by tealdeer' -f
+complete -c tldr      -l seed-config          -d 'Create a basic config' -f
+complete -c tldr      -l color                -d 'Controls when to use color' -xa 'always auto never'
+complete -c tldr      -l short-options        -d 'Display the short variants of placeholders' -f
+complete -c tldr      -l long-options         -d 'Display the long variants of placeholders' -f
 
 function __tealdeer_entries
-    tldr --list | string replace -a -i -r "\,\s" "\n"
+    if set entries (tldr --list  2>/dev/null)
+        string replace -a -i -r "\,\s" "\n" $entries
+    end
 end
 
 complete -f -c tldr -a '(__tealdeer_entries)'

completion/zsh_tealdeer

@@ -2,8 +2,9 @@
 
 _applications() {
     local -a commands
-    commands=(${(uonzf)"$(tldr --list 2>/dev/null)"//:/\\:})
+    if commands=(${(uonzf)"$(tldr --list 2>/dev/null)"//:/\\:}); then
-    _describe -t commands 'command' commands
+        _describe -t commands 'command' commands
+    fi
 }
 
 _tealdeer() {
@@ -13,6 +14,8 @@ _tealdeer() {
 
     args+=(
         "($I -l --list)"{-l,--list}"[List all commands in the cache]"
+        "($I)--edit-page[Edit custom page with EDITOR]"
+        "($I)--edit-patch[Edit custom patch with EDITOR]"
         "($I -f --render)"{-f,--render}"[Render a specific markdown file]:file:_files"
         "($I -p --platform)"{-p,--platform}'[Override the operating system]:platform:((
             linux
@@ -20,11 +23,17 @@ _tealdeer() {
             sunos
             windows
             android
+            freebsd
+            netbsd
+            openbsd
+            common
         ))'
         "($I -L --language)"{-L,--language}"[Override the language settings]:lang"
         "($I -u --update)"{-u,--update}"[Update the local cache]"
         "($I)--no-auto-update[If auto update is configured, disable it for this run]"
         "($I -c --clear-cache)"{-c,--clear-cache}"[Clear the local cache]"
+        "($I)--config-path[Override config file location]"
+        "($I)--override-config[Override config values after reading config file]"
         "($I)--pager[Use a pager to page output]"
         "($I -r --raw)"{-r,--raw}"[Display the raw markdown instead of rendering it]"
         "($I -q --quiet)"{-q,--quiet}"[Suppress informational messages]"
@@ -35,6 +44,8 @@ _tealdeer() {
             auto
             never
         ))"
+        "($I)--short-options[Display the short variants of placeholders]"
+        "($I)--long-options[Display the long variants of placeholders]"
         '(- *)'{-h,--help}'[Display help]'
         '(- *)'{-v,--version}'[Show version information]'
         '1: :_applications'

docs/book.toml

@@ -1,6 +1,5 @@
 [book]
-authors = ["Danilo Bargen"]
+authors = ["Danilo Bargen", "Niklas Mohrin"]
 language = "en"
-multilingual = false
 src = "src"
 title = "Tealdeer User Manual"

docs/src/SUMMARY.md

@@ -8,5 +8,7 @@
 - [Configuration](./config.md)
   - [Section: \[display\]](./config_display.md)
   - [Section: \[style\]](./config_style.md)
+  - [Section: \[search\]](./config_search.md)
   - [Section: \[updates\]](./config_updates.md)
   - [Section: \[directories\]](./config_directories.md)
+- [Tips and Tricks](./tips_and_tricks.md)

docs/src/config.md

@@ -9,11 +9,15 @@ The configuration file path follows OS conventions (e.g.
 `$XDG_CONFIG_HOME/tealdeer/config.toml` on Linux). The paths can be queried
 with the following command:
 
-    $ tldr --show-paths
+```shell
+$ tldr --show-paths
+```
 
 Creating the config file can be done manually or with the help of `tldr`:
 
-    $ tldr --seed-config
+```shell
+$ tldr --seed-config
+```
 
 On Linux, this will usually be `~/.config/tealdeer/config.toml`.
 
@@ -22,13 +26,14 @@ On Linux, this will usually be `~/.config/tealdeer/config.toml`.
 Here's an example configuration file. Note that this example does not contain
 all possible config options. For details on the things that can be configured,
 please refer to the subsections of this documentation page
-([display](config_display.html), [style](config_style.html),
+([display](config_display.html), [style](config_style.html), [search](config_search.html),
 [updates](config_updates.html) or [directories](config_directories.html)).
 
 ```toml
 [display]
 compact = false
 use_pager = true
+show_title = false
 
 [style.command_name]
 foreground = "red"
@@ -53,10 +58,15 @@ The directory where the configuration file resides may be overwritten by the
 environment variable `TEALDEER_CONFIG_DIR`. Remember to use an absolute path.
 Variable expansion will not be performed on the path.
 
-## Override Cache Directory
+## Override Config Values
 
-Similarly, the cache directory where the pages are downloaded to, also follows
+Individual config values can be overridden using the `--override-config` command
-OS conventions. On Linux, it will usually be at `~/.cache/tealdeer/`. The path
+line argument. The overrides take place after reading the user config file, but
-can be overwritten using the environment variable `TEALDEER_CACHE_DIR`.
+before the raw config is evaluated.
-Remember to use an absolute path. Variable expansion will not be performed on
+
-the path.
+```shell
+$ tldr --override-config "display.compact = true" tealdeer
+```
+
+Each override is of the form `<name> = <value>` where `name` is a config key and
+`value` is any TOML value.

docs/src/config_directories.md

@@ -8,8 +8,10 @@ Override the cache directory. Remember to use an absolute path. Variable
 expansion will not be performed on the path. If the directory does not yet
 exist, it will be created.
 
-    [directories]
+```toml
-    cache_dir = "/home/myuser/.tealdeer-cache/"
+[directories]
+cache_dir = "/home/myuser/.tealdeer-cache/"
+```
 
 If no `cache_dir` is specified, tealdeer will fall back to a location that
 follows OS conventions. On Linux, it will usually be at `~/.cache/tealdeer/`.
@@ -21,5 +23,7 @@ Set the directory to be used to look up [custom
 pages](usage_custom_pages.html). Remember to use an absolute path. Variable
 expansion will not be performed on the path.
 
-    [directories]
+```toml
-    custom_pages_dir = "/home/myuser/custom-tldr-pages/"
+[directories]
+custom_pages_dir = "/home/myuser/custom-tldr-pages/"
+```

docs/src/config_display.md

@@ -6,8 +6,10 @@ In the `display` section you can configure the output format.
 
 Specifies whether the pager should be used by default or not (default `false`).
 
-    [display]
+```toml
-    use_pager = true
+[display]
+use_pager = true
+```
 
 When enabled, `less -R` is used as pager. To override the pager command used,
 set the `PAGER` environment variable.
@@ -19,5 +21,68 @@ NOTE: This feature is not available on Windows.
 Set this to enforce more compact output, where empty lines are stripped out
 (default `false`).
 
-    [display]
+```toml
-    compact = true
+[display]
+compact = true
+```
+
+## `show_title`
+
+Display the command name at the top of the page output (default `false`).
+
+```toml
+[display]
+show_title = true
+```
+
+When enabled, the command name will be displayed at the top of the output,
+styled with the `command_name` style configuration.
+
+## `indent`
+
+Controls the indentation of the output via two sub-keys.
+
+### `indent.base`
+
+Specifies the number of spaces used to indent descriptions, example text, and titles (default `2`).
+
+```toml
+[display.indent]
+base = 2
+```
+
+### `indent.command`
+
+Specifies the number of spaces used to indent example code lines (default `6`).
+
+```toml
+[display.indent]
+command = 6
+```
+
+You can also configure both subkeys in a single line like this:
+
+```toml
+[display]
+indent = {
+  base = 2,
+  command = 6,
+}
+```
+
+## `placeholder_format`
+
+Display the short and/or long variants of placeholders, if available.
+Possible values: `"short"`, `"long"`, or `"both"` (default `"long"`).
+This behavior can be overridden with the `--short-options` and `--long-options` flags.
+
+```toml
+[display]
+# Display only short variants
+placeholder_format = "short"
+```
+
+For example, when displaying the builtin page with `tldr tealdeer`, the `-f` / `--render` flag is displayed as follows:
+- `-f`, if `placeholder_format = "short"`
+- `--render`, if `placeholder_format = "long"`
+- `[-f|--render]`, if `placeholder_format = "both"`

docs/src/config_search.md

@@ -0,0 +1,33 @@
+# Section: \[search\]
+
+This config section is used to configure the page search in the cache.
+The settings apply to `tldr <page>` and `tldr --list`.
+
+## `languages`
+
+The list of languages that should be considered when searching.
+If unspecified, the list of languages will be inferred from the `LANG` and `LANGUAGE` environment variables.
+Either way, the language used can be overwritten using the `--language` command line flag.
+
+```toml
+[search]
+# Show pages in German if available, otherwise show in English
+languages = ["de", "en"]
+```
+
+## `platforms`
+
+The list of platforms that should be considered when searching.
+In addition to the platforms listed in the help text of the `--platform` flag, there are two special platforms available:
+- `"current"`: equals the platform that tealdeer was compiled for
+- `"all"`: adds all remaining platforms to the list
+
+Tealdeer searches the platforms in order of appearance in this list.
+The default list of platforms is `["current", "common", "all"]`.
+The list of platforms can be overwritten using the `--platform` command line flag.
+
+```toml
+[search]
+# Search for linux and common, and then search windows before trying the remaining platforms
+platforms = ["linux", "common", "windows", "all"]
+```

docs/src/config_style.md

@@ -10,7 +10,7 @@ Using the config file, the style (e.g. colors or underlines) can be customized.
 - `command_name`: The command name as part of the example code
 - `example_text`: The text that describes an example
 - `example_code`: The example itself (except the `command_name` and `example_variable`)
-- `example_variable`: The variables in the example
+- `example_variable`: The variables (placeholders) in the example
 
 ## Attributes
 
@@ -26,16 +26,22 @@ Colors can be specified in one of three ways:
 
   Example:
 
-      foreground = "green"
+  ```toml
+  foreground = "green"
+  ```
 
-- 256 color ANSI code (*Tealdeer v1.5.0+*)
+- 256 color ANSI code (*tealdeer v1.5.0+*)
 
   Example:
 
-      foreground = { ansi = 4 }
+  ```toml
+  foreground = { ansi = 4 }
+  ```
 
-- 24-bit RGB color (*Tealdeer v1.5.0+*)
+- 24-bit RGB color (*tealdeer v1.5.0+*)
 
   Example:
 
-      background = { rgb = { r = 255, g = 255, b = 255 } }
+  ```toml
+  background = { rgb = { r = 255, g = 255, b = 255 } }
+  ```

docs/src/config_updates.md

@@ -1,8 +1,10 @@
 # Section: \[updates\]
 
+This config section contains settings related to updating the tealdeer cache.
+
 ## Automatic updates
 
-tealdeer can refresh the cache automatically when it is outdated. This
+Tealdeer can refresh the cache automatically when it is outdated. This
 behavior can be configured in the `updates` section and is disabled by
 default.
 
@@ -11,8 +13,10 @@ default.
 Specifies whether the auto-update feature should be enabled (defaults to
 `false`).
 
-    [updates]
+```toml
-    auto_update = true
+[updates]
+auto_update = true
+```
 
 ### `auto_update_interval_hours`
 
@@ -20,7 +24,68 @@ Duration, since the last cache update, after which the cache will be
 refreshed (defaults to 720 hours). This parameter is ignored if `auto_update`
 is set to `false`.
 
-    [updates]
+```toml
-    auto_update = true
+[updates]
-    auto_update_interval_hours = 24
+auto_update = true
+auto_update_interval_hours = 24
+```
 
+### `warn_cache_age`
+
+Controls when a warning is printed if the cache has not been updated in a while.
+By default, the warning is shown once the cache is older than 30 days. Set this
+to `"never"` to silence the warning. This is useful if, for some reason, the
+modification time does not reflect its actual age.
+
+```toml
+[updates]
+warn_cache_age = "never"
+```
+
+## Download configuration
+
+### `download_languages`
+
+The list of languages which should be downloaded when updating.
+If unspecified, the languages listed in the `search.languages` setting are used.
+Thus, this setting is the most useful to instruct tealdeer to download pages in additional languages that are not searched by default.
+Either way, the language used can be overwritten using the `--language` command line flag.
+
+```toml
+[search]
+languages = ["de", "en"]
+
+[updates]
+# sometimes I like to read the Italian description
+download_languages = ["de", "en", "it"]
+```
+
+### `archive_source`
+
+URL for the location of the tldr pages archive. By default the pages are
+fetched from the latest `tldr-pages/tldr` GitHub release.
+
+```toml
+[updates]
+archive_source = "https://my-company.example.com/tldr/"
+```
+
+### `tls_backend`
+
+Specifies which TLS backend to use. Try changing this setting if you encounter certificate errors.
+
+Available options:
+- `rustls-with-native-roots` - [Rustls][rustls] (a TLS library in Rust) with native roots
+- `rustls-with-webpki-roots` - Rustls with [WebPKI][rustls-webpki] roots
+- `native-tls` - Native TLS
+  - SChannel on Windows
+  - Secure Transport on macOS
+  - OpenSSL on other platforms
+
+```toml
+[updates]
+tls_backend = "native-tls"
+```
+
+[rustls]: https://github.com/rustls/rustls
+[rustls-webpki]: https://github.com/rustls/webpki

docs/src/installing.md

@@ -1,6 +1,6 @@
 # Installing
 
-There are a few different ways to install Tealdeer:
+There are a few different ways to install tealdeer:
 
 - Through [package managers](#package-managers)
 - Through [static binaries](#static-binaries-linux)
@@ -14,47 +14,55 @@ autocompletions](#autocompletion).
 
 Tealdeer has been added to a few package managers:
 
-- Arch Linux: [`tealdeer`](https://archlinux.org/packages/community/x86_64/tealdeer/)
+- Arch Linux: [`tealdeer`](https://archlinux.org/packages/extra/x86_64/tealdeer/)
+- Debian: [`tealdeer`](https://tracker.debian.org/tealdeer)
 - Fedora: [`tealdeer`](https://src.fedoraproject.org/rpms/rust-tealdeer)
 - FreeBSD: [`sysutils/tealdeer`](https://www.freshports.org/sysutils/tealdeer/)
 - Funtoo: [`app-misc/tealdeer`](https://github.com/funtoo/core-kit/tree/1.4-release/app-misc/tealdeer)
 - Homebrew: [`tealdeer`](https://formulae.brew.sh/formula/tealdeer)
 - MacPorts: [`tealdeer`](https://ports.macports.org/port/tealdeer/)
 - NetBSD: [`sysutils/tealdeer`](https://pkgsrc.se/sysutils/tealdeer)
-- Nix: [`tealdeer`](https://nixos.org/nixos/packages.html#tealdeer)
+- Nix: [`tealdeer`](https://search.nixos.org/packages?query=tealdeer)
 - openSUSE: [`tealdeer`](https://software.opensuse.org/package/tealdeer?search_term=tealdeer)
+- Scoop: [`tealdeer`](https://github.com/ScoopInstaller/Main/blob/master/bucket/tealdeer.json)
 - Solus: [`tealdeer`](https://packages.getsol.us/shannon/t/tealdeer/)
 - Void Linux: [`tealdeer`](https://github.com/void-linux/void-packages/tree/master/srcpkgs/tealdeer)
 
 ## Static Binaries (Linux)
 
 Static binary builds (currently for Linux only) are available on the
-[GitHub releases page](https://github.com/dbrgn/tealdeer/releases).
+[GitHub releases page](https://github.com/tealdeer-rs/tealdeer/releases).
 Simply download the binary for your platform and run it!
 
 ## Through `cargo install`
 
 Build and install the tool via cargo...
 
-    $ cargo install tealdeer
+```shell
-
+$ cargo install tealdeer
-*(Note: You might need to install OpenSSL development headers, otherwise you get
+```
-a "failed to run custom build command for openssl-sys" error message. The
-package is called `libssl-dev` on Ubuntu.)*
 
 ## Build From Source
 
-Debug build with logging enabled:
+Release build:
 
-    $ cargo build --features logging
+```shell
+$ cargo build --release
+```
 
-Release build without logging:
+Release build with native TLS support:
 
-    $ cargo build --release
+```shell
+$ cargo build --release --features native-tls
+```
 
-To enable the log output, set the `RUST_LOG` env variable:
+Debug build with logging support:
 
-    $ export RUST_LOG=tldr=debug
+```shell
+$ cargo build --features logging
+```
+
+(To enable logging at runtime, export the `RUST_LOG=tldr=debug` env variable.)
 
 ## Autocompletion
 

docs/src/intro.md

@@ -6,9 +6,9 @@ and community-driven man pages.
 
 ![Screenshot](screenshot-default.png)
 
-This documentation shows how to install, use and configure Tealdeer.
+This documentation shows how to install, use and configure tealdeer.
 
 ## Links
 
-- [GitHub Project Page](https://github.com/dbrgn/tealdeer)
+- [GitHub Project Page](https://github.com/tealdeer-rs/tealdeer)
 - [TLDR Pages Project](https://tldr.sh/)

docs/src/tips_and_tricks.md

@@ -0,0 +1,52 @@
+# Tips and Tricks
+
+This page features some example use cases of Tealdeer.
+
+## Showing a random page on shell start
+
+To display a randomly selected page, you can invoke `tldr` twice: One time to
+select a page and a second time to display this page. To randomly select a page,
+we use `shuf` from the GNU coreutils:
+
+```bash
+tldr --quiet $(tldr --quiet --list | shuf -n1)
+```
+
+You can also add the above command to your `.bashrc` (or similar shell
+configuration file) to display a random page every time you start a new shell
+session.
+
+## Displaying all pages with their summary
+
+If you want to extend the output of `tldr --list` with the first line summary of
+each page, you can run the following Python script:
+
+```python
+#!/usr/bin/env python3
+
+import subprocess
+
+commands = subprocess.run(
+    ["tldr", "--quiet", "--list"],
+    capture_output=True,
+    encoding="utf-8",
+).stdout.splitlines()
+
+for command in commands:
+    output = subprocess.run(
+        ["tldr", "--quiet", command],
+        capture_output=True,
+        encoding="utf-8",
+    ).stdout
+    description = output.lstrip().split("\n\n")[0]
+    description = " ".join(description.split())
+    print(f"{command} => {description}")
+```
+
+Note that there are a lot of pages and the script will run Tealdeer once for
+every page, so the script may take a couple of seconds to finish.
+
+## Extending this chapter
+
+If you have an interesting setup with Tealdeer, feel free to share your
+configuration on [our Github repository](https://github.com/tealdeer-rs/tealdeer).

docs/src/usage.txt

@@ -1,29 +1,38 @@
-tealdeer 1.6.0
+tealdeer 1.8.1: A fast TLDR client
 Danilo Bargen <mail@dbrgn.ch>, Niklas Mohrin <dev@niklasmohrin.de>
-A fast TLDR client
 
-USAGE:
+Usage: tldr [OPTIONS] [COMMAND]...
-    tldr [OPTIONS] [COMMAND]...
 
-ARGS:
+Arguments:
-    <COMMAND>...    The command to show (e.g. `tar` or `git log`)
+  [COMMAND]...  The command to show (e.g. `tar` or `git log`)
 
-OPTIONS:
+Options:
-    -l, --list                   List all commands in the cache
+  -l, --list                        List all commands in the cache
-    -f, --render <FILE>          Render a specific markdown file
+      --edit-page                   Edit custom page with `EDITOR`
-    -p, --platform <PLATFORM>    Override the operating system [possible values: linux, macos,
+      --edit-patch                  Edit custom patch with `EDITOR`
-                                 windows, sunos, osx, android]
+  -f, --render <FILE>               Render a specific markdown file
-    -L, --language <LANGUAGE>    Override the language
+  -p, --platform <PLATFORM>         Override the operating system, can be specified multiple times
-    -u, --update                 Update the local cache
+                                    in order of preference [possible values: linux, macos, sunos,
-        --no-auto-update         If auto update is configured, disable it for this run
+                                    windows, android, freebsd, netbsd, openbsd, common]
-    -c, --clear-cache            Clear the local cache
+  -L, --language <LANGUAGE>         Override the language
-        --pager                  Use a pager to page output
+  -u, --update                      Update the local cache
-    -r, --raw                    Display the raw markdown instead of rendering it
+      --no-auto-update              If auto update is configured, disable it for this run
-    -q, --quiet                  Suppress informational messages
+  -c, --clear-cache                 Clear the local cache
-        --show-paths             Show file and directory paths used by tealdeer
+      --config-path <FILE>          Override config file location
-        --seed-config            Create a basic config
+      --override-config <OVERRIDE>  Override config values after reading config file (example:
-        --color <WHEN>           Control whether to use color [possible values: always, auto, never]
+                                    `updates.auto_update = true`)
-    -v, --version                Print the version
+      --pager                       Use a pager to page output
-    -h, --help                   Print help information
+  -r, --raw                         Display the raw markdown instead of rendering it
+  -q, --quiet                       Suppress informational messages
+      --show-paths                  Show file and directory paths used by tealdeer
+      --seed-config                 Create a basic config
+      --color <WHEN>                Control whether to use color [possible values: always, auto,
+                                    never]
+      --short-options               Display the short variants of placeholders
+      --long-options                Display the long variants of placeholders
+  -v, --version                     Print the version
+  -h, --help                        Print help
 
-To view the user documentation, please visit https://dbrgn.github.io/tealdeer/.
+To view the user documentation, please visit https://docs.tealdeer.org.
+
+To view usage examples, run tldr tldr or tldr tealdeer.

docs/src/usage_custom_pages.md

@@ -1,5 +1,13 @@
 # Custom Pages and Patches
 
+> ⚠️ **Breaking change in version 1.7.0:** The file name extension for custom
+> pages and patches was changed:
+>
+> - `<name>.page` → `<name>.page.md`
+> - `<name>.patch` → `<name>.patch.md`
+>
+> If you have custom pages or patches, you need to rename them.
+
 Tealdeer allows creating new custom pages, overriding existing pages as well as
 extending existing pages.
 
@@ -15,28 +23,36 @@ file](config_directories.html).
 
 To document internal command line tools, or if you want to replace an existing
 tldr page with one that's better suited for you, place a file with the name
-`<command>.page` in the custom pages directory. When calling `tldr <command>`,
+`<command>.page.md` in the custom pages directory. When calling `tldr <command>`,
 your custom page will be shown instead of the upstream version in the cache.
 
 Path:
 
-    $CUSTOM_PAGES_DIR/<command>.page
+```plain
+$CUSTOM_PAGES_DIR/<command>.page.md
+```
 
 Example:
 
-    ~/.local/share/tealdeer/pages/ufw.page
+```plain
+~/.local/share/tealdeer/pages/ufw.page.md
+```
 
 ## Custom Patches
 
 Sometimes you don't want to fully replace an existing upstream page, but just
 want to extend it with your own examples that you frequently need. In this
-case, use a file called `<command>.patch`, it will be appended to existing
+case, use a file called `<command>.patch.md`, it will be appended to existing
 pages.
 
 Path:
 
-    $CUSTOM_PAGES_DIR/<command>.patch
+```plain
+$CUSTOM_PAGES_DIR/<command>.patch.md
+```
 
 Example:
 
-    ~/.local/share/tealdeer/pages/ufw.patch
+```plain
+~/.local/share/tealdeer/pages/ufw.patch.md
+```

pages/tealdeer.md

@@ -0,0 +1,42 @@
+# tldr
+
+> This is a builtin page that shows information for your installed tealdeer version.
+> More information: <https://docs.tealdeer.org>.
+
+> This page shows tealdeer specific functionality. See tldr tldr for more examples.
+
+- Render a local markdown file as a tldr page:
+
+`tldr {{[-f|--render]}} {{path/to/file.md}}`
+
+- Show the raw markdown source of a page instead of rendering it:
+
+`tldr {{[-r|--raw]}} {{command}}`
+
+- Show file and directory paths used by tealdeer:
+
+`tldr --show-paths`
+
+- Create an initial config file:
+
+`tldr --seed-config`
+
+- Override config file location:
+
+`tldr --config-path <FILE>`
+
+- Open a custom page for a command in `$EDITOR` (creates it if it doesn't exist):
+
+`tldr --edit-page {{command}}`
+
+- Open a custom patch for a command in `$EDITOR` (appended to the existing page):
+
+`tldr --edit-patch {{command}}`
+
+- Clear the local cache:
+
+`tldr {{[-c|--clear-cache]}}`
+
+- If auto update is configured, disable it for this run:
+
+`tldr --no-auto-update`

scripts/get-mdbook.sh

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+set -ex
+
+wget -O mdbook.tar.gz https://github.com/rust-lang/mdBook/releases/download/v0.5.4/mdbook-v0.5.4-x86_64-unknown-linux-musl.tar.gz
+echo "5222beabd3e37dc5be0d18ff99b79058469354db5c220153a1b92db5ba12be89  mdbook.tar.gz" > sha256sums
+sha256sum --check sha256sums
+tar xvf mdbook.tar.gz

src/cache.rs

@@ -1,27 +1,38 @@
 use std::{
-    env,
-    ffi::OsStr,
     fs::{self, File},
-    io::{BufReader, Cursor, Read},
+    io::{Cursor, ErrorKind, Read},
     path::{Path, PathBuf},
     time::{Duration, SystemTime},
 };
 
-use anyhow::{ensure, Context, Result};
+use anyhow::{Context, Result, anyhow, bail, ensure};
-use log::debug;
+use log::{debug, info};
-use reqwest::{blocking::Client, Proxy};
+use ureq::{
-use walkdir::{DirEntry, WalkDir};
+    Agent,
+    http::StatusCode,
+    tls::{RootCerts, TlsConfig, TlsProvider},
+};
 use zip::ZipArchive;
 
-use crate::types::PlatformType;
+use crate::{
+    config::{Language, TlsBackend},
+    types::PlatformType,
+};
 
 pub static TLDR_PAGES_DIR: &str = "tldr-pages";
-static TLDR_OLD_PAGES_DIR: &str = "tldr-master";
 
-#[derive(Debug)]
+#[derive(Clone)]
-pub struct Cache {
+pub struct CacheConfig<'a> {
-    platform: PlatformType,
+    pub pages_directory: &'a Path,
-    cache_dir: PathBuf,
+    pub custom_pages_directory: Option<&'a Path>,
+    pub platforms: &'a [PlatformType],
+    pub search_languages: &'a [Language<'a>],
+    pub download_languages: &'a [Language<'a>],
+}
+
+/// The directory backing this cache is checked to be populated at construction.
+pub struct Cache<'a> {
+    config: CacheConfig<'a>,
 }
 
 #[derive(Debug)]
@@ -30,6 +41,228 @@ pub struct PageLookupResult {
     pub patch_path: Option<PathBuf>,
 }
 
+impl<'a> Cache<'a> {
+    /// Try opening a cache at the location given by `config.pages_directory`. If no directory
+    /// exists at this location, `Ok(None)` is returned.
+    pub fn open(config: CacheConfig<'a>) -> Result<Option<Self>> {
+        match config.pages_directory.metadata() {
+            Ok(md) => {
+                ensure!(
+                    md.is_dir(),
+                    "Cache directory `{}` exists, but is not a directory.",
+                    config.pages_directory.display(),
+                );
+                Ok(Some(Cache { config }))
+            }
+            Err(err) if err.kind() == ErrorKind::NotFound => Ok(None),
+            Err(err) => Err(anyhow!(err).context(format!(
+                "Error getting metdata of cache directory {}",
+                config.pages_directory.display()
+            ))),
+        }
+    }
+
+    /// Open an existing cache at `config.pages_directory` or create one if no cache resides at
+    /// this location. In case of success, the return value is a tuple with the `Cache` and a
+    /// boolean indicating whether the cache was newly created.
+    pub fn open_or_create(config: CacheConfig<'a>) -> Result<(Self, bool)> {
+        if let Some(cache) = Self::open(config.clone())? {
+            return Ok((cache, false));
+        }
+
+        fs::create_dir_all(config.pages_directory).with_context(|| {
+            format!(
+                "Cache directory `{}` cannot be created",
+                config.pages_directory.display(),
+            )
+        })?;
+        eprintln!(
+            "Successfully created cache directory `{}`.",
+            config.pages_directory.display(),
+        );
+
+        Ok((Cache { config }, true))
+    }
+
+    pub fn age(&self) -> Result<Duration> {
+        let mtime = self.config.pages_directory.metadata()?.modified()?;
+        SystemTime::now()
+            .duration_since(mtime)
+            .context("Error comparing cache mtime with current time")
+    }
+
+    pub fn find_page(&self, command: &str) -> Option<PageLookupResult> {
+        let page_filename = format!("{command}.md");
+        let patch_filename = format!("{command}.patch.md");
+        let custom_filename = format!("{command}.page.md");
+
+        if let Some(custom_pages_dir) = self.config.custom_pages_directory {
+            let custom_page = custom_pages_dir.join(custom_filename);
+            if custom_page.is_file() {
+                return Some(PageLookupResult::with_page(custom_page));
+            }
+        }
+
+        let patch_path = self
+            .config
+            .custom_pages_directory
+            .map(|dir| dir.join(&patch_filename))
+            .filter(|path| path.is_file());
+
+        for &platform in self.config.platforms {
+            for language in self.config.search_languages {
+                let mut search_path = self.config.pages_directory.to_path_buf();
+                search_path.push(language.directory_name());
+                search_path.push(platform.directory_name());
+                search_path.push(&page_filename);
+
+                if search_path.is_file() {
+                    return Some(
+                        PageLookupResult::with_page(search_path).with_optional_patch(patch_path),
+                    );
+                }
+            }
+        }
+
+        None
+    }
+
+    pub fn list_pages(&self) -> Result<impl IntoIterator<Item = String> + use<>> {
+        let mut pages = Vec::new();
+
+        let mut append_all = |directory: &Path, suffix: &str| -> Result<()> {
+            let Ok(file_iter) = fs::read_dir(directory) else {
+                return Ok(());
+            };
+
+            for entry in file_iter {
+                let entry = entry?;
+                if entry.file_type()?.is_file() {
+                    let mut page_path = entry
+                        .file_name()
+                        .into_string()
+                        .map_err(|_| anyhow!("Found invalid filename: {:?}", entry.path()))?;
+
+                    if page_path.ends_with(suffix) {
+                        page_path.truncate(page_path.len() - suffix.len());
+                        pages.push(page_path);
+                    } else {
+                        debug!(
+                            "Skipping page entry not ending in \".md\": {:?}",
+                            entry.path(),
+                        );
+                    }
+                }
+            }
+
+            Ok(())
+        };
+
+        let mut search_path = self.config.pages_directory.to_path_buf();
+        for language in self.config.search_languages {
+            search_path.push(language.directory_name());
+            for platform in self.config.platforms {
+                search_path.push(platform.directory_name());
+                append_all(&search_path, ".md")?;
+                search_path.pop();
+            }
+            search_path.pop();
+        }
+
+        if let Some(custom_pages_dir) = self.config.custom_pages_directory {
+            append_all(custom_pages_dir, ".page.md")?;
+        }
+
+        pages.sort_unstable();
+        pages.dedup();
+        Ok(pages)
+    }
+
+    pub fn old_custom_pages_exist(&self) -> Result<bool> {
+        let Some(directory) = self.config.custom_pages_directory else {
+            return Ok(false);
+        };
+        let Ok(file_iter) = fs::read_dir(directory) else {
+            return Ok(false);
+        };
+
+        for entry in file_iter {
+            if let Some(extension) = entry?.path().extension()
+                && (extension == "page" || extension == "patch")
+            {
+                return Ok(true);
+            }
+        }
+
+        Ok(false)
+    }
+
+    pub fn clear(self) -> Result<()> {
+        fs::remove_dir_all(self.config.pages_directory).with_context(|| {
+            format!(
+                "Could not remove pages directory at {}",
+                self.config.pages_directory.display(),
+            )
+        })
+    }
+
+    /// Download archives for the languages in `self.config().download_languages` and replace the
+    /// pages directory with the newly downloaded pages. As not all languages might have pages
+    /// available (for example, `en_US` instead of `en`), an iterator yielding all languages which
+    /// were successfully downloaded is returned.
+    pub fn update(
+        &mut self,
+        archive_url: &str,
+        tls_backend: TlsBackend,
+    ) -> Result<impl IntoIterator<Item = Language<'_>> + use<'_>> {
+        let client = Self::build_client(tls_backend);
+
+        // Download everything before deleting anything
+        let mut archives = self
+            .config
+            .download_languages
+            .iter()
+            .map(|&lang| {
+                Ok((
+                    lang,
+                    Self::download(
+                        &client,
+                        &format!("{archive_url}/tldr-{}.zip", lang.directory_name()),
+                    )?
+                    .map(|bytes| ZipArchive::new(Cursor::new(bytes)))
+                    .transpose()?,
+                ))
+            })
+            .collect::<Result<Vec<_>>>()?;
+
+        // Clear cache directory
+        // Note: This is not the best solution. Ideally we would download the
+        // archive to a temporary directory and then swap the two directories.
+        // But renaming a directory doesn't work across filesystems and Rust
+        // does not yet offer a recursive directory copying function. So for
+        // now, we'll use this approach.
+        fs::remove_dir_all(self.config.pages_directory)?;
+        fs::create_dir(self.config.pages_directory)?;
+
+        for (lang, archive) in &mut archives {
+            if let Some(archive) = archive {
+                info!("Extracting archive for {lang:?}");
+                archive.extract(self.config.pages_directory.join(lang.directory_name()))?;
+            } else {
+                info!("No archive found for {lang:?}");
+            }
+        }
+
+        Ok(archives
+            .into_iter()
+            .filter_map(|(lang, archive)| archive.is_some().then_some(lang)))
+    }
+
+    pub fn config(&self) -> &CacheConfig<'a> {
+        &self.config
+    }
+}
+
 impl PageLookupResult {
     pub fn with_page(page_path: PathBuf) -> Self {
         Self {
@@ -43,12 +276,12 @@ impl PageLookupResult {
         self
     }
 
-    /// Create a buffered reader that sequentially reads from the page and the
+    /// Create a reader that sequentially reads from the page and the
     /// patch, as if they were concatenated.
     ///
     /// This will return an error if either the page file or the patch file
     /// cannot be opened.
-    pub fn reader(&self) -> Result<BufReader<Box<dyn Read>>> {
+    pub fn reader(&self) -> Result<Box<dyn Read>> {
         // Open page file
         let page_file = File::open(&self.page_path)
             .with_context(|| format!("Could not open page file at {}", self.page_path.display()))?;
@@ -68,324 +301,76 @@ impl PageLookupResult {
         // the page and patch files and that will read them sequentially,
         // because it avoids the boxing below. However, the performance impact
         // would first need to be shown to be significant using a benchmark.
-        Ok(BufReader::new(if let Some(patch_file) = patch_file_opt {
+        Ok(if let Some(patch_file) = patch_file_opt {
             Box::new(page_file.chain(&b"\n"[..]).chain(patch_file)) as Box<dyn Read>
         } else {
             Box::new(page_file) as Box<dyn Read>
-        }))
+        })
     }
 }
 
-pub enum CacheFreshness {
+impl Language<'_> {
-    /// The cache is still fresh (less than MAX_CACHE_AGE old)
+    fn directory_name(&self) -> String {
-    Fresh,
+        format!("pages.{}", self.0)
-    /// The cache is stale and should be updated
+    }
-    Stale(Duration),
-    /// The cache is missing
-    Missing,
 }
 
-impl Cache {
+impl PlatformType {
-    pub fn new<P>(platform: PlatformType, cache_dir: P) -> Self
+    fn directory_name(self) -> &'static str {
-    where
+        match self {
-        P: Into<PathBuf>,
-    {
-        Self {
-            platform,
-            cache_dir: cache_dir.into(),
-        }
-    }
-
-    pub fn cache_dir(&self) -> &Path {
-        &self.cache_dir
-    }
-
-    /// Make sure that the cache directory exists and is a directory.
-    /// If necessary, create the directory.
-    fn ensure_cache_dir_exists(&self) -> Result<()> {
-        // Check whether `cache_dir` exists and is a directory
-        let (cache_dir_exists, cache_dir_is_dir) = self
-            .cache_dir
-            .metadata()
-            .map_or((false, false), |md| (true, md.is_dir()));
-        ensure!(
-            !cache_dir_exists || cache_dir_is_dir,
-            "Cache directory path `{}` is not a directory",
-            self.cache_dir.display(),
-        );
-
-        if !cache_dir_exists {
-            // If missing, try to create the complete directory path
-            fs::create_dir_all(&self.cache_dir).with_context(|| {
-                format!(
-                    "Cache directory path `{}` cannot be created",
-                    self.cache_dir.display(),
-                )
-            })?;
-            eprintln!(
-                "Successfully created cache directory path `{}`.",
-                self.cache_dir.display(),
-            );
-        }
-
-        Ok(())
-    }
-
-    fn pages_dir(&self) -> PathBuf {
-        self.cache_dir.join(TLDR_PAGES_DIR)
-    }
-
-    /// Download the archive from the specified URL.
-    fn download(archive_url: &str) -> Result<Vec<u8>> {
-        let mut builder = Client::builder();
-        if let Ok(ref host) = env::var("HTTP_PROXY") {
-            if let Ok(proxy) = Proxy::http(host) {
-                builder = builder.proxy(proxy);
-            }
-        }
-        if let Ok(ref host) = env::var("HTTPS_PROXY") {
-            if let Ok(proxy) = Proxy::https(host) {
-                builder = builder.proxy(proxy);
-            }
-        }
-        let client = builder
-            .build()
-            .context("Could not instantiate HTTP client")?;
-        let mut resp = client
-            .get(archive_url)
-            .send()?
-            .error_for_status()
-            .with_context(|| format!("Could not download tldr pages from {}", archive_url))?;
-        let mut buf: Vec<u8> = vec![];
-        let bytes_downloaded = resp.copy_to(&mut buf)?;
-        debug!("{} bytes downloaded", bytes_downloaded);
-        Ok(buf)
-    }
-
-    /// Update the pages cache from the specified URL.
-    pub fn update(&self, archive_url: &str) -> Result<()> {
-        self.ensure_cache_dir_exists()?;
-
-        // First, download the compressed data
-        let bytes: Vec<u8> = Self::download(archive_url)?;
-
-        // Decompress the response body into an `Archive`
-        let mut archive = ZipArchive::new(Cursor::new(bytes))
-            .context("Could not decompress downloaded ZIP archive")?;
-
-        // Clear cache directory
-        // Note: This is not the best solution. Ideally we would download the
-        // archive to a temporary directory and then swap the two directories.
-        // But renaming a directory doesn't work across filesystems and Rust
-        // does not yet offer a recursive directory copying function. So for
-        // now, we'll use this approach.
-        self.clear()
-            .context("Could not clear the cache directory")?;
-
-        // Extract archive into pages dir
-        archive
-            .extract(&self.pages_dir())
-            .context("Could not unpack compressed data")?;
-
-        Ok(())
-    }
-
-    /// Return the duration since the cache directory was last modified.
-    pub fn last_update(&self) -> Option<Duration> {
-        if let Ok(metadata) = fs::metadata(self.pages_dir()) {
-            if let Ok(mtime) = metadata.modified() {
-                let now = SystemTime::now();
-                return now.duration_since(mtime).ok();
-            };
-        };
-        None
-    }
-
-    /// Return the freshness of the cache (fresh, stale or missing).
-    pub fn freshness(&self) -> CacheFreshness {
-        match self.last_update() {
-            Some(ago) if ago > crate::config::MAX_CACHE_AGE => CacheFreshness::Stale(ago),
-            Some(_) => CacheFreshness::Fresh,
-            None => CacheFreshness::Missing,
-        }
-    }
-
-    /// Return the platform directory.
-    fn get_platform_dir(&self) -> &'static str {
-        match self.platform {
             PlatformType::Linux => "linux",
             PlatformType::OsX => "osx",
             PlatformType::SunOs => "sunos",
             PlatformType::Windows => "windows",
             PlatformType::Android => "android",
+            PlatformType::FreeBsd => "freebsd",
+            PlatformType::NetBsd => "netbsd",
+            PlatformType::OpenBsd => "openbsd",
+            PlatformType::Common => "common",
         }
     }
+}
 
-    /// Check for pages for a given platform in one of the given languages.
+impl Cache<'_> {
-    fn find_page_for_platform(
+    fn build_client(tls_backend: TlsBackend) -> Agent {
-        page_name: &str,
+        let tls_builder = match tls_backend {
-        pages_dir: &Path,
+            #[cfg(feature = "native-tls")]
-        platform: &str,
+            TlsBackend::NativeTls => TlsConfig::builder()
-        language_dirs: &[String],
+                .provider(TlsProvider::NativeTls)
-    ) -> Option<PathBuf> {
+                .root_certs(RootCerts::PlatformVerifier),
-        language_dirs
+            #[cfg(feature = "rustls-with-webpki-roots")]
-            .iter()
+            TlsBackend::RustlsWithWebpkiRoots => TlsConfig::builder()
-            .map(|lang_dir| pages_dir.join(lang_dir).join(platform).join(page_name))
+                .provider(TlsProvider::Rustls)
-            .find(|path| path.exists() && path.is_file())
+                .root_certs(RootCerts::WebPki),
-    }
+            #[cfg(feature = "rustls-with-native-roots")]
-
+            TlsBackend::RustlsWithNativeRoots => TlsConfig::builder()
-    /// Look up custom patch (<name>.patch). If it exists, store it in a variable.
+                .provider(TlsProvider::Rustls)
-    fn find_patch(patch_name: &str, custom_pages_dir: Option<&Path>) -> Option<PathBuf> {
+                .root_certs(RootCerts::PlatformVerifier),
-        custom_pages_dir
-            .map(|custom_dir| custom_dir.join(patch_name))
-            .filter(|path| path.exists() && path.is_file())
-    }
-
-    /// Search for a page and return the path to it.
-    pub fn find_page(
-        &self,
-        name: &str,
-        languages: &[String],
-        custom_pages_dir: Option<&Path>,
-    ) -> Option<PageLookupResult> {
-        let page_filename = format!("{}.md", name);
-        let patch_filename = format!("{}.patch", name);
-        let custom_filename = format!("{}.page", name);
-
-        // Determine directory paths
-        let pages_dir = self.pages_dir();
-        let lang_dirs: Vec<String> = languages
-            .iter()
-            .map(|lang| {
-                if lang == "en" {
-                    String::from("pages")
-                } else {
-                    format!("pages.{}", lang)
-                }
-            })
-            .collect();
-
-        // Look up custom page (<name>.page). If it exists, return it directly
-        if let Some(config_dir) = custom_pages_dir {
-            let custom_page = config_dir.join(custom_filename);
-            if custom_page.exists() && custom_page.is_file() {
-                return Some(PageLookupResult::with_page(custom_page));
-            }
-        }
-
-        let patch_path = Self::find_patch(&patch_filename, custom_pages_dir);
-
-        // Try to find a platform specific path next, append custom patch to it.
-        let platform_dir = self.get_platform_dir();
-        if let Some(page) =
-            Self::find_page_for_platform(&page_filename, &pages_dir, platform_dir, &lang_dirs)
-        {
-            return Some(PageLookupResult::with_page(page).with_optional_patch(patch_path));
-        }
-
-        // Did not find platform specific results, fall back to "common"
-        Self::find_page_for_platform(&page_filename, &pages_dir, "common", &lang_dirs)
-            .map(|page| PageLookupResult::with_page(page).with_optional_patch(patch_path))
-    }
-
-    /// Return the available pages.
-    pub fn list_pages(&self, custom_pages_dir: Option<&Path>) -> Vec<String> {
-        // Determine platforms directory and platform
-        let platforms_dir = self.pages_dir().join("pages");
-        let platform_dir = self.get_platform_dir();
-
-        // Closure that allows the WalkDir instance to traverse platform
-        // specific and common page directories, but not others.
-        let should_walk = |entry: &DirEntry| -> bool {
-            let file_type = entry.file_type();
-            let file_name = match entry.file_name().to_str() {
-                Some(name) => name,
-                None => return false,
-            };
-            if file_type.is_dir() {
-                return file_name == "common" || file_name == platform_dir;
-            } else if file_type.is_file() {
-                return true;
-            }
-            false
         };
+        let config = Agent::config_builder()
+            .http_status_as_error(false) // because we want to handle them
+            .tls_config(tls_builder.build())
+            .build();
 
-        let to_stem = |entry: DirEntry| -> Option<String> {
+        config.into()
-            entry
-                .path()
-                .file_stem()
-                .and_then(OsStr::to_str)
-                .map(str::to_string)
-        };
-
-        // Recursively walk through common and (if applicable) platform specific directory
-        let mut pages = WalkDir::new(platforms_dir)
-            .min_depth(1) // Skip root directory
-            .into_iter()
-            .filter_entry(should_walk) // Filter out pages for other architectures
-            .filter_map(Result::ok) // Convert results to options, filter out errors
-            .filter_map(|e| {
-                let extension = e.path().extension().unwrap_or_default();
-                if e.file_type().is_file() && extension == "md" {
-                    to_stem(e)
-                } else {
-                    None
-                }
-            })
-            .collect::<Vec<String>>();
-
-        if let Some(custom_pages_dir) = custom_pages_dir {
-            let is_page = |entry: &DirEntry| -> bool {
-                let extension = entry.path().extension().unwrap_or_default();
-                entry.file_type().is_file() && extension == "page"
-            };
-
-            let custom_pages = WalkDir::new(custom_pages_dir)
-                .min_depth(1)
-                .max_depth(1)
-                .into_iter()
-                .filter_entry(is_page)
-                .filter_map(Result::ok)
-                .filter_map(to_stem);
-
-            pages.extend(custom_pages);
-        }
-
-        pages.sort();
-        pages.dedup();
-        pages
     }
 
-    /// Delete the cache directory
+    /// Download the archive from the specified URL.
-    ///
+    fn download(client: &Agent, archive_url: &str) -> Result<Option<Vec<u8>>> {
-    /// Returns true if the cache was deleted and false if the cache dir did
+        info!("Downloading archive from {archive_url}");
-    /// not exist.
+        let response = client.get(archive_url).call();
-    pub fn clear(&self) -> Result<bool> {
+        match response {
-        if !self.cache_dir.exists() {
+            Ok(response) if response.status().is_success() => {
-            return Ok(false);
+                let mut buf: Vec<u8> = Vec::new();
-        }
+                response.into_body().into_reader().read_to_end(&mut buf)?;
-        ensure!(
+                debug!("{} bytes downloaded", buf.len());
-            self.cache_dir.is_dir(),
+                Ok(Some(buf))
-            "Cache path ({}) is not a directory.",
+            }
-            self.cache_dir.display(),
+            Ok(response) if response.status() == StatusCode::NOT_FOUND => Ok(None),
-        );
+            _ => {
-
+                bail!("Could not download tldr pages from {archive_url}: {response:?}")
-        // Delete old tldr-pages cache location as well if present
-        // TODO: To be removed in the future
-        for pages_dir_name in [TLDR_PAGES_DIR, TLDR_OLD_PAGES_DIR] {
-            let pages_dir = self.cache_dir.join(pages_dir_name);
-
-            if pages_dir.exists() {
-                fs::remove_dir_all(&pages_dir).with_context(|| {
-                    format!(
-                        "Could not remove the cache directory at {}",
-                        pages_dir.display()
-                    )
-                })?;
             }
         }
-
-        Ok(true)
     }
 }
 
@@ -403,8 +388,8 @@ mod tests {
     fn test_reader_with_patch() {
         // Write test files
         let dir = tempfile::tempdir().unwrap();
-        let page_path = dir.path().join("test.page");
+        let page_path = dir.path().join("test.page.md");
-        let patch_path = dir.path().join("test.patch");
+        let patch_path = dir.path().join("test.patch.md");
         {
             let mut f1 = File::create(&page_path).unwrap();
             f1.write_all(b"Hello\n").unwrap();
@@ -427,7 +412,7 @@ mod tests {
     fn test_reader_without_patch() {
         // Write test file
         let dir = tempfile::tempdir().unwrap();
-        let page_path = dir.path().join("test.page");
+        let page_path = dir.path().join("test.page.md");
         {
             let mut f = File::create(&page_path).unwrap();
             f.write_all(b"Hello\n").unwrap();

src/cli.rs

@@ -2,32 +2,48 @@
 
 use std::path::PathBuf;
 
-use clap::{AppSettings, ArgGroup, Parser};
+use clap::{ArgGroup, Parser, builder::ArgAction};
 
 use crate::types::{ColorOptions, PlatformType};
 
 // Note: flag names are specified explicitly in clap attributes
 // to improve readability and allow contributors to grep names like "clear-cache"
 #[derive(Parser, Debug)]
-#[clap(about = "A fast TLDR client", author, version)]
+#[command(
-#[clap(
+    about = "A fast TLDR client",
-    after_help = "To view the user documentation, please visit https://dbrgn.github.io/tealdeer/."
+    version,
+    disable_version_flag = true,
+    author,
+    help_template = "{before-help}{name} {version}: {about-with-newline}{author-with-newline}
+{usage-heading} {usage}
+
+{all-args}{after-help}",
+    after_help = "To view the user documentation, please visit https://docs.tealdeer.org.
+
+To view usage examples, run tldr tldr or tldr tealdeer.",
+    arg_required_else_help = true,
+    help_expected = true,
+    group = ArgGroup::new("command_or_file").args(&["command", "render"]),
 )]
-#[clap(setting = AppSettings::DeriveDisplayOrder)]
+pub(crate) struct Cli {
-#[clap(arg_required_else_help(true))]
-#[clap(disable_colored_help(true))]
-#[clap(group = ArgGroup::new("command_or_file").args(&["command", "render"]))]
-pub(crate) struct Args {
     /// The command to show (e.g. `tar` or `git log`)
-    #[clap(min_values = 1)]
+    #[arg(num_args(1..))]
     pub command: Vec<String>,
 
     /// List all commands in the cache
-    #[clap(short = 'l', long = "list")]
+    #[arg(short = 'l', long = "list")]
     pub list: bool,
 
+    /// Edit custom page with `EDITOR`
+    #[arg(long, requires = "command")]
+    pub edit_page: bool,
+
+    /// Edit custom patch with `EDITOR`
+    #[arg(long, requires = "command", conflicts_with = "edit_page")]
+    pub edit_patch: bool,
+
     /// Render a specific markdown file
-    #[clap(
+    #[arg(
         short = 'f',
         long = "render",
         value_name = "FILE",
@@ -35,61 +51,74 @@ pub(crate) struct Args {
     )]
     pub render: Option<PathBuf>,
 
-    /// Override the operating system
+    /// Override the operating system, can be specified multiple times in order of preference
-    #[clap(
+    #[arg(
         short = 'p',
         long = "platform",
-        possible_values = ["linux", "macos", "windows", "sunos", "osx", "android"],
+        value_name = "PLATFORM",
+        action = ArgAction::Append,
     )]
-    pub platform: Option<PlatformType>,
+    pub platforms: Option<Vec<PlatformType>>,
 
     /// Override the language
-    #[clap(short = 'L', long = "language")]
+    #[arg(short = 'L', long = "language")]
     pub language: Option<String>,
 
     /// Update the local cache
-    #[clap(short = 'u', long = "update")]
+    #[arg(short = 'u', long = "update")]
     pub update: bool,
 
     /// If auto update is configured, disable it for this run
-    #[clap(long = "no-auto-update", requires = "command_or_file")]
+    #[arg(long = "no-auto-update")]
     pub no_auto_update: bool,
 
     /// Clear the local cache
-    #[clap(short = 'c', long = "clear-cache")]
+    #[arg(short = 'c', long = "clear-cache")]
     pub clear_cache: bool,
 
+    /// Override config file location
+    #[arg(long = "config-path", value_name = "FILE")]
+    pub config_path: Option<PathBuf>,
+
+    /// Override config values after reading config file (example: `updates.auto_update = true`)
+    #[arg(long, action = ArgAction::Append, value_name = "OVERRIDE")]
+    pub override_config: Vec<String>,
+
     /// Use a pager to page output
-    #[clap(long = "pager", requires = "command_or_file")]
+    #[arg(long = "pager", requires = "command_or_file")]
     pub pager: bool,
 
     /// Display the raw markdown instead of rendering it
-    #[clap(short = 'r', long = "--raw", requires = "command_or_file")]
+    #[arg(short = 'r', long = "raw", requires = "command_or_file")]
     pub raw: bool,
 
     /// Suppress informational messages
-    #[clap(short = 'q', long = "quiet")]
+    #[arg(short = 'q', long = "quiet")]
     pub quiet: bool,
 
     /// Show file and directory paths used by tealdeer
-    #[clap(long = "show-paths")]
+    #[arg(long = "show-paths")]
     pub show_paths: bool,
 
     /// Create a basic config
-    #[clap(long = "seed-config")]
+    #[arg(long = "seed-config")]
     pub seed_config: bool,
 
     /// Control whether to use color
-    #[clap(
+    #[arg(long = "color", value_name = "WHEN")]
-        long = "color",
-        value_name = "WHEN",
-        possible_values = ["always", "auto", "never"]
-    )]
     pub color: Option<ColorOptions>,
 
+    /// Display the short variants of placeholders
+    #[arg(long)]
+    pub short_options: bool,
+
+    /// Display the long variants of placeholders
+    #[arg(long)]
+    pub long_options: bool,
+
     /// Print the version
     // Note: We override the version flag because clap uses `-V` by default,
     // while TLDR specification requires `-v` to be used.
-    #[clap(short = 'v', long = "version")]
+    #[arg(short = 'v', long = "version", action = ArgAction::Version)]
-    pub version: bool,
+    pub version: (),
 }

src/extensions.rs

@@ -1,14 +1,14 @@
 use std::mem;
 
 /// An extension trait to clear duplicates from a collection.
-pub(crate) trait Dedup<T: PartialEq + Clone> {
+pub(crate) trait Dedup<T: PartialEq> {
     fn clear_duplicates(&mut self);
 }
 
 /// Clear duplicates from a collection, keep the first one seen.
 ///
 /// For small vectors, this will be faster than a `HashSet`.
-impl<T: PartialEq + Clone> Dedup<T> for Vec<T> {
+impl<T: PartialEq> Dedup<T> for Vec<T> {
     fn clear_duplicates(&mut self) {
         let orig = mem::replace(self, Vec::with_capacity(self.len()));
         for item in orig {

src/formatter.rs

@@ -2,25 +2,80 @@
 
 use log::debug;
 
-use crate::{extensions::FindFrom, types::LineType};
+use crate::{config::Indent, extensions::FindFrom, types::LineType};
 
-#[derive(Debug, Clone, Copy, PartialEq, Eq)]
+#[derive(Debug, Clone, Copy, Eq)]
 /// Represents a snippet from a page of a specific highlighting class.
-pub enum PageSnippet<'a> {
+pub enum PageSnippet<T> {
-    CommandName(&'a str),
+    CommandName(T),
-    Variable(&'a str),
+    Placeholder(T),
-    NormalCode(&'a str),
+    PlaceholderVariants { short: T, long: T },
-    Description(&'a str),
+    NormalCode(T),
-    Text(&'a str),
+    Description(T),
+    Text(T),
+    Title(T),
+    Indent(usize),
     Linebreak,
 }
 
-impl<'a> PageSnippet<'a> {
+#[cfg_attr(not(test), allow(dead_code))]
+impl<T> PageSnippet<T> {
+    pub fn map<F, U>(self, f: F) -> PageSnippet<U>
+    where
+        F: Fn(T) -> U,
+    {
+        match self {
+            PageSnippet::CommandName(s) => PageSnippet::CommandName(f(s)),
+            PageSnippet::Placeholder(s) => PageSnippet::Placeholder(f(s)),
+            PageSnippet::PlaceholderVariants { short, long } => PageSnippet::PlaceholderVariants {
+                short: f(short),
+                long: f(long),
+            },
+            PageSnippet::NormalCode(s) => PageSnippet::NormalCode(f(s)),
+            PageSnippet::Description(s) => PageSnippet::Description(f(s)),
+            PageSnippet::Text(s) => PageSnippet::Text(f(s)),
+            PageSnippet::Title(s) => PageSnippet::Title(f(s)),
+            PageSnippet::Indent(n) => PageSnippet::Indent(n),
+            PageSnippet::Linebreak => PageSnippet::Linebreak,
+        }
+    }
+}
+
+impl<T: PartialEq<U>, U> PartialEq<PageSnippet<U>> for PageSnippet<T> {
+    fn eq(&self, other: &PageSnippet<U>) -> bool {
+        match (self, other) {
+            (PageSnippet::CommandName(s), PageSnippet::CommandName(t))
+            | (PageSnippet::Placeholder(s), PageSnippet::Placeholder(t))
+            | (PageSnippet::NormalCode(s), PageSnippet::NormalCode(t))
+            | (PageSnippet::Description(s), PageSnippet::Description(t))
+            | (PageSnippet::Text(s), PageSnippet::Text(t))
+            | (PageSnippet::Title(s), PageSnippet::Title(t)) => s == t,
+            (
+                PageSnippet::PlaceholderVariants {
+                    short: left_short,
+                    long: left_long,
+                },
+                PageSnippet::PlaceholderVariants {
+                    short: right_short,
+                    long: right_long,
+                },
+            ) => left_short == right_short && left_long == right_long,
+            (PageSnippet::Indent(n), PageSnippet::Indent(m)) => n == m,
+            (PageSnippet::Linebreak, PageSnippet::Linebreak) => true,
+            _ => false,
+        }
+    }
+}
+
+impl PageSnippet<&str> {
     pub fn is_empty(&self) -> bool {
         use PageSnippet::*;
 
         match self {
-            CommandName(s) | Variable(s) | NormalCode(s) | Description(s) | Text(s) => s.is_empty(),
+            CommandName(s) | Placeholder(s) | NormalCode(s) | Description(s) | Text(s)
+            | Title(s) => s.is_empty(),
+            PageSnippet::PlaceholderVariants { short, long } => short.is_empty() && long.is_empty(),
+            Indent(n) => *n == 0,
             Linebreak => false,
         }
     }
@@ -31,10 +86,12 @@ pub fn highlight_lines<L, F, E>(
     lines: L,
     process_snippet: &mut F,
     keep_empty_lines: bool,
+    show_title: bool,
+    indent: Indent,
 ) -> Result<(), E>
 where
     L: Iterator<Item = LineType>,
-    F: for<'snip> FnMut(PageSnippet<'snip>) -> Result<(), E>,
+    F: for<'snip> FnMut(PageSnippet<&'snip str>) -> Result<(), E>,
 {
     let mut command = String::new();
     for line in lines {
@@ -45,51 +102,131 @@ where
                 }
             }
             LineType::Title(title) => {
-                debug!("Ignoring title");
+                if show_title {
-
+                    process_snippet(PageSnippet::Linebreak)?;
+                    process_snippet(PageSnippet::Indent(indent.base))?;
+                    process_snippet(PageSnippet::Title(&title))?;
+                    process_snippet(PageSnippet::Linebreak)?;
+                } else {
+                    debug!("Ignoring title");
+                }
                 // This is safe as long as the parsed title is only the command,
                 // and the iterator yields values in order of appearance.
                 command = title;
-                debug!("Detected command name: {}", &command);
+                debug!("Detected command name: {command}");
+            }
+            LineType::Description(text) => {
+                process_snippet(PageSnippet::Indent(indent.base))?;
+                process_snippet(PageSnippet::Description(&text))?;
+                process_snippet(PageSnippet::Linebreak)?;
+            }
+            LineType::ExampleText(text) => {
+                process_snippet(PageSnippet::Indent(indent.base))?;
+                process_snippet(PageSnippet::Text(&text))?;
+                process_snippet(PageSnippet::Linebreak)?;
             }
-            LineType::Description(text) => process_snippet(PageSnippet::Description(&text))?,
-            LineType::ExampleText(text) => process_snippet(PageSnippet::Text(&text))?,
             LineType::ExampleCode(text) => {
-                process_snippet(PageSnippet::NormalCode("      "))?;
+                process_snippet(PageSnippet::Indent(indent.command))?;
                 highlight_code(&command, &text, process_snippet)?;
                 process_snippet(PageSnippet::Linebreak)?;
             }
 
-            LineType::Other(text) => debug!("Unknown line type: {:?}", text),
+            LineType::Other(text) => debug!("Unknown line type: {text:?}"),
         }
     }
     process_snippet(PageSnippet::Linebreak)?;
     Ok(())
 }
 
-/// Highlight code examples including user variables in {{ curly braces }}.
+/// Highlight code examples.
-fn highlight_code<'a, E>(
+/// - parse placeholders (`{{ curly braces }}`)
-    command: &'a str,
+/// - replace escaped placeholder markers (`\{\{` and `\}\}`)
-    text: &'a str,
+fn highlight_code<E>(
-    process_snippet: &mut impl FnMut(PageSnippet<'a>) -> Result<(), E>,
+    command: &str,
+    mut text: &str,
+    process_snippet: &mut impl FnMut(PageSnippet<&str>) -> Result<(), E>,
 ) -> Result<(), E> {
-    let variable_splits = text
+    // We replace escaped placeholder markers at the end so that our replacing does not interfere
-        .split("}}")
+    // with finding the actual markers.
-        .map(|s| s.split_once("{{").unwrap_or((s, "")));
+    // NOTE: This is not optimal, as it allocates one String for each `replace`
-    for (code_segment, variable) in variable_splits {
+    let replace_escaped = |s: &str| s.replace(r"\{\{", "{{").replace(r"\}\}", "}}");
-        highlight_code_segment(command, code_segment, process_snippet)?;
+
-        process_snippet(PageSnippet::Variable(variable))?;
+    loop {
+        // Find placeholder markers and split into code and placeholder accordingly
+
+        let Some(start_marker) = find_marker(text, "{{", r"\{\{") else {
+            break;
+        };
+        let Some(mut end_marker) = find_marker(&text[start_marker + 2..], "}}", r"\}\}") else {
+            break;
+        };
+        end_marker += start_marker + 2;
+
+        // Greedily extend matched range
+        while end_marker + 2 < text.len() && text.as_bytes()[end_marker + 2] == b'}' {
+            end_marker += 1;
+        }
+
+        let placeholder_content = &text[start_marker + 2..end_marker];
+
+        if start_marker > 0 {
+            highlight_code_segment(
+                command,
+                &replace_escaped(&text[..start_marker]),
+                process_snippet,
+            )?;
+        }
+
+        let placeholder_content = replace_escaped(placeholder_content);
+        if let Some(s) = placeholder_content.strip_prefix('[')
+            && let Some(s) = s.strip_suffix(']')
+            && let Some((short, long)) = s.split_once('|')
+        {
+            process_snippet(PageSnippet::PlaceholderVariants { short, long })?;
+        } else {
+            process_snippet(PageSnippet::Placeholder(&placeholder_content))?;
+        }
+
+        text = &text[end_marker + 2..];
     }
+
+    if !text.is_empty() {
+        highlight_code_segment(command, &replace_escaped(text), process_snippet)?;
+    }
+
     Ok(())
 }
 
+/// Find a "{{" (or "}}") substring that does not overlap with a preceding "\{\{" (or "\}\}").
+fn find_marker(s: &str, marker: &str, forbidden_prefix: &str) -> Option<usize> {
+    let mut search_start = 0;
+    loop {
+        let marker_index = s.find_from(marker, search_start)?;
+
+        let overlaps_with_prefix = (forbidden_prefix.len() <= marker_index + 1) && {
+            let prefix_start = marker_index + 1 - forbidden_prefix.len();
+            // NOTE: The indices might not be valid character offsets, so we should do this
+            // comparison on raw bytes. If prefix_start is indeed not a character offset than the
+            // comparison is guaranteed to return false because forbidden_prefix[0] definitely _is_
+            // the start of a (single byte, ASCII) character.
+            &s.as_bytes()[prefix_start..=marker_index] == forbidden_prefix.as_bytes()
+        };
+        if !overlaps_with_prefix {
+            return Some(marker_index);
+        }
+
+        // The next valid marker cannot include the first character of the current match
+        search_start = marker_index + 1;
+    }
+}
+
 /// Yields `NormalCode` and `CommandName` in alternating order according to the occurrences of
-/// `command_name` in `segment`. Variables are not detected here, see `highlight_code`
+/// `command_name` in `segment`. Placeholders are not detected here, see `highlight_code`
 /// instead.
 fn highlight_code_segment<'a, E>(
     command_name: &'a str,
     mut segment: &'a str,
-    process_snippet: &mut impl FnMut(PageSnippet<'a>) -> Result<(), E>,
+    process_snippet: &mut impl FnMut(PageSnippet<&'a str>) -> Result<(), E>,
 ) -> Result<(), E> {
     if !command_name.is_empty() {
         let mut search_start = 0;
@@ -119,20 +256,17 @@ fn is_freestanding_substring(surrounding: &str, substring: (usize, usize)) -> bo
     let char_before_is_okay = surrounding[..start]
         .chars()
         .last()
-        .filter(|prev_char| !prev_char.is_whitespace())
+        .is_none_or(char::is_whitespace);
-        .is_none();
     let char_after_is_okay = surrounding[end..]
         .chars()
         .next()
-        .filter(|next_char| !next_char.is_whitespace())
+        .is_none_or(char::is_whitespace);
-        .is_none();
     char_before_is_okay && char_after_is_okay
 }
 
 #[cfg(test)]
 mod tests {
     use super::*;
-    use PageSnippet::*;
 
     #[test]
     fn test_is_freestanding_substring() {
@@ -159,80 +293,251 @@ mod tests {
         ));
     }
 
-    fn run<'a>(cmd: &'a str, segment: &'a str) -> Vec<PageSnippet<'a>> {
+    fn run<'a>(cmd: &'a str, segment: &'a str) -> Vec<PageSnippet<String>> {
         let mut yielded = Vec::new();
-        let mut process_snippet = |snip: PageSnippet<'a>| {
+        let mut process_snippet = |snip: PageSnippet<&str>| {
             if !snip.is_empty() {
-                yielded.push(snip);
+                yielded.push(snip.map(str::to_string));
             }
             Ok::<(), ()>(())
         };
 
-        highlight_code_segment(cmd, segment, &mut process_snippet)
+        highlight_code(cmd, segment, &mut process_snippet).expect("highlight code segment failed");
-            .expect("highlight code segment failed");
         yielded
     }
 
-    #[test]
+    mod highlight_code_segment {
-    fn test_highlight_code_segment() {
+        use super::*;
-        assert!(run("make", "").is_empty());
+        use PageSnippet::*;
-        assert_eq!(
+
-            &run("make", "make all CC=clang -q"),
+        #[test]
-            &[CommandName("make"), NormalCode(" all CC=clang -q")]
+        fn test_highlight_code_segment() {
-        );
+            assert!(run("make", "").is_empty());
-        assert_eq!(
+            assert_eq!(
-            &run("make", "  make money --always-make"),
+                &run("make", "make all CC=clang -q"),
-            &[
+                &[CommandName("make"), NormalCode(" all CC=clang -q")]
-                NormalCode("  "),
+            );
-                CommandName("make"),
+            assert_eq!(
-                NormalCode(" money --always-make")
+                &run("make", "  make money --always-make"),
-            ]
+                &[
-        );
+                    NormalCode("  "),
-        assert_eq!(
+                    CommandName("make"),
-            &run("git commit", "git commit -m 'git commit'"),
+                    NormalCode(" money --always-make")
-            &[CommandName("git commit"), NormalCode(" -m 'git commit'"),]
+                ]
-        );
+            );
+            assert_eq!(
+                &run("git commit", "git commit -m 'git commit'"),
+                &[CommandName("git commit"), NormalCode(" -m 'git commit'"),]
+            );
+        }
+
+        #[test]
+        fn test_i18n() {
+            assert_eq!(
+                &run("mäke", "mäke höhlenrätselbücher"),
+                &[CommandName("mäke"), NormalCode(" höhlenrätselbücher")]
+            );
+            assert_eq!(
+                &run(
+                    "Müll",
+                    "1000 Gründe warum Müll heute größer ist als Müll früher, ärgerlich"
+                ),
+                &[
+                    NormalCode("1000 Gründe warum "),
+                    CommandName("Müll"),
+                    NormalCode(" heute größer ist als "),
+                    CommandName("Müll"),
+                    NormalCode(" früher, ärgerlich")
+                ]
+            );
+            assert_eq!(
+                &run(
+                    "übergang",
+                    "die Zustandsübergangsfunktion übergang Änderungen",
+                ),
+                &[
+                    NormalCode("die Zustandsübergangsfunktion "),
+                    CommandName("übergang"),
+                    NormalCode(" Änderungen")
+                ],
+            );
+        }
+
+        #[test]
+        fn test_empty_command() {
+            let segment = "some code";
+            let snippets = [NormalCode(segment)];
+
+            assert_eq!(run("", segment), snippets);
+            assert_eq!(run(" ", segment), snippets);
+            assert_eq!(run("  \t ", segment), snippets);
+        }
     }
 
-    #[test]
+    mod placeholders {
-    fn test_i18n() {
+        use super::*;
-        assert_eq!(
+        use PageSnippet::*;
-            &run("mäke", "mäke höhlenrätselbücher"),
+
-            &[CommandName("mäke"), NormalCode(" höhlenrätselbücher")]
+        #[test]
-        );
+        fn placeholder_vs_escaped() {
-        assert_eq!(
+            assert_eq!(
-            &run(
+                run("ping", "ping {{example.com}}"),
-                "Müll",
+                [
-                "1000 Gründe warum Müll heute größer ist als Müll früher, ärgerlich"
+                    CommandName("ping"),
-            ),
+                    NormalCode(" "),
-            &[
+                    Placeholder("example.com"),
-                NormalCode("1000 Gründe warum "),
+                ],
-                CommandName("Müll"),
+            );
-                NormalCode(" heute größer ist als "),
+            assert_eq!(
-                CommandName("Müll"),
+                run(
-                NormalCode(" früher, ärgerlich")
+                    "docker inspect",
-            ]
+                    r"docker inspect --format '\{\{range.NetworkSettings.Networks\}\}\{\{.IPAddress\}\}\{\{end\}\}' {{container}}"
-        );
+                ),
-        assert_eq!(
+                [
-            &run(
+                    CommandName("docker inspect"),
-                "übergang",
+                    NormalCode(
-                "die Zustandsübergangsfunktion übergang Änderungen",
+                        " --format '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' "
-            ),
+                    ),
-            &[
+                    Placeholder("container"),
-                NormalCode("die Zustandsübergangsfunktion "),
+                ],
-                CommandName("übergang"),
+            );
-                NormalCode(" Änderungen")
+            assert_eq!(
-            ],
+                run("mount", r"mount \\{{computer_name}}\{{share_name}} Z:"),
-        );
+                [
+                    CommandName("mount"),
+                    NormalCode(r" \\"),
+                    Placeholder("computer_name"),
+                    NormalCode(r"\"),
+                    Placeholder("share_name"),
+                    NormalCode(" Z:"),
+                ],
+            );
+
+            assert_eq!(run("", r"\{"), [NormalCode(r"\{")]);
+            assert_eq!(run("", r"\{{a"), [NormalCode(r"\{{a")]);
+            assert_eq!(run("", r"\{{a}}"), [NormalCode(r"\"), Placeholder("a")]);
+
+            // Placeholder has begin marker, but no end marker
+            assert_eq!(run("", r"{{\}\}}"), [NormalCode("{{}}}")]);
+        }
+
+        #[test]
+        fn outer_precedence() {
+            assert_eq!(
+                run("git stash", "git stash show --patch {{stash@{0}}}"),
+                [
+                    CommandName("git stash"),
+                    NormalCode(" show --patch "),
+                    Placeholder("stash@{0}"),
+                ],
+            );
+
+            // The following is not listed in the specification, but this is the highlighting I would expect.
+            assert_eq!(
+                run("rg", "rg {{}}}"),
+                [CommandName("rg"), NormalCode(" "), Placeholder("}")]
+            );
+
+            // And these are just to document the current behavior
+            assert_eq!(run("", "{{{}}}"), [Placeholder("{}")]);
+            assert_eq!(run("", "{{{{}}}"), [Placeholder("{{}")]);
+            assert_eq!(run("", "{{{}}}}"), [Placeholder("{}}")]);
+        }
+
+        #[test]
+        fn escaped_inside_placeholder() {
+            assert_eq!(
+                run(
+                    "playerctl",
+                    r#"playerctl metadata {{[-f|--format]}} "{{Now playing: \{\{artist\}\} - \{\{album\}\} - \{\{title\}\}}}""#
+                ),
+                [
+                    CommandName("playerctl"),
+                    NormalCode(" metadata "),
+                    PlaceholderVariants {
+                        short: "-f",
+                        long: "--format"
+                    },
+                    NormalCode(" \""),
+                    Placeholder("Now playing: {{artist}} - {{album}} - {{title}}"),
+                    NormalCode("\""),
+                ],
+            );
+        }
+
+        #[test]
+        fn placeholder_inside_escaped() {
+            assert_eq!(
+                run("test", r"test \{\{{{var}} normal\}\}"),
+                [
+                    CommandName("test"),
+                    NormalCode(" {{"),
+                    Placeholder("var"),
+                    NormalCode(" normal}}"),
+                ],
+            );
+        }
+
+        #[test]
+        /// Regression test for <https://github.com/tealdeer-rs/tealdeer/issues/473>
+        fn prefix_check_character_boundary() {
+            assert_eq!("Ä".len(), 2);
+            assert_eq!(run("", r"Äxx{{x}}"), [NormalCode("Äxx"), Placeholder("x")],);
+        }
     }
 
-    #[test]
+    mod placeholder_variants {
-    fn test_empty_command() {
+        use super::*;
-        let segment = "some code";
+        use PageSnippet::*;
-        let snippets = [NormalCode(segment)];
 
-        assert_eq!(run("", segment), snippets);
+        #[test]
-        assert_eq!(run(" ", segment), snippets);
+        fn missing_marker() {
-        assert_eq!(run("  \t ", segment), snippets);
+            assert_eq!(
+                run("foo", "{{[short|long]}}"),
+                [PlaceholderVariants {
+                    short: "short",
+                    long: "long"
+                }]
+            );
+
+            assert_eq!(run("foo", "{{short|long]}}"), [Placeholder("short|long]")]);
+            assert_eq!(run("foo", "{{[short|long}}"), [Placeholder("[short|long")]);
+            assert_eq!(run("foo", "{{[shortlong]}}"), [Placeholder("[shortlong]")]);
+        }
+
+        /// The character `[` is a valid command name
+        #[test]
+        fn command_name_interaction() {
+            for name in ["[", "]", "|"] {
+                assert_eq!(
+                    run(name, "{{[short|long]}}"),
+                    [PlaceholderVariants {
+                        short: "short",
+                        long: "long"
+                    }]
+                );
+            }
+        }
+
+        #[test]
+        fn empty_variant() {
+            for name in ["[", "]", "|"] {
+                assert_eq!(
+                    run(name, "{{[|long]}}"),
+                    [PlaceholderVariants {
+                        short: "",
+                        long: "long"
+                    }]
+                );
+                assert_eq!(
+                    run(name, "{{[short|]}}"),
+                    [PlaceholderVariants {
+                        short: "short",
+                        long: ""
+                    }]
+                );
+                assert_eq!(run(name, "{{[|]}}"), [] as [PageSnippet::<String>; 0]);
+            }
+        }
     }
 }

src/line_iterator.rs

@@ -1,6 +1,6 @@
 //! Code to split a `BufRead` instance into an iterator of `LineType`s.
 
-use std::io::BufRead;
+use std::io::{BufRead, Read};
 
 use log::warn;
 
@@ -12,7 +12,7 @@ pub enum TldrFormat {
     Undecided,
     /// The original format
     V1,
-    /// The new format (see https://github.com/tldr-pages/tldr/pull/958)
+    /// The new format (see <https://github.com/tldr-pages/tldr/pull/958>)
     V2,
 }
 
@@ -53,7 +53,7 @@ impl<R: BufRead> Iterator for LineIterator<R> {
         match bytes_read {
             Ok(0) => None,
             Err(e) => {
-                warn!("Could not read line from reader: {:?}", e);
+                warn!("Could not read line from reader: {e:?}");
                 None
             }
             Ok(_) => {
@@ -64,10 +64,11 @@ impl<R: BufRead> Iterator for LineIterator<R> {
                         self.format = TldrFormat::V1;
                     } else {
                         // It's the new format! Drop next line.
-                        // (Hmm, is there a way to do this without an allocation?)
+                        if let Err(e) = Read::bytes(&mut self.reader)
-                        let mut devnull = String::new();
+                            .find(|b| matches!(b, Ok(b'\n') | Err(_)))
-                        if let Err(e) = self.reader.read_line(&mut devnull) {
+                            .transpose()
-                            warn!("Could not read line from reader: {:?}", e);
+                        {
+                            warn!("Could not read line from reader: {e:?}");
                             return None;
                         }
                         self.first_line = false;
@@ -95,21 +96,27 @@ mod test {
 
     #[test]
     fn test_first_line_old_format() {
-        let input = "# The Title\n\n";
+        let input = "# The Title\n> Description\n";
         let mut lines = LineIterator::new(input.as_bytes());
         let title = lines.next().unwrap();
         assert_eq!(title, LineType::Title("The Title".to_string()));
-        let empty = lines.next().unwrap();
+        let description = lines.next().unwrap();
-        assert_eq!(empty, LineType::Empty);
+        assert_eq!(
+            description,
+            LineType::Description("Description".to_string())
+        );
     }
 
     #[test]
     fn test_first_line_new_format() {
-        let input = "The Title\n=========\n\n";
+        let input = "The Title\n=========\n> Description\n";
         let mut lines = LineIterator::new(input.as_bytes());
         let title = lines.next().unwrap();
         assert_eq!(title, LineType::Title("The Title".to_string()));
-        let empty = lines.next().unwrap();
+        let description = lines.next().unwrap();
-        assert_eq!(empty, LineType::Empty);
+        assert_eq!(
+            description,
+            LineType::Description("Description".to_string())
+        );
     }
 }

src/main.rs

@@ -15,20 +15,32 @@
 #![allow(clippy::similar_names)]
 #![allow(clippy::struct_excessive_bools)]
 #![allow(clippy::too_many_lines)]
+#![allow(clippy::unnecessary_debug_formatting)]
+#![allow(clippy::while_let_loop)]
 
-#[cfg(any(
+#[cfg(not(any(
-    all(feature = "native-roots", feature = "webpki-roots"),
+    feature = "native-tls",
-    not(any(feature = "native-roots", feature = "webpki-roots")),
+    feature = "rustls-with-webpki-roots",
-))]
+    feature = "rustls-with-native-roots",
+)))]
 compile_error!(
-    "exactly one of feature \"native-roots\" and feature \"webpki-roots\" must be enabled"
+    "at least one of the features \"native-tls\", \"rustls-with-webpki-roots\" or \"rustls-with-native-roots\" must be enabled"
 );
 
-use std::{env, process};
+use std::{
+    env,
+    fs::create_dir_all,
+    io::{self, IsTerminal},
+    path::Path,
+    process::{Command, ExitCode},
+};
 
-use app_dirs::AppInfo;
+use anyhow::{Context, Result, anyhow};
-use atty::Stream;
+use cache::CacheConfig;
 use clap::Parser;
+use config::{ConfigLoader, Language, StyleConfig, TlsBackend};
+use log::debug;
+use types::PlatformType;
 
 mod cache;
 mod cli;
@@ -41,121 +53,68 @@ mod types;
 mod utils;
 
 use crate::{
-    cache::{Cache, CacheFreshness, PageLookupResult, TLDR_PAGES_DIR},
+    cache::{Cache, PageLookupResult, TLDR_PAGES_DIR},
-    cli::Args,
+    cli::Cli,
-    config::{get_config_dir, get_config_path, make_default_config, Config, PathWithSource},
+    config::{
-    extensions::Dedup,
+        Config, PathWithSource, PlaceholderFormat, get_config_dir, make_default_config,
+        supported_tls_backends_string,
+    },
     output::print_page,
-    types::{ColorOptions, PlatformType},
+    types::ColorOptions,
     utils::{print_error, print_warning},
 };
 
 const NAME: &str = "tealdeer";
-const APP_INFO: AppInfo = AppInfo {
+static TEALDEER_PAGE: &str =
-    name: NAME,
+    include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/pages/tealdeer.md"));
-    author: NAME,
-};
-const ARCHIVE_URL: &str = "https://tldr.sh/assets/tldr.zip";
-
-/// The cache should be updated if it was explicitly requested,
-/// or if an automatic update is due and allowed.
-fn should_update_cache(cache: &Cache, args: &Args, config: &Config) -> bool {
-    args.update
-        || (!args.no_auto_update
-            && config.updates.auto_update
-            && cache
-                .last_update()
-                .map_or(true, |ago| ago >= config.updates.auto_update_interval))
-}
-
-#[derive(PartialEq)]
-enum CheckCacheResult {
-    CacheFound,
-    CacheMissing,
-}
-
-/// Check the cache for freshness. If it's stale or missing, show a warning.
-fn check_cache(cache: &Cache, args: &Args, enable_styles: bool) -> CheckCacheResult {
-    match cache.freshness() {
-        CacheFreshness::Fresh => CheckCacheResult::CacheFound,
-        CacheFreshness::Stale(_) if args.quiet => CheckCacheResult::CacheFound,
-        CacheFreshness::Stale(age) => {
-            print_warning(
-                enable_styles,
-                &format!(
-                    "The cache hasn't been updated for {} days.\n\
-                     You should probably run `tldr --update` soon.",
-                    age.as_secs() / 24 / 3600
-                ),
-            );
-            CheckCacheResult::CacheFound
-        }
-        CacheFreshness::Missing => {
-            print_error(
-                enable_styles,
-                &anyhow::anyhow!(
-                    "Page cache not found. Please run `tldr --update` to download the cache."
-                ),
-            );
-            println!("\nNote: You can optionally enable automatic cache updates by adding the");
-            println!("following config to your config file:\n");
-            println!("  [updates]");
-            println!("  auto_update = true\n");
-            println!("The path to your config file can be looked up with `tldr --show-paths`.");
-            println!("To create an initial config file, use `tldr --seed-config`.\n");
-            println!("You can find more tips and tricks in our docs:\n");
-            println!("  https://dbrgn.github.io/tealdeer/config_updates.html");
-            CheckCacheResult::CacheMissing
-        }
-    }
-}
 
 /// Clear the cache
-fn clear_cache(cache: &Cache, quietly: bool, enable_styles: bool) {
+fn clear_cache(cache: Cache, quietly: bool) -> Result<()> {
-    let cache_dir_found = cache.clear().unwrap_or_else(|e| {
+    let cache_dir = cache.config().pages_directory.display();
-        print_error(enable_styles, &e.context("Could not clear cache"));
+    cache.clear().context("Could not clear cache")?;
-        process::exit(1);
-    });
     if !quietly {
-        let cache_dir = cache.cache_dir().display();
+        eprintln!("Successfully cleared cache at `{cache_dir}`.");
-        if cache_dir_found {
-            eprintln!("Successfully cleared cache at `{}`.", cache_dir);
-        } else {
-            eprintln!(
-                "Cache directory not found at `{}`, nothing to do.",
-                cache_dir
-            );
-        }
     }
+    Ok(())
 }
 
 /// Update the cache
-fn update_cache(cache: &Cache, quietly: bool, enable_styles: bool) {
+fn update_cache(
-    cache.update(ARCHIVE_URL).unwrap_or_else(|e| {
+    cache: &mut Cache,
-        print_error(enable_styles, &e.context("Could not update cache"));
+    archive_source: &str,
-        process::exit(1);
+    tls_backend: TlsBackend,
-    });
+    quietly: bool,
+) -> Result<()> {
+    let downloaded_languages = cache
+        .update(archive_source, tls_backend)
+        .context("Could not update cache")?;
     if !quietly {
         eprintln!("Successfully updated cache.");
+        eprint!("Pages for the following languages were downloaded: ");
+        let language_strings: Vec<_> = downloaded_languages
+            .into_iter()
+            .map(|lang| lang.0)
+            .collect();
+        if language_strings.is_empty() {
+            eprintln!("(none)");
+        } else {
+            eprintln!("{}", language_strings.join(", "));
+        }
     }
+    Ok(())
 }
 
 /// Show file paths
 fn show_paths(config: &Config) {
-    let config_dir = get_config_dir().map_or_else(
+    let config_dir = {
-        |e| format!("[Error: {}]", e),
+        let (mut path, source) = get_config_dir();
-        |(mut path, source)| {
+        path.push(""); // Trailing path separator
-            path.push(""); // Trailing path separator
+        match path.to_str() {
-            match path.to_str() {
+            Some(path) => format!("{path} ({source})"),
-                Some(path) => format!("{} ({})", path, source),
+            None => "[Invalid]".to_string(),
-                None => "[Invalid]".to_string(),
+        }
-            }
+    };
-        },
+    let config_path = config.file_path.to_string();
-    );
-    let config_path = get_config_path().map_or_else(
-        |e| format!("[Error: {}]", e),
-        |(path, _)| path.display().to_string(),
-    );
     let cache_dir = config.directories.cache_dir.to_string();
     let pages_dir = {
         let mut path = config.directories.cache_dir.path.clone();
@@ -167,28 +126,20 @@ fn show_paths(config: &Config) {
         Some(ref path_with_source) => path_with_source.to_string(),
         None => "[None]".to_string(),
     };
-    println!("Config dir:       {}", config_dir);
+    println!("Config dir:       {config_dir}");
-    println!("Config path:      {}", config_path);
+    println!("Config path:      {config_path}");
-    println!("Cache dir:        {}", cache_dir);
+    println!("Cache dir:        {cache_dir}");
-    println!("Pages dir:        {}", pages_dir);
+    println!("Pages dir:        {pages_dir}");
-    println!("Custom pages dir: {}", custom_pages_dir);
+    println!("Custom pages dir: {custom_pages_dir}");
 }
 
-/// Create seed config file and exit
+fn create_config(path: Option<&Path>) -> Result<()> {
-fn create_config_and_exit(enable_styles: bool) {
+    let config_file_path = make_default_config(path).context("Could not create seed config")?;
-    match make_default_config() {
+    eprintln!(
-        Ok(config_file_path) => {
+        "Successfully created seed config file here: {}",
-            eprintln!(
+        config_file_path.to_str().unwrap()
-                "Successfully created seed config file here: {}",
+    );
-                config_file_path.to_str().unwrap()
+    Ok(())
-            );
-            process::exit(0);
-        }
-        Err(e) => {
-            print_error(enable_styles, &e.context("Could not create seed config"));
-            process::exit(1);
-        }
-    }
 }
 
 #[cfg(feature = "logging")]
@@ -199,76 +150,102 @@ fn init_log() {
 #[cfg(not(feature = "logging"))]
 fn init_log() {}
 
-fn get_languages(env_lang: Option<&str>, env_language: Option<&str>) -> Vec<String> {
+fn spawn_editor(custom_pages_dir: &Path, file_name: &str) -> Result<()> {
-    // Language list according to
+    create_dir_all(custom_pages_dir).context("Failed to create custom pages directory")?;
-    // https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#language
 
-    if env_lang.is_none() {
+    let custom_page_path = custom_pages_dir.join(file_name);
-        return vec!["en".to_string()];
+    let Some(custom_page_path) = custom_page_path.to_str() else {
+        return Err(anyhow!("`custom_page_path.to_str()` failed"));
+    };
+    let Ok(editor) = env::var("EDITOR") else {
+        return Err(anyhow!(
+            "To edit a custom page, please set the `EDITOR` environment variable."
+        ));
+    };
+    println!("Editing {custom_page_path:?}");
+
+    let status = Command::new(&editor).arg(custom_page_path).status()?;
+    if !status.success() {
+        return Err(anyhow!("{editor} exit with code {:?}", status.code()));
     }
-    let env_lang = env_lang.unwrap();
+    Ok(())
-
-    // Create an iterator that contains $LANGUAGE (':' separated list) followed by $LANG (single language)
-    let locales = env_language.unwrap_or("").split(':').chain([env_lang]);
-
-    let mut lang_list = Vec::new();
-    for locale in locales {
-        // Language plus country code (e.g. `en_US`)
-        if locale.len() >= 5 && locale.chars().nth(2) == Some('_') {
-            lang_list.push(&locale[..5]);
-        }
-        // Language code only (e.g. `en`)
-        if locale.len() >= 2 && locale != "POSIX" {
-            lang_list.push(&locale[..2]);
-        }
-    }
-
-    lang_list.push("en");
-    lang_list.clear_duplicates();
-    lang_list.into_iter().map(str::to_string).collect()
 }
 
-fn get_languages_from_env() -> Vec<String> {
+fn main() -> ExitCode {
-    get_languages(
-        std::env::var("LANG").ok().as_deref(),
-        std::env::var("LANGUAGE").ok().as_deref(),
-    )
-}
-
-fn main() {
     // Initialize logger
     init_log();
 
     // Parse arguments
-    let args = Args::parse();
+    let args = Cli::parse();
 
     // Determine the usage of styles
-    #[cfg(target_os = "windows")]
-    let ansi_support = yansi::Paint::enable_windows_ascii();
-    #[cfg(not(target_os = "windows"))]
-    let ansi_support = true;
     let enable_styles = match args.color.unwrap_or_default() {
         // Attempt to use styling if instructed
-        ColorOptions::Always => true,
+        ColorOptions::Always => {
+            yansi::enable(); // disable yansi's automatic detection for ANSI support on Windows
+            true
+        }
         // Enable styling if:
-        // * There is `ansi_support`
         // * NO_COLOR env var isn't set: https://no-color.org/
         // * The output stream is stdout (not being piped)
-        ColorOptions::Auto => {
+        ColorOptions::Auto => env::var_os("NO_COLOR").is_none() && io::stdout().is_terminal(),
-            ansi_support && env::var_os("NO_COLOR").is_none() && atty::is(Stream::Stdout)
-        }
         // Disable styling
         ColorOptions::Never => false,
     };
 
+    try_main(args, enable_styles).unwrap_or_else(|error| {
+        print_error(enable_styles, &error);
+        ExitCode::FAILURE
+    })
+}
+
+fn try_main(args: Cli, enable_styles: bool) -> Result<ExitCode> {
     // Look up config file, if none is found fall back to default config.
-    let config = match Config::load(enable_styles) {
+    debug!("Loading config");
-        Ok(config) => config,
+    let config_loader = match &args.config_path {
-        Err(e) => {
+        Some(path) if !args.seed_config => ConfigLoader::read(path.clone(), &args.override_config)
-            print_error(enable_styles, &e.context("Could not load config"));
+            .context("Could not read config from given path")?,
-            process::exit(1);
+        _ => ConfigLoader::read_default_path(&args.override_config)
-        }
+            .context("Could not read config from default path")?,
     };
+    let mut config = config_loader.load()?;
+
+    // Override styles if needed
+    if !enable_styles {
+        config.style = StyleConfig::default();
+    }
+
+    config.display.placeholder_format = match (args.short_options, args.long_options) {
+        (false, false) => config.display.placeholder_format, // keep old value
+        (true, false) => PlaceholderFormat::Short,
+        (false, true) => PlaceholderFormat::Long,
+        (true, true) => PlaceholderFormat::Both,
+    };
+
+    let custom_pages_dir = config
+        .directories
+        .custom_pages_dir
+        .as_ref()
+        .map(PathWithSource::path);
+
+    // Note: According to the TLDR client spec, page names must be transparently
+    // lowercased before lookup:
+    // https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#page-names
+    let command = args.command.join("-").to_lowercase();
+
+    if args.edit_patch || args.edit_page {
+        let file_name = if args.edit_patch {
+            format!("{command}.patch.md")
+        } else {
+            format!("{command}.page.md")
+        };
+
+        custom_pages_dir
+            .context("To edit custom pages/patches, please specify a custom pages directory.")
+            .and_then(|custom_pages_dir| spawn_editor(custom_pages_dir, &file_name))?;
+
+        return Ok(ExitCode::SUCCESS);
+    }
 
     // Show various paths
     if args.show_paths {
@@ -277,149 +254,191 @@ fn main() {
 
     // Create a basic config and exit
     if args.seed_config {
-        create_config_and_exit(enable_styles);
+        create_config(args.config_path.as_deref())?;
+        return Ok(ExitCode::SUCCESS);
     }
 
-    // Specify target OS
-    let platform: PlatformType = args.platform.unwrap_or_else(PlatformType::current);
-
     // If a local file was passed in, render it and exit
     if let Some(file) = args.render {
-        let path = PageLookupResult::with_page(file);
+        let reader = PageLookupResult::with_page(file).reader()?;
-        if let Err(ref e) = print_page(&path, args.raw, enable_styles, args.pager, &config) {
+        print_page(reader, args.raw, enable_styles, args.pager, &config)?;
-            print_error(enable_styles, e);
+        return Ok(ExitCode::SUCCESS);
-            process::exit(1);
-        } else {
-            process::exit(0);
-        };
     }
 
-    // Instantiate cache. This will not yet create the cache directory!
+    // The tealdeer page is embedded in the binary, no cache needed
-    let cache = Cache::new(platform, &config.directories.cache_dir.path);
+    if command == "tealdeer" {
-
+        print_page(
-    // Clear cache, pass through
+            TEALDEER_PAGE.as_bytes(),
-    if args.clear_cache {
+            args.raw,
-        clear_cache(&cache, args.quiet, enable_styles);
+            enable_styles,
+            args.pager,
+            &config,
+        )?;
+        return Ok(ExitCode::SUCCESS);
     }
 
-    // Cache update, pass through
+    if let Some(platforms) = args.platforms {
-    let cache_updated = if should_update_cache(&cache, &args, &config) {
+        config.search.platforms = platforms;
-        update_cache(&cache, args.quiet, enable_styles);
+        if !config.search.platforms.contains(&PlatformType::Common) {
-        true
+            config.search.platforms.push(PlatformType::Common);
-    } else {
+        }
-        false
+    }
+
+    let (search_languages, download_languages): (&[_], &[_]) = match args.language.as_deref() {
+        Some(lang) => (&[Language(lang)], &[Language(lang)]),
+        None => (&config.search.languages, &config.updates.download_languages),
     };
 
-    // Check cache presence and freshness
+    let cache_config = CacheConfig {
-    if !cache_updated
+        pages_directory: &config.directories.cache_dir.path().join(TLDR_PAGES_DIR),
-        && (args.list || !args.command.is_empty())
+        custom_pages_directory: config
-        && check_cache(&cache, &args, enable_styles) == CheckCacheResult::CacheMissing
-    {
-        process::exit(1);
-    }
-
-    // List cached commands and exit
-    if args.list {
-        let custom_pages_dir = config
             .directories
             .custom_pages_dir
             .as_ref()
-            .map(PathWithSource::path);
+            .map(PathWithSource::path),
-        println!("{}", cache.list_pages(custom_pages_dir).join("\n"));
+        platforms: &config.search.platforms,
-        process::exit(0);
+        search_languages,
+        download_languages,
+    };
+
+    if args.clear_cache {
+        if let Some(cache) = Cache::open(cache_config)? {
+            clear_cache(cache, args.quiet)?;
+        }
+        return Ok(ExitCode::SUCCESS);
+    }
+
+    let cache = if args.update || config.updates.auto_update && !args.no_auto_update {
+        let (mut cache, was_created) = Cache::open_or_create(cache_config)?;
+        if was_created || args.update || cache.age()? >= config.updates.auto_update_interval {
+            let result = update_cache(
+                &mut cache,
+                config.updates.archive_source,
+                config.updates.tls_backend,
+                args.quiet,
+            );
+
+            if let Err(e) = result {
+                print_error(enable_styles, &e);
+
+                eprintln!();
+                eprintln!(
+                    "Note: Update errors are often caused by unexpected or missing TLS certificates."
+                );
+                eprintln!(
+                    "You are currently using the following TLS backend: {}",
+                    config.updates.tls_backend,
+                );
+                eprintln!(
+                    "Try changing the updates.tls_backend setting in the config file, for example:"
+                );
+                eprintln!();
+                eprintln!("  [updates]");
+                eprintln!("  tls_backend = \"rustls-with-native-roots\"");
+                eprintln!();
+                eprintln!(
+                    "This build of tealdeer has support for the following options: {}",
+                    supported_tls_backends_string(),
+                );
+
+                return Ok(ExitCode::FAILURE);
+            }
+        }
+
+        cache
+    } else if args.list || !command.is_empty() {
+        // Cache is needed for these commands to work
+        let Some(cache) = Cache::open(cache_config)? else {
+            if !args.quiet {
+                print_error(
+                    enable_styles,
+                    &anyhow::anyhow!(
+                        "Page cache not found. Please run `tldr --update` to download the cache."
+                    ),
+                );
+                println!("\nNote: You can optionally enable automatic cache updates by adding the");
+                println!("following config to your config file:\n");
+                println!("  [updates]");
+                println!("  auto_update = true\n");
+                println!("The path to your config file can be looked up with `tldr --show-paths`.");
+                println!("To create an initial config file, use `tldr --seed-config`.\n");
+                println!("You can find more tips and tricks in our docs:\n");
+                println!("  https://docs.tealdeer.org");
+            }
+
+            return Ok(ExitCode::FAILURE);
+        };
+
+        if let Some(max_cache_age) = config.updates.warn_cache_age {
+            let age = cache.age()?;
+            if age > max_cache_age && !args.quiet {
+                print_warning(
+                    enable_styles,
+                    &format!(
+                        "The cache hasn't been updated for {} days.\n\
+                         You should probably run `tldr --update` soon.",
+                        age.as_secs() / 24 / 3600
+                    ),
+                );
+            }
+        }
+
+        cache
+    } else {
+        // There is nothing left to do
+        return Ok(ExitCode::SUCCESS);
+    };
+
+    if args.list {
+        for page in cache.list_pages()? {
+            println!("{page}");
+        }
+
+        return Ok(ExitCode::SUCCESS);
     }
 
     // Show command from cache
-    if !args.command.is_empty() {
+    if !command.is_empty() {
-        // Note: According to the TLDR client spec, page names must be transparently
+        // TODO: Remove this check 1 year after version 1.7.0 was released
-        // lowercased before lookup:
+        if cache.old_custom_pages_exist()? {
-        // https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md#page-names
+            print_warning(
-        let command = args.command.join("-").to_lowercase();
+                enable_styles,
+                &format!(
+                    "Custom pages using the old naming convention were found in {}.\n\
+                     Please rename them to follow the new convention:\n\
+                     - `<name>.page` → `<name>.page.md`\n\
+                     - `<name>.patch` → `<name>.patch.md`",
+                    cache
+                        .config()
+                        .custom_pages_directory
+                        .expect("Old custom pages can only exist in custom pages directory")
+                        .display(),
+                ),
+            );
+        }
 
-        // Collect languages
+        let Some(result) = cache.find_page(&command) else {
-        let languages = args
-            .language
-            .map_or_else(get_languages_from_env, |lang| vec![lang]);
-
-        // Search for command in cache
-        if let Some(lookup_result) = cache.find_page(
-            &command,
-            &languages,
-            config
-                .directories
-                .custom_pages_dir
-                .as_ref()
-                .map(PathWithSource::path),
-        ) {
-            if let Err(ref e) =
-                print_page(&lookup_result, args.raw, enable_styles, args.pager, &config)
-            {
-                print_error(enable_styles, e);
-                process::exit(1);
-            }
-            process::exit(0);
-        } else {
             if !args.quiet {
                 print_warning(
                     enable_styles,
                     &format!(
-                        "Page `{}` not found in cache.\n\
+                        "Page `{command}` not found in cache.\n\
                          Try updating with `tldr --update`, or submit a pull request to:\n\
-                         https://github.com/tldr-pages/tldr",
+                         https://github.com/tldr-pages/tldr"
-                        &command
                     ),
                 );
             }
-            process::exit(1);
+            return Ok(ExitCode::FAILURE);
-        }
+        };
-    }
+
-}
+        print_page(
-
+            result.reader()?,
-#[cfg(test)]
+            args.raw,
-mod test {
+            enable_styles,
-    use crate::get_languages;
+            args.pager,
-
+            &config,
-    mod language {
+        )?;
-        use super::*;
-
-        #[test]
-        fn missing_lang_env() {
-            let lang_list = get_languages(None, Some("de:fr"));
-            assert_eq!(lang_list, ["en"]);
-            let lang_list = get_languages(None, None);
-            assert_eq!(lang_list, ["en"]);
-        }
-
-        #[test]
-        fn missing_language_env() {
-            let lang_list = get_languages(Some("de"), None);
-            assert_eq!(lang_list, ["de", "en"]);
-        }
-
-        #[test]
-        fn preference_order() {
-            let lang_list = get_languages(Some("de"), Some("fr:cn"));
-            assert_eq!(lang_list, ["fr", "cn", "de", "en"]);
-        }
-
-        #[test]
-        fn country_code_expansion() {
-            let lang_list = get_languages(Some("pt_BR"), None);
-            assert_eq!(lang_list, ["pt_BR", "pt", "en"]);
-        }
-
-        #[test]
-        fn ignore_posix_and_c() {
-            let lang_list = get_languages(Some("POSIX"), None);
-            assert_eq!(lang_list, ["en"]);
-            let lang_list = get_languages(Some("C"), None);
-            assert_eq!(lang_list, ["en"]);
-        }
-
-        #[test]
-        fn no_duplicates() {
-            let lang_list = get_languages(Some("de"), Some("fr:de:cn:de"));
-            assert_eq!(lang_list, ["fr", "de", "cn", "en"]);
-        }
     }
+
+    Ok(ExitCode::SUCCESS)
 }

src/output.rs

@@ -1,13 +1,13 @@
 //! Functions for printing pages to the terminal
 
-use std::io::{self, BufRead, Write};
+use std::io::{self, BufRead, BufReader, Read, Write};
 
 use anyhow::{Context, Result};
+use yansi::Paint;
 
 use crate::{
-    cache::PageLookupResult,
+    config::{Config, PlaceholderFormat, StyleConfig},
-    config::{Config, StyleConfig},
+    formatter::{PageSnippet, highlight_lines},
-    formatter::{highlight_lines, PageSnippet},
     line_iterator::LineIterator,
 };
 
@@ -29,14 +29,13 @@ fn configure_pager(enable_styles: bool) {
 
 /// Print page by path
 pub fn print_page(
-    lookup_result: &PageLookupResult,
+    reader: impl Read,
     enable_markdown: bool,
     enable_styles: bool,
     use_pager: bool,
     config: &Config,
 ) -> Result<()> {
-    // Create reader from file(s)
+    let reader = BufReader::new(reader);
-    let reader = lookup_result.reader()?;
 
     // Configure pager if applicable
     if use_pager || config.display.use_pager {
@@ -51,15 +50,21 @@ pub fn print_page(
         // Print the raw markdown of the file.
         for line in reader.lines() {
             let line = line.context("Error while reading from a page")?;
-            writeln!(handle, "{}", line).context("Could not write to stdout")?;
+            writeln!(handle, "{line}").context("Could not write to stdout")?;
         }
     } else {
         // Closure that processes a page snippet and writes it to stdout
-        let mut process_snippet = |snip: PageSnippet<'_>| {
+        let mut process_snippet = |snip: PageSnippet<&str>| {
             if snip.is_empty() {
                 Ok(())
             } else {
-                print_snippet(&mut handle, snip, &config.style).context("Failed to print snippet")
+                print_snippet(
+                    &mut handle,
+                    snip,
+                    &config.style,
+                    config.display.placeholder_format,
+                )
+                .context("Failed to print snippet")
             }
         };
 
@@ -68,9 +73,11 @@ pub fn print_page(
             LineIterator::new(reader),
             &mut process_snippet,
             !config.display.compact,
+            config.display.show_title,
+            config.display.indent,
         )
         .context("Could not write to stdout")?;
-    };
+    }
 
     // We're done outputting data, flush stdout now!
     handle.flush().context("Could not flush stdout")?;
@@ -80,17 +87,30 @@ pub fn print_page(
 
 fn print_snippet(
     writer: &mut impl Write,
-    snip: PageSnippet<'_>,
+    snip: PageSnippet<&str>,
     style: &StyleConfig,
+    placeholder_format: PlaceholderFormat,
 ) -> io::Result<()> {
     use PageSnippet::*;
 
     match snip {
-        CommandName(s) => write!(writer, "{}", style.command_name.paint(s)),
+        CommandName(s) | Title(s) => write!(writer, "{}", s.paint(style.command_name)),
-        Variable(s) => write!(writer, "{}", style.example_variable.paint(s)),
+        Placeholder(s) => write!(writer, "{}", s.paint(style.example_variable)),
-        NormalCode(s) => write!(writer, "{}", style.example_code.paint(s)),
+        PlaceholderVariants { short, long } => match placeholder_format {
-        Description(s) => writeln!(writer, "  {}", style.description.paint(s)),
+            PlaceholderFormat::Short => write!(writer, "{}", short.paint(style.example_code)),
-        Text(s) => writeln!(writer, "  {}", style.example_text.paint(s)),
+            PlaceholderFormat::Long => write!(writer, "{}", long.paint(style.example_code)),
+            PlaceholderFormat::Both => {
+                write!(
+                    writer,
+                    "{}",
+                    format!("[{short}|{long}]").paint(style.example_code)
+                )
+            }
+        },
+        NormalCode(s) => write!(writer, "{}", s.paint(style.example_code)),
+        Description(s) => write!(writer, "{}", s.paint(style.description)),
+        Text(s) => write!(writer, "{}", s.paint(style.example_text)),
+        Indent(n) => write!(writer, "{:n$}", ' '),
         Linebreak => writeln!(writer),
     }
 }

src/types.rs

@@ -2,7 +2,6 @@
 
 use std::{fmt, str};
 
-use anyhow::{anyhow, Result};
 use serde_derive::{Deserialize, Serialize};
 
 #[derive(Debug, Eq, PartialEq, Copy, Clone, Serialize, Deserialize)]
@@ -11,9 +10,13 @@ use serde_derive::{Deserialize, Serialize};
 pub enum PlatformType {
     Linux,
     OsX,
-    SunOs,
     Windows,
+    SunOs,
     Android,
+    FreeBsd,
+    NetBsd,
+    OpenBsd,
+    Common,
 }
 
 impl fmt::Display for PlatformType {
@@ -21,27 +24,43 @@ impl fmt::Display for PlatformType {
         match self {
             Self::Linux => write!(f, "Linux"),
             Self::OsX => write!(f, "macOS / BSD"),
-            Self::SunOs => write!(f, "SunOS"),
             Self::Windows => write!(f, "Windows"),
+            Self::SunOs => write!(f, "SunOS"),
             Self::Android => write!(f, "Android"),
+            Self::FreeBsd => write!(f, "FreeBSD"),
+            Self::NetBsd => write!(f, "NetBSD"),
+            Self::OpenBsd => write!(f, "OpenBSD"),
+            Self::Common => write!(f, "Common"),
         }
     }
 }
 
-impl str::FromStr for PlatformType {
+impl clap::ValueEnum for PlatformType {
-    type Err = anyhow::Error;
+    fn value_variants<'a>() -> &'a [Self] {
+        &[
+            Self::Linux,
+            Self::OsX,
+            Self::SunOs,
+            Self::Windows,
+            Self::Android,
+            Self::FreeBsd,
+            Self::NetBsd,
+            Self::OpenBsd,
+            Self::Common,
+        ]
+    }
 
-    fn from_str(s: &str) -> Result<Self, Self::Err> {
+    fn to_possible_value<'a>(&self) -> Option<clap::builder::PossibleValue> {
-        match s {
+        match self {
-            "linux" => Ok(Self::Linux),
+            Self::Linux => Some(clap::builder::PossibleValue::new("linux")),
-            "osx" | "macos" => Ok(Self::OsX),
+            Self::OsX => Some(clap::builder::PossibleValue::new("macos").alias("osx")),
-            "sunos" => Ok(Self::SunOs),
+            Self::Windows => Some(clap::builder::PossibleValue::new("windows")),
-            "windows" => Ok(Self::Windows),
+            Self::SunOs => Some(clap::builder::PossibleValue::new("sunos")),
-            "android" => Ok(Self::Android),
+            Self::Android => Some(clap::builder::PossibleValue::new("android")),
-            other => Err(anyhow!(
+            Self::FreeBsd => Some(clap::builder::PossibleValue::new("freebsd")),
-                "Unknown OS: {}. Possible values: linux, macos, osx, sunos, windows, android",
+            Self::NetBsd => Some(clap::builder::PossibleValue::new("netbsd")),
-                other
+            Self::OpenBsd => Some(clap::builder::PossibleValue::new("openbsd")),
-            )),
+            Self::Common => Some(clap::builder::PossibleValue::new("common")),
         }
     }
 }
@@ -52,13 +71,7 @@ impl PlatformType {
         Self::Linux
     }
 
-    #[cfg(any(
+    #[cfg(any(target_os = "macos", target_os = "dragonfly"))]
-        target_os = "macos",
-        target_os = "freebsd",
-        target_os = "netbsd",
-        target_os = "openbsd",
-        target_os = "dragonfly"
-    ))]
     pub fn current() -> Self {
         Self::OsX
     }
@@ -73,6 +86,21 @@ impl PlatformType {
         Self::Android
     }
 
+    #[cfg(target_os = "freebsd")]
+    pub fn current() -> Self {
+        Self::FreeBsd
+    }
+
+    #[cfg(target_os = "netbsd")]
+    pub fn current() -> Self {
+        Self::NetBsd
+    }
+
+    #[cfg(target_os = "openbsd")]
+    pub fn current() -> Self {
+        Self::OpenBsd
+    }
+
     #[cfg(not(any(
         target_os = "linux",
         target_os = "macos",
@@ -88,36 +116,16 @@ impl PlatformType {
     }
 }
 
-#[derive(Debug, Eq, PartialEq, Copy, Clone, Deserialize)]
+#[derive(Debug, Eq, PartialEq, Copy, Clone, Deserialize, clap::ValueEnum)]
 #[serde(rename_all = "lowercase")]
+#[derive(Default)]
 pub enum ColorOptions {
     Always,
+    #[default]
     Auto,
     Never,
 }
 
-impl str::FromStr for ColorOptions {
-    type Err = anyhow::Error;
-
-    fn from_str(s: &str) -> Result<Self> {
-        match s {
-            "always" => Ok(Self::Always),
-            "auto" => Ok(Self::Auto),
-            "never" => Ok(Self::Never),
-            other => Err(anyhow!(
-                "Unknown color option: {}. Possible values: always, auto, never",
-                other
-            )),
-        }
-    }
-}
-
-impl Default for ColorOptions {
-    fn default() -> Self {
-        Self::Auto
-    }
-}
-
 #[derive(Debug, Eq, PartialEq)]
 pub enum LineType {
     Empty,
@@ -193,6 +201,8 @@ pub enum PathSource {
     EnvVar,
     /// Config file
     ConfigFile,
+    /// CLI argument override
+    Cli,
 }
 
 impl fmt::Display for PathSource {
@@ -204,6 +214,7 @@ impl fmt::Display for PathSource {
                 Self::OsConvention => "OS convention",
                 Self::EnvVar => "env variable",
                 Self::ConfigFile => "config file",
+                Self::Cli => "command line argument",
             }
         )
     }

src/utils.rs

@@ -1,4 +1,4 @@
-use yansi::Color;
+use yansi::{Color, Paint};
 
 /// Print a warning to stderr. If `enable_styles` is true, then a yellow
 /// message will be printed.
@@ -9,18 +9,13 @@ pub fn print_warning(enable_styles: bool, message: &str) {
 /// Print an anyhow error to stderr. If `enable_styles` is true, then a red
 /// message will be printed.
 pub fn print_error(enable_styles: bool, error: &anyhow::Error) {
-    print_msg(
+    print_msg(enable_styles, &format!("{error:?}"), "Error: ", Color::Red);
-        enable_styles,
-        &format!("{:?}", error),
-        "Error: ",
-        Color::Red,
-    );
 }
 
 fn print_msg(enable_styles: bool, message: &str, prefix: &'static str, color: Color) {
     if enable_styles {
-        eprintln!("{}{}", color.paint(prefix), color.paint(message));
+        eprintln!("{}{}", prefix.paint(color), message.paint(color));
     } else {
-        eprintln!("{}", message);
+        eprintln!("{message}");
     }
 }

tests/cache/pages.en/common/git-checkout.md

@@ -0,0 +1,36 @@
+# git checkout
+
+> Checkout a branch or paths to the working tree.
+> More information: <https://git-scm.com/docs/git-checkout>.
+
+- Create and switch to a new branch:
+
+`git checkout -b {{branch_name}}`
+
+- Create and switch to a new branch based on a specific reference (branch, remote/branch, tag are examples of valid references):
+
+`git checkout -b {{branch_name}} {{reference}}`
+
+- Switch to an existing local branch:
+
+`git checkout {{branch_name}}`
+
+- Switch to the previously checked out branch:
+
+`git checkout -`
+
+- Switch to an existing remote branch:
+
+`git checkout --track {{remote_name}}/{{branch_name}}`
+
+- Discard all unstaged changes in the current directory (see `git reset` for more undo-like commands):
+
+`git checkout .`
+
+- Discard unstaged changes to a given file:
+
+`git checkout {{path/to/file}}`
+
+- Replace a file in the current directory with the version of it committed in a given branch:
+
+`git checkout {{branch_name}} -- {{path/to/file}}`

tests/cache/pages.en/common/playerctl.md

@@ -0,0 +1,32 @@
+# playerctl
+
+> Control media players via MPRIS.
+> More information: <https://github.com/altdesktop/playerctl#using-the-cli>.
+
+- Toggle play:
+
+`playerctl play-pause`
+
+- Skip to the next track:
+
+`playerctl next`
+
+- Go back to the previous track:
+
+`playerctl previous`
+
+- List all players:
+
+`playerctl {{[-l|--list-all]}}`
+
+- Send a command to a specific player:
+
+`playerctl {{[-p|--player]}} {{player_name}} {{play-pause|next|previous|...}}`
+
+- Send a command to all players:
+
+`playerctl {{[-a|--all-players]}} {{play-pause|next|previous|...}}`
+
+- Display metadata about the current track:
+
+`playerctl metadata {{[-f|--format]}} "{{Now playing: \{\{artist\}\} - \{\{album\}\} - \{\{title\}\}}}"`

tests/cache/pages.ja/common/apt.md

@@ -0,0 +1,37 @@
+# apt
+
+> Debian系ディストリビューションで使われるパッケージ管理システムです。
+> Ubuntuのバージョンが16.04か、それ以降で対話モードを使う場合`apt-get`の代わりとして使用します。
+> 詳しくはこちら: <https://manned.org/apt.8>
+
+- 利用可能なパーケージとバージョンのリストの更新（他の`apt`コマンドの前での実行を推奨）:
+
+`sudo apt update`
+
+- 指定されたパッケージの検索:
+
+`apt search {{パッケージ}}`
+
+- パッケージの情報を出力:
+
+`apt show {{パッケージ}}`
+
+- パッケージのインストール、または利用可能な最新バージョンに更新:
+
+`sudo apt install {{パッケージ}}`
+
+- パッケージの削除（`sudo apt remove --purge`の場合設定ファイルも削除）:
+
+`sudo apt remove {{パッケージ}}`
+
+- インストールされている全てのパッケージを最新のバージョンにアップグレード:
+
+`sudo apt upgrade`
+
+- インストールできるすべてのパッケージを表示:
+
+`apt list`
+
+- インストールされた全てのパッケージを表示（依存関係も表示）:
+
+`apt list --installed`

tests/chmod.ru.expected

@@ -1,32 +0,0 @@
-
-  Изменить права доступа файлу или папке.
-  Больше информации: <https://www.gnu.org/software/coreutils/chmod>.
-
-  Дать [u]пользователю, который владеет файлом, права на его [x]исполнение:
-
-      chmod u+x файл
-
-  Дать права [u]пользователю права [r]чтения и [w]записи в файл/папку:
-
-      chmod u+rw файл_или_папка
-
-  Убрать права на [x]исполнение у [g]группы:
-
-      chmod g-x файл
-
-  Дать [a]всем пользователям права на [r]чтение и [x]исполенеие:
-
-      chmod a+rx файл
-
-  Дать [o]другим (не из группы владельцев файлом) такие же права как и у [g]группы:
-
-      chmod o=g файл
-
-  Убрать все права у [o]других:
-
-      chmod o= файл
-
-  Изменить права рекурсивно, дав [g]группе и [o]другим возможность [w]записи в папку:
-
-      chmod -R g+w,o+w папка
-

tests/chmod.ru.md

@@ -1,32 +0,0 @@
-# chmod
-
-> Изменить права доступа файлу или папке.
-> Больше информации: <https://www.gnu.org/software/coreutils/chmod>.
-
-- Дать [u]пользователю, который владеет файлом, права на его [x]исполнение:
-
-`chmod u+x {{файл}}`
-
-- Дать права [u]пользователю права [r]чтения и [w]записи в файл/папку:
-
-`chmod u+rw {{файл_или_папка}}`
-
-- Убрать права на [x]исполнение у [g]группы:
-
-`chmod g-x {{файл}}`
-
-- Дать [a]всем пользователям права на [r]чтение и [x]исполенеие:
-
-`chmod a+rx {{файл}}`
-
-- Дать [o]другим (не из группы владельцев файлом) такие же права как и у [g]группы:
-
-`chmod o=g {{файл}}`
-
-- Убрать все права у [o]других:
-
-`chmod o= {{файл}}`
-
-- Изменить права рекурсивно, дав [g]группе и [o]другим возможность [w]записи в папку:
-
-`chmod -R g+w,o+w {{папка}}`

tests/inkscape-default.expected

@@ -1,32 +0,0 @@
-
-  An SVG (Scalable Vector Graphics) editing program.
-  Use -z to not open the GUI and only process files in the console.
-
-  Open an SVG file in the Inkscape GUI:
-
-      inkscape filename.svg
-
-  Export an SVG file into a bitmap with the default format (PNG) and the default resolution (90 DPI):
-
-      inkscape filename.svg -e filename.png
-
-  Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur):
-
-      inkscape filename.svg -e filename.png -w 600 -h 400
-
-  Export a single object, given its ID, into a bitmap:
-
-      inkscape filename.svg -i id -e object.png
-
-  Export an SVG document to PDF, converting all texts to paths:
-
-      inkscape filename.svg | inkscape | inkscape --export-pdf=inkscape.pdf | inkscape | inkscape --export-text-to-path
-
-  Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape:
-
-      inkscape filename.svg --select=path123 --verb=EditDuplicate --verb=ObjectRotate90 --verb=FileSave --verb=FileQuit
-
-  Some invalid command just to test the correct highlighting of the command name:
-
-      inkscape --use-inkscape=v3.0 file
-

tests/rendered/apt.ja.expected

@@ -0,0 +1,37 @@
+
+  Debian系ディストリビューションで使われるパッケージ管理システムです。
+  Ubuntuのバージョンが16.04か、それ以降で対話モードを使う場合`apt-get`の代わりとして使用します。
+  詳しくはこちら: <https://manned.org/apt.8>
+
+  利用可能なパーケージとバージョンのリストの更新（他の`apt`コマンドの前での実行を推奨）:
+
+      sudo apt update
+
+  指定されたパッケージの検索:
+
+      apt search パッケージ
+
+  パッケージの情報を出力:
+
+      apt show パッケージ
+
+  パッケージのインストール、または利用可能な最新バージョンに更新:
+
+      sudo apt install パッケージ
+
+  パッケージの削除（`sudo apt remove --purge`の場合設定ファイルも削除）:
+
+      sudo apt remove パッケージ
+
+  インストールされている全てのパッケージを最新のバージョンにアップグレード:
+
+      sudo apt upgrade
+
+  インストールできるすべてのパッケージを表示:
+
+      apt list
+
+  インストールされた全てのパッケージを表示（依存関係も表示）:
+
+      apt list --installed
+

tests/rendered/inkscape-compact-no-color.expected

@@ -0,0 +1,32 @@
+
+   An SVG (Scalable Vector Graphics) editing program.
+   Use -z to not open the GUI and only process files in the console.
+
+   Open an SVG file in the Inkscape GUI:
+
+ inkscape filename.svg
+
+   Export an SVG file into a bitmap with the default format (PNG) and the default resolution (90 DPI):
+
+ inkscape filename.svg -e filename.png
+
+   Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur):
+
+ inkscape filename.svg -e filename.png -w 600 -h 400
+
+   Export a single object, given its ID, into a bitmap:
+
+ inkscape filename.svg -i id -e object.png
+
+   Export an SVG document to PDF, converting all texts to paths:
+
+ inkscape filename.svg | inkscape | inkscape --export-pdf=inkscape.pdf | inkscape | inkscape --export-text-to-path
+
+   Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape:
+
+ inkscape filename.svg --select=path123 --verb=EditDuplicate --verb=ObjectRotate90 --verb=FileSave --verb=FileQuit
+
+   Some invalid command just to test the correct highlighting of the command name:
+
+ inkscape --use-inkscape=v3.0 file
+

tests/rendered/inkscape-default.expected

@@ -0,0 +1,32 @@
+
+  An SVG (Scalable Vector Graphics) editing program.
+  Use -z to not open the GUI and only process files in the console.
+
+  Open an SVG file in the Inkscape GUI:
+
+      inkscape filename.svg
+
+  Export an SVG file into a bitmap with the default format (PNG) and the default resolution (90 DPI):
+
+      inkscape filename.svg -e filename.png
+
+  Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur):
+
+      inkscape filename.svg -e filename.png -w 600 -h 400
+
+  Export a single object, given its ID, into a bitmap:
+
+      inkscape filename.svg -i id -e object.png
+
+  Export an SVG document to PDF, converting all texts to paths:
+
+      inkscape filename.svg | inkscape | inkscape --export-pdf=inkscape.pdf | inkscape | inkscape --export-text-to-path
+
+  Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape:
+
+      inkscape filename.svg --select=path123 --verb=EditDuplicate --verb=ObjectRotate90 --verb=FileSave --verb=FileQuit
+
+  Some invalid command just to test the correct highlighting of the command name:
+
+      inkscape --use-inkscape=v3.0 file
+

tests/rendered/inkscape-with-title-no-color.expected

@@ -0,0 +1,34 @@
+
+  inkscape
+
+  An SVG (Scalable Vector Graphics) editing program.
+  Use -z to not open the GUI and only process files in the console.
+
+  Open an SVG file in the Inkscape GUI:
+
+      inkscape filename.svg
+
+  Export an SVG file into a bitmap with the default format (PNG) and the default resolution (90 DPI):
+
+      inkscape filename.svg -e filename.png
+
+  Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur):
+
+      inkscape filename.svg -e filename.png -w 600 -h 400
+
+  Export a single object, given its ID, into a bitmap:
+
+      inkscape filename.svg -i id -e object.png
+
+  Export an SVG document to PDF, converting all texts to paths:
+
+      inkscape filename.svg | inkscape | inkscape --export-pdf=inkscape.pdf | inkscape | inkscape --export-text-to-path
+
+  Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape:
+
+      inkscape filename.svg --select=path123 --verb=EditDuplicate --verb=ObjectRotate90 --verb=FileSave --verb=FileQuit
+
+  Some invalid command just to test the correct highlighting of the command name:
+
+      inkscape --use-inkscape=v3.0 file
+

tests/rendered/inkscape-with-title.expected

@@ -0,0 +1,34 @@
+
+  inkscape
+
+  An SVG (Scalable Vector Graphics) editing program.
+  Use -z to not open the GUI and only process files in the console.
+
+  Open an SVG file in the Inkscape GUI:
+
+      inkscape filename.svg
+
+  Export an SVG file into a bitmap with the default format (PNG) and the default resolution (90 DPI):
+
+      inkscape filename.svg -e filename.png
+
+  Export an SVG file into a bitmap of 600x400 pixels (aspect ratio distortion may occur):
+
+      inkscape filename.svg -e filename.png -w 600 -h 400
+
+  Export a single object, given its ID, into a bitmap:
+
+      inkscape filename.svg -i id -e object.png
+
+  Export an SVG document to PDF, converting all texts to paths:
+
+      inkscape filename.svg | inkscape | inkscape --export-pdf=inkscape.pdf | inkscape | inkscape --export-text-to-path
+
+  Duplicate the object with id="path123", rotate the duplicate 90 degrees, save the file, and quit Inkscape:
+
+      inkscape filename.svg --select=path123 --verb=EditDuplicate --verb=ObjectRotate90 --verb=FileSave --verb=FileQuit
+
+  Some invalid command just to test the correct highlighting of the command name:
+
+      inkscape --use-inkscape=v3.0 file
+

tests/rendered/playerctl-both.expected

@@ -0,0 +1,32 @@
+
+  Control media players via MPRIS.
+  More information: <https://github.com/altdesktop/playerctl#using-the-cli>.
+
+  Toggle play:
+
+      playerctl play-pause
+
+  Skip to the next track:
+
+      playerctl next
+
+  Go back to the previous track:
+
+      playerctl previous
+
+  List all players:
+
+      playerctl [-l|--list-all]
+
+  Send a command to a specific player:
+
+      playerctl [-p|--player] player_name play-pause|next|previous|...
+
+  Send a command to all players:
+
+      playerctl [-a|--all-players] play-pause|next|previous|...
+
+  Display metadata about the current track:
+
+      playerctl metadata [-f|--format] "Now playing: {{artist}} - {{album}} - {{title}}"
+

tests/rendered/playerctl-long.expected

@@ -0,0 +1,32 @@
+
+  Control media players via MPRIS.
+  More information: <https://github.com/altdesktop/playerctl#using-the-cli>.
+
+  Toggle play:
+
+      playerctl play-pause
+
+  Skip to the next track:
+
+      playerctl next
+
+  Go back to the previous track:
+
+      playerctl previous
+
+  List all players:
+
+      playerctl --list-all
+
+  Send a command to a specific player:
+
+      playerctl --player player_name play-pause|next|previous|...
+
+  Send a command to all players:
+
+      playerctl --all-players play-pause|next|previous|...
+
+  Display metadata about the current track:
+
+      playerctl metadata --format "Now playing: {{artist}} - {{album}} - {{title}}"
+

tests/rendered/playerctl-short.expected

@@ -0,0 +1,32 @@
+
+  Control media players via MPRIS.
+  More information: <https://github.com/altdesktop/playerctl#using-the-cli>.
+
+  Toggle play:
+
+      playerctl play-pause
+
+  Skip to the next track:
+
+      playerctl next
+
+  Go back to the previous track:
+
+      playerctl previous
+
+  List all players:
+
+      playerctl -l
+
+  Send a command to a specific player:
+
+      playerctl -p player_name play-pause|next|previous|...
+
+  Send a command to all players:
+
+      playerctl -a play-pause|next|previous|...
+
+  Display metadata about the current track:
+
+      playerctl metadata -f "Now playing: {{artist}} - {{album}} - {{title}}"
+

tests/style-config.toml

@@ -19,11 +19,3 @@ underline = false
 underline = true
 bold = false
 italic = true
-
-[display]
-use_pager = false
-compact = false
-
-[updates]
-auto_update = false
-auto_update_interval_hours = 720