Skip to content

Commit

Permalink
docs: update man accordingly
Browse files Browse the repository at this point in the history
  • Loading branch information
mrnossiom committed Dec 27, 2023
1 parent 0650fba commit 9b6fe20
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ eza’s options are almost, but not quite, entirely unlike `ls`’s.
- **--colo[u]r-scale=(field)**: highlight levels of `field` distinctly(all, age, size)
- **--color-scale-mode=(mode)**: use gradient or fixed colors in --color-scale. valid options are `fixed` or `gradient`
- **--icons=(when)**: when to display icons (always, auto, never)
- **--hyperlink**: display entries as hyperlinks
- **--hyperlink=(when)**: display entries as hyperlinks
- **-w**, **--width=(columns)**: set screen width in columns

### Filtering options
Expand Down
7 changes: 6 additions & 1 deletion man/eza.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,14 @@ The default value is ‘`automatic`’.
`--no-quotes`
: Don't quote file names with spaces.

`--hyperlink`
`--hyperlink=WHEN`
: Display entries as hyperlinks

Valid settings are ‘`always`’, ‘`automatic`’ (or ‘`auto`’ for short), and ‘`never`’.
The default value is ‘`automatic`’.

The default behavior (‘`automatic`’ or ‘`auto`’) is to add hyperlink control chars to the output only when the standard output is connected to a real terminal. If the output of `eza` is redirected to a file or piped into another program, hyperlink will not be used. Setting this option to ‘`always`’ causes `eza` to always output hyperlinks, while ‘`never`’ disables the use of hyperlinks.

`-w`, `--width=COLS`
: Set screen width in columns.

Expand Down
2 changes: 1 addition & 1 deletion src/options/file_name.rs
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ impl QuoteStyle {
impl EmbedHyperlinks {
pub fn deduce(matches: &MatchedFlags<'_>) -> Result<Self, OptionsError> {
let Some(word) = matches.get(&flags::HYPERLINK)? else {
return Ok(Self::Automatic)
return Ok(Self::Automatic);
};

if word == "always" {
Expand Down

0 comments on commit 9b6fe20

Please sign in to comment.