fparkan/vendor/supports-hyperlinks/README.md
Valentin Popov 1b6a04ca55
Initial vendor packages
Signed-off-by: Valentin Popov <valentin@popov.link>
2024-01-08 01:21:28 +04:00

29 lines
821 B
Markdown

Detects whether the current terminal supports [hyperlinks in terminal
emulators](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda).
It tries to detect and support all known terminals and terminal families that
support this. If a declaration is wrong, missing, or could be improved, please
send a PR!
## Example
The API is super simple!
```rust
use supports_hyperlinks::Stream;
if supports_hyperlinks::on(Stream::Stdout) {
println!("This terminal supports hyperlinks on stdout");
} else {
println!("No hyperlinks, please");
}
```
And that's it!
## Forcing hyperlinks in tools that use `supports-hyperlinks`
You may set the `FORCE_HYPERLINK` environment variable to force
`supports-hyperlinks` to return true for its checks. If the value is `0`, this
will force it to be _false_, instead.