mirror of https://github.com/lsd-rs/lsd
📝 overhaul documentation and add sample config files (#1175)
This commit is contained in:
Bonno van der Basch
GitHub
parent
72c5d515dd
commit
3f94436392
|
|
@ -6,5 +6,8 @@
|
|||
|
||||
- [ ] Use `cargo fmt`
|
||||
- [ ] Add necessary tests
|
||||
- [ ] Update default config/theme in README (if applicable)
|
||||
- [ ] Update README (if applicable)
|
||||
- [ ] Update config sample file in `doc/samples` (if applicable)
|
||||
- [ ] Update icon sample file in `doc/samples` (if applicable)
|
||||
- [ ] Update color sample file in `doc/samples` (if applicable)
|
||||
- [ ] Update man page at lsd/doc/lsd.md (if applicable)
|
||||
|
|
|
|||
506
README.md
506
README.md
|
|
@ -23,29 +23,35 @@
|
|||
|
||||
</div>
|
||||
|
||||
**IMPORTANT**: This is the development documents,
|
||||
please check the docs in [Tags](https://github.com/lsd-rs/lsd/tags) if you installed from the released ones.
|
||||
|
||||
The current newest release is: [v1.2.0](https://github.com/lsd-rs/lsd/tree/v1.2.0)
|
||||
|
||||
---
|
||||
|
||||
# LSD (LSDeluxe)
|
||||
> [!IMPORTANT]
|
||||
> This is the documentation for the development version of lsd.
|
||||
> Please consult the documentation on [the Tags page](https://github.com/lsd-rs/lsd/tags) if you are looking for the documentation of individual releases.
|
||||
>
|
||||
> The current newest release is: [v1.2.0](https://github.com/lsd-rs/lsd/tree/v1.2.0)
|
||||
|
||||
# LSD (LSDeluxe)
|
||||
[](https://raw.githubusercontent.com/lsd-rs/lsd/master/LICENSE)
|
||||
[](https://crates.io/crates/lsd)
|
||||
[](https://github.com/lsd-rs/lsd/actions)
|
||||
[](https://codecov.io/gh/lsd-rs/lsd)
|
||||
[](https://repology.org/project/lsd/versions)
|
||||
|
||||
|
||||
|
||||
|
||||
This project is a rewrite of GNU `ls` with lots of added features like colors, icons, tree-view, more formatting options etc.
|
||||
The project is heavily inspired by the super [colorls](https://github.com/athityakumar/colorls) project.
|
||||
|
||||
|
||||
## Installation
|
||||
### Prerequisites
|
||||
>[!TIP]
|
||||
> Have a look at the [Nerd Font README](https://github.com/ryanoasis/nerd-fonts/blob/master/readme.md) for help with installing Nerd Fonts
|
||||
|
||||
1. In order for icons to work you need to have a patched font like [nerd-font](https://www.nerdfonts.com) or [font-awesome](https://fontawesome.com) installed on your machine and your terminal needs to be configured to use the patched font of your choosing.
|
||||
2. If you intend to install `lsd` from source you need to have a working Rust toolchain (obviously) on your machine.
|
||||
|
||||
### Installing with a package manager
|
||||
<details>
|
||||
<summary>Packaging status</summary>
|
||||
<a href="https://repology.org/project/lsd/versions">
|
||||
|
|
@ -53,334 +59,105 @@ The project is heavily inspired by the super [colorls](https://github.com/athity
|
|||
</a>
|
||||
</details>
|
||||
|
||||
### Prerequisites
|
||||
Please consult the table below for the installation command associated with your package manager.
|
||||
|
||||
Install the patched fonts of powerline nerd-font and/or font-awesome. Have a look at the [Nerd Font README](https://github.com/ryanoasis/nerd-fonts/blob/master/readme.md) for more installation instructions. Don't forget to setup your terminal in order to use the correct font.
|
||||
|
||||
| OS/Distro | Command |
|
||||
| ------------------------------- | -------------------------------------------------------------------------------|
|
||||
| Archlinux | `pacman -S lsd` |
|
||||
| Fedora | `dnf install lsd` |
|
||||
| Gentoo | `sudo emerge sys-apps/lsd` |
|
||||
| macOS | `brew install lsd` or `sudo port install lsd` |
|
||||
| NixOS | `nix-env -iA nixos.lsd` |
|
||||
| FreeBSD | `pkg install lsd` |
|
||||
| NetBSD or any `pkgsrc` platform | `pkgin install lsd` or `cd /usr/pkgsrc/sysutils/lsd && make install` |
|
||||
| OpenBSD | `pkg_add lsd` |
|
||||
| Windows | `scoop install lsd` or `winget install --id lsd-rs.lsd` or `choco install lsd` |
|
||||
| Android (via Termux) | `pkg install lsd` |
|
||||
| Debian sid and bookworm | `apt install lsd` |
|
||||
| Ubuntu 23.04 (Lunar Lobster) | `apt install lsd` |
|
||||
| Earlier Ubuntu/Debian versions | **snap discontinued**, use [From Binaries](#from-binaries) |
|
||||
| Solus | `eopkg it lsd` |
|
||||
| Void Linux | `sudo xbps-install lsd` |
|
||||
| openSUSE | `sudo zypper install lsd` |
|
||||
|
||||
### From source
|
||||
|
||||
With Rust's package manager cargo, you can install lsd via:
|
||||
| OS/Distro | Command |
|
||||
| ------------------------------- | ----------------------------------------------------------------------------------------------|
|
||||
| Archlinux | `pacman -S lsd` |
|
||||
| Fedora | `dnf install lsd` |
|
||||
| Gentoo | `sudo emerge sys-apps/lsd` |
|
||||
| macOS | `brew install lsd` or `sudo port install lsd` |
|
||||
| NixOS | `nix-env -iA nixos.lsd` |
|
||||
| FreeBSD | `pkg install lsd` |
|
||||
| NetBSD or any `pkgsrc` platform | `pkgin install lsd` or `cd /usr/pkgsrc/sysutils/lsd && make install` |
|
||||
| OpenBSD | `pkg_add lsd` |
|
||||
| Windows | `scoop install lsd` or `winget install --id lsd-rs.lsd` or `choco install lsd` |
|
||||
| Android (via Termux) | `pkg install lsd` |
|
||||
| Debian sid and bookworm | `apt install lsd` |
|
||||
| Ubuntu 23.04 (Lunar Lobster) | `apt install lsd` |
|
||||
| Earlier Ubuntu/Debian versions | **snap discontinued**, use the method described [here](#installing-binaries-directly) instead |
|
||||
| Solus | `eopkg it lsd` |
|
||||
| Void Linux | `sudo xbps-install lsd` |
|
||||
| openSUSE | `sudo zypper install lsd` |
|
||||
|
||||
### Installing from source
|
||||
With [Rust's package manager cargo](https://doc.rust-lang.org/stable/cargo/), you can install lsd via:
|
||||
```sh
|
||||
cargo install lsd
|
||||
```
|
||||
|
||||
If you want to install the latest master branch commit:
|
||||
|
||||
And if you want to install the latest `main` branch commit you can do so via:
|
||||
```sh
|
||||
cargo install --git https://github.com/lsd-rs/lsd.git --branch main
|
||||
```
|
||||
|
||||
### From Binaries
|
||||
### Installing binaries directly
|
||||
The [release page](https://github.com/lsd-rs/lsd/releases) includes precompiled binaries for Linux, macOS, and Windows for every release. You can also get the latest binary of the `main` branch from the [GitHub action build artifacts](https://github.com/lsd-rs/lsd/actions?query=branch%3Amain+is%3Asuccess+event%3Apush) (choose the top action and then scroll down to the artifacts section).
|
||||
|
||||
The [release page](https://github.com/lsd-rs/lsd/releases) includes precompiled binaries for Linux, macOS and Windows for every release. You can also get the latest binary of `master` branch from the [GitHub action build artifacts](https://github.com/lsd-rs/lsd/actions?query=branch%3Amaster+is%3Asuccess+event%3Apush) (choose the top action and scroll down to the artifacts section).
|
||||
#### Configuring your shell to use lsd instead of ls (optional)
|
||||
In order to use lsd instead of entering the `ls` command, you need to create an alias for ls in to your shell configuration file (`~/.bashrc`, `~/.zshrc`, etc...). The simplest variant of such an alias is:
|
||||
```sh
|
||||
alias ls='lsd'
|
||||
```
|
||||
The alias above will replace a stock ls command with an lsd command without additional parameters.
|
||||
|
||||
## Configuration
|
||||
Some examples of other useful aliases are:
|
||||
```sh
|
||||
alias l='lsd -l'
|
||||
alias la='lsd -a'
|
||||
alias lla='lsd -la'
|
||||
alias lt='lsd --tree'
|
||||
```
|
||||
|
||||
`lsd` can be configured with a configuration file to set the default options.
|
||||
Check [Config file content](#config-file-content) for details.
|
||||
## Customizing lsd (configuration and theming)
|
||||
> [!TIP]
|
||||
> In order to make the customization process easier for you we’ve supplied sample files. These files contain the entries for all the defaults that `lsd` comes with after installation. You can find the sample files in the [documentation folder](./doc)`.
|
||||
>
|
||||
> We've also supplied a [color reference](./doc/colors.md) where we’ve documented the default colors `lsd` uses in its output. You can also preview there.
|
||||
|
||||
### Config file location
|
||||
In order to tailor `lsd` to your specific needs you can create any of the following three files and make adjustments as you see fit.
|
||||
|
||||
### Non-Windows
|
||||
1. `config.yaml` → [config sample file here](./doc/samples/config-sample.yaml)
|
||||
2. `colors.yaml` → [colors sample file here](./doc/samples/colors-sample.yaml)
|
||||
3. `icons.yaml` → [icons sample file here](./doc/samples/icons-sample.yaml)
|
||||
|
||||
On non-Windows systems `lsd` follows the
|
||||
[XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)
|
||||
convention for the location of the configuration file. A `config.yaml` or `config.yml` file will be searched for in these locations, in order:
|
||||
Note that it is _not_ required to have all three of the files present in order for your configuration to be applied. For example, if you [only want to customize the icons](#customization-example) then only [`icons.yaml`](./doc/icons-sample.yaml) needs to be present in the [configuration directory](#config-file-locations); [`config.yaml`](./doc/config-sample.yaml), and [`colors.yaml`](./doc/colors-sample.yaml) do not have to be present in order for your icon modifications to be applied.
|
||||
|
||||
### Config file locations
|
||||
> [!TIP]
|
||||
> You can also instruct `lsd` to look for configuration files in a custom location of your choosing by using the following command: `lsd --config-file [YOUR_CUSTOM_PATH]`. This is particularly useful when testing a configuration changes before commiting to them.
|
||||
|
||||
#### Unix (Linux, Mac, etc...)
|
||||
On non-Windows systems `lsd` follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html), thus `lsd` will look for configuration files any of the following locations:
|
||||
|
||||
- `$HOME/.config/lsd`
|
||||
- `$XDG_CONFIG_HOME/lsd`
|
||||
|
||||
On most systems these are mapped to the same location, which is `~/.config/lsd/config.yaml`.
|
||||
On most systems these variables are mapped to the same location, which is usually `~/.config/lsd/`. If `lsd` does not detect the location, or if the location exists but does not contain any of the three configuration files, the default configuration will be used instead.
|
||||
|
||||
### Windows
|
||||
#### Windows
|
||||
On Windows systems `lsd` will look for configuration files in the following locations, **in order**:
|
||||
|
||||
On Windows systems `lsd` searches for `config.yaml` or `config.yml` in the following locations, in order:
|
||||
1. `%USERPROFILE%\.config\lsd`
|
||||
2. `%APPDATA%\lsd`
|
||||
|
||||
- `%USERPROFILE%\.config\lsd`
|
||||
- `%APPDATA%\lsd`
|
||||
These locations are usually something like `C:\Users\username\AppData\Roaming\lsd\`, and `C:\Users\username\.config\lsd\` respectively.
|
||||
|
||||
These are usually something like `C:\Users\username\AppData\Roaming\lsd\config.yaml` and `C:\Users\username\.config\lsd\config.yaml` respectively.
|
||||
### Quick customization example
|
||||
For this example let's assume you're already content `lsd`, but there are a few of the default icons that really bug you and you want to change them to something that suits your needs better. All you have to do is create an `icons.yaml` file in the [configuration directory](#config-file-locations) and configure your custom icon there. Here’s how.
|
||||
|
||||
### Custom
|
||||
There are 3 kinds of icon overrides available in `lsd`:
|
||||
|
||||
You can also provide a configuration file from a non-standard location:
|
||||
`lsd --config-file [PATH]`
|
||||
- `name`
|
||||
- `filetype`
|
||||
- `extension`
|
||||
|
||||
### Config file content
|
||||
Both nerd font glyphs and Unicode emojis can be used for icons. The final set of icons that `lsd` will use is a combination of the [default icons](./src/theme/icon.rs) with the custom icons you’ve set in the `icons.yaml` file.
|
||||
|
||||
<details open>
|
||||
<summary>This is an example config file with the default values and some additional remarks.</summary>
|
||||
> [!NOTE]
|
||||
> Aside from the [icon sample file](./doc/icons-sample.yaml), you can also find the default icon set in the source code [here](src/theme/icon.rs).
|
||||
|
||||
```yaml
|
||||
# == Classic ==
|
||||
# This is a shorthand to override some of the options to be backwards compatible
|
||||
# with `ls`. It affects the "color"->"when", "sorting"->"dir-grouping", "date"
|
||||
# and "icons"->"when" options.
|
||||
# Possible values: false, true
|
||||
classic: false
|
||||
|
||||
# == Blocks ==
|
||||
# This specifies the columns and their order when using the long and the tree
|
||||
# layout.
|
||||
# Possible values: permission, user, group, context, size, date, name, inode, links, git
|
||||
blocks:
|
||||
- permission
|
||||
- user
|
||||
- group
|
||||
- size
|
||||
- date
|
||||
- name
|
||||
|
||||
# == Color ==
|
||||
# This has various color options. (Will be expanded in the future.)
|
||||
color:
|
||||
# When to colorize the output.
|
||||
# When "classic" is set, this is set to "never".
|
||||
# Possible values: never, auto, always
|
||||
when: auto
|
||||
# How to colorize the output.
|
||||
# When "classic" is set, this is set to "no-color".
|
||||
# Possible values: default, custom
|
||||
# When "custom" is set, lsd will look in the config directory for `colors.yaml`.
|
||||
theme: default
|
||||
|
||||
# == Date ==
|
||||
# This specifies the date format for the date column. The freeform format
|
||||
# accepts a strftime like string.
|
||||
# When "classic" is set, this is set to "date".
|
||||
# Possible values: date, locale, relative, '+<date_format>'
|
||||
# `date_format` will be a `strftime` formatted value. e.g. `date: '+%d %b %y %X'` will give you a date like this: 17 Jun 21 20:14:55
|
||||
date: date
|
||||
|
||||
# == Dereference ==
|
||||
# Whether to dereference symbolic links.
|
||||
# Possible values: false, true
|
||||
dereference: false
|
||||
|
||||
# == Display ==
|
||||
# What items to display. Do not specify this for the default behavior.
|
||||
# Possible values: all, almost-all, directory-only
|
||||
# display: all
|
||||
|
||||
# == Icons ==
|
||||
icons:
|
||||
# When to use icons.
|
||||
# When "classic" is set, this is set to "never".
|
||||
# Possible values: always, auto, never
|
||||
when: auto
|
||||
# Which icon theme to use.
|
||||
# Possible values: fancy, unicode
|
||||
theme: fancy
|
||||
# Separator between icon and the name
|
||||
# Default to 1 space
|
||||
separator: " "
|
||||
|
||||
# == Ignore Globs ==
|
||||
# A list of globs to ignore when listing.
|
||||
# ignore-globs:
|
||||
# - .git
|
||||
|
||||
# == Indicators ==
|
||||
# Whether to add indicator characters to certain listed files.
|
||||
# Possible values: false, true
|
||||
indicators: false
|
||||
|
||||
# == Layout ==
|
||||
# Which layout to use. "oneline" might be a bit confusing here and should be
|
||||
# called "one-per-line". It might be changed in the future.
|
||||
# Possible values: grid, tree, oneline
|
||||
layout: grid
|
||||
|
||||
# == Recursion ==
|
||||
recursion:
|
||||
# Whether to enable recursion.
|
||||
# Possible values: false, true
|
||||
enabled: false
|
||||
# How deep the recursion should go. This has to be a positive integer. Leave
|
||||
# it unspecified for (virtually) infinite.
|
||||
# depth: 3
|
||||
|
||||
# == Size ==
|
||||
# Specifies the format of the size column.
|
||||
# Possible values: default, short, bytes
|
||||
size: default
|
||||
|
||||
# == Permission ==
|
||||
# Specify the format of the permission column
|
||||
# Possible value: rwx, octal, attributes (windows only), disable
|
||||
# permission: rwx
|
||||
|
||||
# == Sorting ==
|
||||
sorting:
|
||||
# Specify what to sort by.
|
||||
# Possible values: extension, name, time, size, version
|
||||
column: name
|
||||
# Whether to reverse the sorting.
|
||||
# Possible values: false, true
|
||||
reverse: false
|
||||
# Whether to group directories together and where.
|
||||
# When "classic" is set, this is set to "none".
|
||||
# Possible values: first, last, none
|
||||
dir-grouping: none
|
||||
|
||||
# == No Symlink ==
|
||||
# Whether to omit showing symlink targets
|
||||
# Possible values: false, true
|
||||
no-symlink: false
|
||||
|
||||
# == Total size ==
|
||||
# Whether to display the total size of directories.
|
||||
# Possible values: false, true
|
||||
total-size: false
|
||||
|
||||
# == Hyperlink ==
|
||||
# Attach hyperlink to filenames
|
||||
# Possible values: always, auto, never
|
||||
hyperlink: never
|
||||
|
||||
# == Symlink arrow ==
|
||||
# Specifies how the symlink arrow display, chars in both ascii and utf8
|
||||
symlink-arrow: ⇒
|
||||
|
||||
# == Header ==
|
||||
# Whether to display block headers.
|
||||
# Possible values: false, true
|
||||
header: false
|
||||
|
||||
# == Literal ==
|
||||
# Whether to show quotes on filenames.
|
||||
# Possible values: false, true
|
||||
literal: false
|
||||
|
||||
# == Truncate owner ==
|
||||
# How to truncate the username and group names for a file if they exceed a certain
|
||||
# number of characters.
|
||||
truncate-owner:
|
||||
# Number of characters to keep. By default, no truncation is done (empty value).
|
||||
after:
|
||||
# String to be appended to a name if truncated.
|
||||
marker: ""
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## Theme
|
||||
|
||||
`lsd` can be configured with theme files to set the colors or icons.
|
||||
|
||||
### Color Theme
|
||||
|
||||
Color theme can be configured in the [configuration file](#configuration)(color.theme).
|
||||
The valid theme configurations are:
|
||||
|
||||
- `default`: the default color scheme shipped in `lsd`
|
||||
- `custom`: use a custom color scheme defined in `colors.yaml`
|
||||
- *(deprecated) theme_file_name(yaml): use the theme file to specify colors (without the `yaml` extension)*
|
||||
|
||||
When set to `custom`, `lsd` will look for `colors.yaml` in the
|
||||
XDG Base Directory, e.g. ~/.config/lsd/colors.yaml
|
||||
|
||||
When configured with the `theme-file-name` which is a `yaml` file,
|
||||
`lsd` will look up the theme file in the following way:
|
||||
|
||||
- relative name: check the XDG Base Directory, e.g. ~/.config/lsd/themes/<theme-file-name>.yaml
|
||||
- absolute name: use the file path and name to find theme file
|
||||
|
||||
Check [Color Theme file content](#color-theme-file-content) for details.
|
||||
|
||||
#### Color Theme file content
|
||||
|
||||
Theme file use the [crossterm](https://crates.io/crates/crossterm)
|
||||
to configure the colors, check [crossterm](https://docs.rs/crossterm/0.20.0/crossterm/style/enum.Color.html)
|
||||
for supported colors.
|
||||
|
||||
Color table: https://upload.wikimedia.org/wikipedia/commons/1/15/Xterm_256color_chart.svg
|
||||
|
||||
Please notice that color values would ignore the case, both lowercase and UPPERCASE is supported.
|
||||
|
||||
This is the default theme scheme shipped with `lsd`.
|
||||
|
||||
```yaml
|
||||
user: 230
|
||||
group: 187
|
||||
permission:
|
||||
read: dark_green
|
||||
write: dark_yellow
|
||||
exec: dark_red
|
||||
exec-sticky: 5
|
||||
no-access: 245
|
||||
octal: 6
|
||||
acl: dark_cyan
|
||||
context: cyan
|
||||
date:
|
||||
hour-old: 40
|
||||
day-old: 42
|
||||
older: 36
|
||||
size:
|
||||
none: 245
|
||||
small: 229
|
||||
medium: 216
|
||||
large: 172
|
||||
inode:
|
||||
valid: 13
|
||||
invalid: 245
|
||||
links:
|
||||
valid: 13
|
||||
invalid: 245
|
||||
tree-edge: 245
|
||||
git-status:
|
||||
default: 245
|
||||
unmodified: 245
|
||||
ignored: 245
|
||||
new-in-index: dark_green
|
||||
new-in-workdir: dark_green
|
||||
typechange: dark_yellow
|
||||
deleted: dark_red
|
||||
renamed: dark_green
|
||||
modified: dark_yellow
|
||||
conflicted: dark_red
|
||||
```
|
||||
|
||||
When creating a theme for `lsd`, you can specify any part of the default theme,
|
||||
and then change its colors, the items missed would fall back to use the default colors.
|
||||
|
||||
### Icon Theme
|
||||
|
||||
Icon theme can be configured in a fixed location, `$XDG_CONFIG_DIR/lsd/icons.yaml`,
|
||||
for example, `~/.config/lsd/icons.yaml` on macOS,
|
||||
please check [Config file location](#config-file-location) to make sure where is `$XDG_CONFIG_DIR`.
|
||||
|
||||
As the file name indicated, the icon theme file is a `yaml` file.
|
||||
|
||||
Check [Icon Theme file content](#icon-theme-file-content) for details.
|
||||
|
||||
#### Icon Theme file content
|
||||
|
||||
`lsd` support 3 kinds of icon overrides, by `name`, by `filetype` and by `extension`.
|
||||
The final set of icons used will be a combination of what is shipped with in `lsd` with overrides from config applied on top of it.
|
||||
*You can find the default set of icons [here](src/theme/icon.rs).*
|
||||
|
||||
Both nerd font glyphs and Unicode emojis can be used for icons. You can find an example of icons customization below.
|
||||
A short example for each type of the icon overrides is shown below.
|
||||
|
||||
```yaml
|
||||
name:
|
||||
|
|
@ -405,114 +182,69 @@ filetype:
|
|||
special:
|
||||
```
|
||||
|
||||
## External Configurations
|
||||
|
||||
### Required
|
||||
|
||||
Enable nerd fonts for your terminal, URxvt for example in `.Xresources`:
|
||||
## F.A.Q and troubleshooting
|
||||
### How can I enable nerd fonts using xresources?
|
||||
To enable nerd fonts for your terminal, URxvt for example, in `.Xresources` take a look at the example below:
|
||||
|
||||
```sh
|
||||
URxvt*font: xft:Hack Nerd Font:style=Regular:size=11
|
||||
```
|
||||
|
||||
### Optional
|
||||
### Why am I seeing `Uses unknown compression for member ‘control.tar.zst'` when using deb?
|
||||
Zst compression is only supported from `Debian 12`, `Ubuntu 21.10`, and upward. Starting from `lsd v1.1.0` please use the `_xz.deb` release instead. See [this issue](https://github.com/lsd-rs/lsd/issues/891) for additional details and manual fixes.
|
||||
|
||||
In order to use lsd when entering the `ls` command, you need to add this to your shell
|
||||
configuration file (~/.bashrc, ~/.zshrc, etc.):
|
||||
### How can I set custom color schemes for Windows?
|
||||
In order to display a custom color scheme `lsd` reads a system environment variable called `LS_COLORS`. If your custom color scheme is not working `LS_COLORS` is most likely missing. Please look at [the marked solution in this post](https://github.com/orgs/lsd-rs/discussions/958#discussioncomment-7659375), which contains instructions on how to set a custom color scheme on Windows for guidance.
|
||||
|
||||
```sh
|
||||
alias ls='lsd'
|
||||
```
|
||||
### Why are icons not showing up
|
||||
> [!IMPORTANT]
|
||||
> Always check if the font you are using is correctly set up! Run the following snippet in your terminal emulator and verify that the output [prints a folder icon](https://github.com/lsd-rs/lsd/issues/510#issuecomment-860000306). If it prints a box, or question mark, or something else, then you might have some issues in how you set up the font or how your terminal emulator renders the font.
|
||||
>
|
||||
> ```sh
|
||||
> echo $'\uf115'
|
||||
> ```
|
||||
|
||||
Some further examples of useful aliases:
|
||||
For `lsd` to be able to display icons the font has to include special font glyphs. If icons are not being displayed it could be the case that your current font does not include such glyphs. Thankfully, you can patch most fonts using [NerdFont](https://www.nerdfonts.com/) and add these icons to your current font.
|
||||
|
||||
```sh
|
||||
alias l='ls -l'
|
||||
alias la='ls -a'
|
||||
alias lla='ls -la'
|
||||
alias lt='ls --tree'
|
||||
```
|
||||
Alternatively, you can also download an already patched version of your favorite font from the [NerdFont font download page](https://www.nerdfonts.com/font-downloads).
|
||||
|
||||
## F.A.Q
|
||||
Here is a guide on how to set up fonts on [macOS](https://github.com/lsd-rs/lsd/issues/199#issuecomment-494218334), and on [Android](https://github.com/lsd-rs/lsd/issues/423).
|
||||
|
||||
### Uses unknown compression for member 'control.tar.zst' when using deb
|
||||
### Why are Icons missing or not rendering correctly using PuTTY/KiTTY on Windows?
|
||||
First of all, make sure a patched font is available on your local machine and that PuTTY/KiTTY is configured to use that font. If you are not certain what this entails please read the [Prerequisites](#prerequisites).
|
||||
|
||||
Zst compression is supported starting from `Debian 12` and `Ubuntu 21.10`,
|
||||
Please use the `_xz.deb` released starting from `lsd v1.1.0`.
|
||||
Please note that there are problems for PuTTY/KiTTY displaying 2 character wide icons which may be the case for the font you configured. To ensure only 1 character wide icons are used by your font, please select a font like [Hack Regular Nerd Font Complete Mono Windows Compatible](https://github.com/ryanoasis/nerd-fonts/blob/master/patched-fonts/Hack/Regular/complete/Hack%20Regular%20Nerd%20Font%20Complete%20Mono%20Windows%20Compatible.ttf) (see [this issue](https://github.com/lsd-rs/lsd/issues/331) for further details).
|
||||
|
||||
Please check https://github.com/lsd-rs/lsd/issues/891 for details or manual fixes.
|
||||
### Why is the first character of a folder/file getting trimmed?
|
||||
> [!NOTE]
|
||||
> **Workaround for [Konsole](https://apps.kde.org/konsole/):** edit the config file (or create it if it doesn't already exist) and paste the following configuration directive into it.
|
||||
>
|
||||
> ```yaml
|
||||
> # CAREFUL: use copy-paste because this block contains invisible Unicode characters!
|
||||
> icons:
|
||||
> separator: " ㅤ"
|
||||
> ```
|
||||
|
||||
### Custom Color Schemes for Windows
|
||||
For `lsd` currently, it reads a system environment variable called LS_COLORS. Please look at the marked solution in [this post](https://github.com/orgs/lsd-rs/discussions/958#discussioncomment-7659375), which contains a guide on how to set a color scheme.
|
||||
This is a known issue in a few terminal emulators. Try using a different terminal emulator like [Alacritty](https://github.com/alacritty/alacritty) or [Kitty](https://github.com/kovidgoyal/kitty) and see if these suit your needs.
|
||||
|
||||
### Icons not showing up
|
||||
|
||||
For `lsd` to be able to display icons, the font has to include special font glyphs. This might not be the case for most fonts that you download. Thankfully, you can patch most fonts using [NerdFont](https://www.nerdfonts.com/) and add these icons. Or you can just download an already patched version of your favorite font from [NerdFont font download page](https://www.nerdfonts.com/font-downloads).
|
||||
Here is a guide on how to set up fonts on [macOS](https://github.com/lsd-rs/lsd/issues/199#issuecomment-494218334) and [Android](https://github.com/lsd-rs/lsd/issues/423).
|
||||
|
||||
To check if the font you are using is set up correctly, try running the following snippet in a shell and see if that [prints a folder icon](https://github.com/lsd-rs/lsd/issues/510#issuecomment-860000306). If it prints a box, or question mark or something else, then you might have some issues in how you set up the font or how your terminal emulator renders the font.
|
||||
|
||||
```sh
|
||||
echo $'\uf115'
|
||||
```
|
||||
|
||||
### Icons missing or not rendering correctly using PuTTY/KiTTY on Windows
|
||||
|
||||
First of all, make sure a patched font is installed and PuTTY/KiTTY is configured to use it, please check [Prerequisites](#prerequisites).
|
||||
|
||||
There are problems for PuTTY/KiTTY to show 2 char wide icons, make sure using a 1 char wide font like [Hack Regular Nerd Font Complete Mono Windows Compatible](https://github.com/ryanoasis/nerd-fonts/blob/master/patched-fonts/Hack/Regular/complete/Hack%20Regular%20Nerd%20Font%20Complete%20Mono%20Windows%20Compatible.ttf), check [this issue](https://github.com/lsd-rs/lsd/issues/331) for detail.
|
||||
|
||||
### Colors
|
||||
|
||||
You can customize filetype colors using `LS_COLORS` and other colors using the theme.
|
||||
|
||||
The default colors are:
|
||||
|
||||
| User/Group | Permission | File Type (changes based on your terminal colorscheme) | Date | File Size |
|
||||
| :-------------------------------------------------------------------- | :------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------- | :-------------------------------------------------------------------------- |
|
||||
|  User |  Read |  Directory |  within the last hour |  Small File |
|
||||
|  Group |  Write |  Executable File |  within the last day |  Medium File |
|
||||
| |  Execute |  Non-Executable File |  older |  Large File |
|
||||
| |  Execute with Stickybit |  Broken Symlink | |  Non File |
|
||||
| |  No Access |  Pipe/Symlink/Blockdevice/Socket/Special | | |
|
||||
| | |  CharDevice | | |
|
||||
|
||||
_Checkout [trapd00r/LS_COLORS](https://github.com/trapd00r/LS_COLORS) and [sharkdp/vivid](https://github.com/sharkdp/vivid) for help in theming using `LS_COLORS`._
|
||||
|
||||
### First char of folder/file getting trimmed
|
||||
|
||||
Workaround for Konsole: ㅤEdit the config file (or [create it](#config-file-location) if it doesn't already exist) and paste the following into it (contains invisible Unicode characters):
|
||||
|
||||
```yml
|
||||
icons:
|
||||
separator: " ㅤ"
|
||||
```
|
||||
|
||||
This is a known issue in a few terminal emulators. Try using a different terminal emulator like. [Alacritty](https://github.com/alacritty/alacritty) and [Kitty](https://github.com/kovidgoyal/kitty) are really good alternatives. You might also want to check if your font is responsible for causing this.
|
||||
To verify this, try running lsd with icons disabled and if it still does not have the first character, then this is an lsd bug:
|
||||
You might also want to check if your font is responsible for causing this. To verify this, try running lsd with icons disabled and if the first character is still being trimmed, you’ve discovered a bug in `lsd`. Until the bug is fixed you can use the following command as workaround:
|
||||
|
||||
```sh
|
||||
lsd --icon never --ignore-config
|
||||
```
|
||||
|
||||
### UTF-8 Chars
|
||||
### Why are there weird (UTF-8) characters in the output?
|
||||
`lsd` will always attempt to display the UTF-8 characters in file name, but a `U+FFFD REPLACEMENT CHARACTER`(<28>) is used to represent the invalid UTF-8 characters. If you are seeing this in your `lsd` output your filename contains an invalid UTF-8 character.
|
||||
|
||||
`lsd` will try to display the UTF-8 chars in file name, A `U+FFFD REPLACEMENT CHARACTER`(<28>) is used to represent the invalid UTF-8 chars.
|
||||
|
||||
### Icons are showing up strangely
|
||||
|
||||
Nerd Fonts is moving the code points of the Material Design Icons in 3.0, so lsd has updated the icons in #830. If your icons look weird, use fonts that have been patched using Nerd Fonts v2.3.0 or later.
|
||||
|
||||
See also: <https://github.com/ryanoasis/nerd-fonts/releases/tag/v2.3.3>
|
||||
### Why are the icons are showing up strangely?
|
||||
Nerd Fonts is moving the code points of the Material Design Icons in version 3.0, so starting from #830 `lsd` is using an updated the icon set. If your icons look weird, use fonts that have been patched using [Nerd Fonts v2.3.0](https://github.com/ryanoasis/nerd-fonts/releases/tag/v2.3.3) or later.
|
||||
|
||||
## Contributors
|
||||
|
||||
Everyone can contribute to this project, improving the code or adding functions. If anyone wants something to be added we will try to do it.
|
||||
|
||||
As this is being updated regularly, don't forget to rebase your fork before creating a pull-request.
|
||||
|
||||
## Credits
|
||||
|
||||
Special thanks to:
|
||||
|
||||
- [meain](https://github.com/meain) for all his contributions and reviews
|
||||
|
|
|
|||
|
|
@ -0,0 +1,50 @@
|
|||
# Color reference
|
||||
> [!TIP]
|
||||
> Checkout [trapd00r/LS_COLORS](https://github.com/trapd00r/LS_COLORS) and [sharkdp/vivid](https://github.com/sharkdp/vivid) for help in theming using `LS_COLORS`.
|
||||
|
||||
You can customize filetype colors using `LS_COLORS` and other colors using the theme.
|
||||
|
||||
## Default colors
|
||||
### Users and groups
|
||||
| Color | Hex code | RGB array | Used for |
|
||||
| :------------------------------------------------------------------- | :-------- | :---------------- | :------- |
|
||||
| <img valign='middle' alt='very pale yellow' src='./img/ffffd7.svg'/> | `#ffffd7` | `[255, 255, 215]` | User |
|
||||
| <img valign='middle' alt='grayish yellow' src='./img/d7d7af.svg'/> | `#d7d7af` | `[215, 215, 175]` | Group |
|
||||
|
||||
### Permissions
|
||||
| Color | Hex code | RGB array | Used for |
|
||||
| :-------------------------------------------------------------------------------- | :-------- | :---------------- | :-------------------------------- |
|
||||
| <img valign='middle' alt='strong lime green' src='./img/00d700.svg'/> | `#00d700` | `[0, 215, 0]` | Read permission |
|
||||
| <img valign='middle' alt='very light green' src='./img/d7ff87.svg'/> | `#d7ff87` | `[215, 255, 135]` | Write permission |
|
||||
| <img valign='middle' alt='dark red' src='./img/af0000.svg'/> | `#af0000` | `[175, 0, 1]` | Execute permission |
|
||||
| <img valign='middle' alt='pure (or mostly pure) magenta' src='./img/ff00ff.svg'/> | `#ff00ff` | `[255, 0, 255]` | Execute permission with stickybit |
|
||||
| <img valign='middle' alt='moderate pink' src='./img/d75f87.svg'/> | `#d75f87` | `[215, 95, 135]` | No Access |
|
||||
|
||||
### File Types
|
||||
> [!Note]
|
||||
> These change based on your configured terminal color scheme
|
||||
|
||||
| Color | Hex code | RGB array | Used for |
|
||||
| :------------------------------------------------------------------------------ | :-------- | :---------------- | :-------------------------------------- |
|
||||
| <img valign='middle' alt='pure (or mostly pure) blue.' src='./img/0087ff.svg'/> | `#0087ff` | `[0, 135, 255]` | Directory |
|
||||
| <img valign='middle' alt='strong lime green' src='./img/00d700.svg'/> | `#00d700` | `[0, 215, 0]` | Executable file |
|
||||
| <img valign='middle' alt='white' src='./img/ffffff.svg'/> | `#ffffff` | `[255, 255, 255]` | Non-executable file |
|
||||
| <img valign='middle' alt='dark red' src='./img/af0000.svg'/> | `#af0000` | `[175, 0, 1]` | Broken symlink |
|
||||
| <img valign='middle' alt='strong cyan' src='./img/00d7d7.svg'/> | `#00d7d7` | `[0, 215, 215]` | Pipe/Symlink/Blockdevice/Socket/Special |
|
||||
| <img valign='middle' alt='strong orange' src='./img/d78700.svg'/> | `#d78700` | `[215, 135, 0]` | CharDevice |
|
||||
|
||||
|
||||
### Dates
|
||||
| Color | Hex code | RGB array | Used for |
|
||||
| :--------------------------------------------------------------------------- | :-------- | :-------------- | :------------------- |
|
||||
| <img valign='middle' alt='strong lime green' src='./img/00d700.svg'/> | `#00d700` | `[0, 215, 0]`. | Within the last hour |
|
||||
| <img valign='middle' alt='strong cyan - lime green' src='./img/00d787.svg'/> | `#00d787` | `[215, 135, 1]` | Within the last day |
|
||||
| <img valign='middle' alt='dark cyan' src='./img/00af87.svg'/> | `#00af87` | `[175, 135, 1]` | Older |
|
||||
|
||||
### File Sizes
|
||||
| Color | Hex code | RGB array | Used for |
|
||||
| :-------------------------------------------------------------------- | :-------- | :---------------- | :---------- |
|
||||
| <img valign='middle' alt='pale yellow' src='./img/ffffaf.svg'/> | `#ffffaf` | `[255, 255, 175]` | Small file |
|
||||
| <img valign='middle' alt='very light orange' src='./img/ffaf87.svg'/> | `#ffaf87` | `[215, 135, 1]` | Medium file |
|
||||
| <img valign='middle' alt='strong orange' src='./img/d78700.svg'/> | `#d78700` | `[215, 135, 0]` | Large file |
|
||||
| <img valign='middle' alt='white' src='./img/ffffff.svg'/> | `#ffffff` | `[255, 255, 255]` | Non file |
|
||||
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#0087ff' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#00af87' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#00d700' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#00d787' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#00d7d7' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#af0000' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#d75f87' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#d78700' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#d7d7af' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#d7ff87' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#ff00ff' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#ffaf87' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#ffffaf' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#ffffd7' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1 @@
|
|||
<svg xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' width='20' height='22' viewBox='0 0 20 22'><rect fill='#ffffff' x='0' y='0' width='20' height='20' rx='4'/></svg>
|
||||
|
After Width: | Height: | Size: 197 B |
|
|
@ -0,0 +1,39 @@
|
|||
---
|
||||
user: 230 # Default = 230
|
||||
group: 187 # Default = 187
|
||||
permission:
|
||||
read: dark_green # Default = dark_green
|
||||
write: dark_yellow # Default = dark_yellow
|
||||
exec: dark_red # Default = dark_red
|
||||
exec-sticky: 5 # Default = 5
|
||||
no-access: 245 # Default = 245
|
||||
octal: 6 # Default = 6
|
||||
acl: dark_cyan # Default = dark_cyan
|
||||
context: cyan # Default = cyan
|
||||
date:
|
||||
hour-old: 40 # Default = 40
|
||||
day-old: 42 # Default = 42
|
||||
older: 36 # Default = 36
|
||||
size:
|
||||
none: 245 # Default = 245
|
||||
small: 229 # Default = 229
|
||||
medium: 216 # Default = 216
|
||||
large: 172 # Default = 172
|
||||
inode:
|
||||
valid: 13 # Default = 13
|
||||
invalid: 245 # Default = 245
|
||||
links:
|
||||
valid: 13 # Default = 13
|
||||
invalid: 245 # Default = 245
|
||||
tree-edge: 245 # Default = 245
|
||||
git-status:
|
||||
default: 245 # Default = 245
|
||||
unmodified: 245 # Default = 245
|
||||
ignored: 245 # Default = 245
|
||||
new-in-index: dark_green # Default = dark_green
|
||||
new-in-workdir: dark_green # Default = dark_green
|
||||
typechange: dark_yellow # Default = dark_yellow
|
||||
deleted: dark_red # Default = dark_red
|
||||
renamed: dark_green # Default = dark_green
|
||||
modified: dark_yellow # Default = dark_yellow
|
||||
conflicted: dark_red # Default = dark_red
|
||||
|
|
@ -0,0 +1,149 @@
|
|||
---
|
||||
# == Classic ==
|
||||
# This is a shorthand to override some of the options to be backwards compatible
|
||||
# with `ls`. It affects the "color"->"when", "sorting"->"dir-grouping", "date"
|
||||
# and "icons"->"when" options.
|
||||
# Possible values: false, true
|
||||
classic: false
|
||||
|
||||
# == Blocks ==
|
||||
# This specifies the columns and their order when using the long and the tree
|
||||
# layout.
|
||||
# Possible values: permission, user, group, context, size, date, name, inode, links, git
|
||||
blocks:
|
||||
- permission
|
||||
- user
|
||||
- group
|
||||
- size
|
||||
- date
|
||||
- name
|
||||
|
||||
# == Color ==
|
||||
# This has various color options. (Will be expanded in the future.)
|
||||
color:
|
||||
# When to colorize the output.
|
||||
# When "classic" is set, this is set to "never".
|
||||
# Possible values: never, auto, always
|
||||
when: auto
|
||||
# How to colorize the output.
|
||||
# When "classic" is set, this is set to "no-color".
|
||||
# Possible values: default, custom
|
||||
# When "custom" is set, lsd will look in the config directory for `colors.yaml`.
|
||||
theme: default
|
||||
|
||||
# == Date ==
|
||||
# This specifies the date format for the date column. The freeform format
|
||||
# accepts a strftime like string.
|
||||
# When "classic" is set, this is set to "date".
|
||||
# Possible values: date, locale, relative, '+<date_format>'
|
||||
# `date_format` will be a `strftime` formatted value. e.g. `date: '+%d %b %y %X'` will give you a date like this: 17 Jun 21 20:14:55
|
||||
date: date
|
||||
|
||||
# == Dereference ==
|
||||
# Whether to dereference symbolic links.
|
||||
# Possible values: false, true
|
||||
dereference: false
|
||||
|
||||
# == Display ==
|
||||
# What items to display. Do not specify this for the default behavior.
|
||||
# Possible values: all, almost-all, directory-only
|
||||
# display: all
|
||||
|
||||
# == Icons ==
|
||||
icons:
|
||||
# When to use icons.
|
||||
# When "classic" is set, this is set to "never".
|
||||
# Possible values: always, auto, never
|
||||
when: auto
|
||||
# Which icon theme to use.
|
||||
# Possible values: fancy, unicode
|
||||
theme: fancy
|
||||
# Separator between icon and the name
|
||||
# Default to 1 space
|
||||
separator: " "
|
||||
|
||||
# == Ignore Globs ==
|
||||
# A list of globs to ignore when listing.
|
||||
# ignore-globs:
|
||||
# - .git
|
||||
|
||||
# == Indicators ==
|
||||
# Whether to add indicator characters to certain listed files.
|
||||
# Possible values: false, true
|
||||
indicators: false
|
||||
|
||||
# == Layout ==
|
||||
# Which layout to use. "oneline" might be a bit confusing here and should be
|
||||
# called "one-per-line". It might be changed in the future.
|
||||
# Possible values: grid, tree, oneline
|
||||
layout: grid
|
||||
|
||||
# == Recursion ==
|
||||
recursion:
|
||||
# Whether to enable recursion.
|
||||
# Possible values: false, true
|
||||
enabled: false
|
||||
# How deep the recursion should go. This has to be a positive integer. Leave
|
||||
# it unspecified for (virtually) infinite.
|
||||
# depth: 3
|
||||
|
||||
# == Size ==
|
||||
# Specifies the format of the size column.
|
||||
# Possible values: default, short, bytes
|
||||
size: default
|
||||
|
||||
# == Permission ==
|
||||
# Specify the format of the permission column
|
||||
# Possible value: rwx, octal, attributes (windows only), disable
|
||||
# permission: rwx
|
||||
|
||||
# == Sorting ==
|
||||
sorting:
|
||||
# Specify what to sort by.
|
||||
# Possible values: extension, name, time, size, version
|
||||
column: name
|
||||
# Whether to reverse the sorting.
|
||||
# Possible values: false, true
|
||||
reverse: false
|
||||
# Whether to group directories together and where.
|
||||
# When "classic" is set, this is set to "none".
|
||||
# Possible values: first, last, none
|
||||
dir-grouping: none
|
||||
|
||||
# == No Symlink ==
|
||||
# Whether to omit showing symlink targets
|
||||
# Possible values: false, true
|
||||
no-symlink: false
|
||||
|
||||
# == Total size ==
|
||||
# Whether to display the total size of directories.
|
||||
# Possible values: false, true
|
||||
total-size: false
|
||||
|
||||
# == Hyperlink ==
|
||||
# Attach hyperlink to filenames
|
||||
# Possible values: always, auto, never
|
||||
hyperlink: never
|
||||
|
||||
# == Symlink arrow ==
|
||||
# Specifies how the symlink arrow display, chars in both ascii and utf8
|
||||
symlink-arrow: ⇒
|
||||
|
||||
# == Header ==
|
||||
# Whether to display block headers.
|
||||
# Possible values: false, true
|
||||
header: false
|
||||
|
||||
# == Literal ==
|
||||
# Whether to show quotes on filenames.
|
||||
# Possible values: false, true
|
||||
literal: false
|
||||
|
||||
# == Truncate owner ==
|
||||
# How to truncate the username and group names for a file if they exceed a certain
|
||||
# number of characters.
|
||||
truncate-owner:
|
||||
# Number of characters to keep. By default, no truncation is done (empty value).
|
||||
after:
|
||||
# String to be appended to a name if truncated.
|
||||
marker: ""
|
||||
|
|
@ -0,0 +1,633 @@
|
|||
---
|
||||
# See https://www.nerdfonts.com/cheat-sheet for additional icons
|
||||
filetype:
|
||||
dir: # Default =
|
||||
file: # Default =
|
||||
pipe: # Default =
|
||||
socket: # Default =
|
||||
executable: # Default =
|
||||
symlink-dir: # Default =
|
||||
symlink-file: # Default =
|
||||
device-char: # Default =
|
||||
device-block: # Default =
|
||||
special: # Default =
|
||||
|
||||
name:
|
||||
a: # Default =
|
||||
api: # Default =
|
||||
.asoundrc: # Default =
|
||||
.atom: # Default =
|
||||
.ash: # Default =
|
||||
.ash_history: # Default =
|
||||
authorized_keys: # Default =
|
||||
assets: # Default =
|
||||
.android: # Default =
|
||||
.audacity: # Default =
|
||||
backups: # Default =
|
||||
.bash_history: # Default =
|
||||
.bash_logout: # Default =
|
||||
.bash_profile: # Default =
|
||||
.bashrc: # Default =
|
||||
bin: # Default =
|
||||
.bpython_history: # Default =
|
||||
build: # Default =
|
||||
bspwmrc: # Default =
|
||||
build: # Default =
|
||||
.cache: # Default =
|
||||
cache: # Default =
|
||||
cargo: # Default =
|
||||
cargo: # Default =
|
||||
.cargo: # Default =
|
||||
.ccls: # Default =
|
||||
changelog: # Default =
|
||||
.clang: # Default =
|
||||
composer: # Default =
|
||||
composer: # Default =
|
||||
conf: # Default =
|
||||
config: # Default =
|
||||
config: # Default =
|
||||
config: # Default =
|
||||
.config: # Default =
|
||||
config: # Default =
|
||||
configure: # Default =
|
||||
containerfile: # Default =
|
||||
content: # Default =
|
||||
contributing: # Default =
|
||||
copyright: # Default =
|
||||
cron: # Default =
|
||||
cron: # Default =
|
||||
cron: # Default =
|
||||
cron: # Default =
|
||||
cron: # Default =
|
||||
crontab: # Default =
|
||||
cron: # Default =
|
||||
crypttab: # Default =
|
||||
.cshrc: # Default =
|
||||
csh: # Default =
|
||||
csh: # Default =
|
||||
csh: # Default =
|
||||
css: # Default =
|
||||
custom: # Default =
|
||||
.dbus: # Default =
|
||||
desktop: # Default =
|
||||
docker: # Default =
|
||||
dockerfile: # Default =
|
||||
doc: # Default =
|
||||
dist: # Default =
|
||||
documents: # Default =
|
||||
.doom: # Default =
|
||||
downloads: # Default =
|
||||
.ds_store: # Default =
|
||||
.editorconfig: # Default =
|
||||
.electron: # Default =
|
||||
.emacs: # Default =
|
||||
.env: # Default =
|
||||
environment: # Default =
|
||||
.eslintrc: # Default =
|
||||
.eslintrc: # Default =
|
||||
.eslintrc: # Default =
|
||||
etc: # Default =
|
||||
favicon: # Default =
|
||||
favicons: # Default =
|
||||
.fennelrc: # Default =
|
||||
fstab: # Default =
|
||||
.fastboot: # Default =
|
||||
.gitattributes: # Default =
|
||||
# .gitconfig: # Default =
|
||||
.gitcredentials: # Default =
|
||||
.github: # Default =
|
||||
gitignore_global: # Default =
|
||||
.gitignore: # Default =
|
||||
.gitlab: # Default =
|
||||
.gitmodules: # Default =
|
||||
.git: # Default =
|
||||
.gnupg: # Default =
|
||||
go: # Default =
|
||||
go: # Default =
|
||||
go: # Default =
|
||||
gradle: # Default =
|
||||
gradle: # Default =
|
||||
gradlew: # Default =
|
||||
gradlew: # Default =
|
||||
group: # Default =
|
||||
gruntfile: # Default =
|
||||
gruntfile: # Default =
|
||||
gruntfile: # Default =
|
||||
gshadow: # Default =
|
||||
gulpfile: # Default =
|
||||
gulpfile: # Default =
|
||||
gulpfile: # Default =
|
||||
heroku: # Default =
|
||||
hidden: # Default =
|
||||
home: # Default =
|
||||
hostname: # Default =
|
||||
hosts: # Default =
|
||||
.htaccess: # Default =
|
||||
htoprc: # Default =
|
||||
.htpasswd: # Default =
|
||||
.icons: # Default =
|
||||
icons: # Default =
|
||||
id_dsa: # Default =
|
||||
id_ecdsa: # Default =
|
||||
id_rsa: # Default =
|
||||
.idlerc: # Default =
|
||||
img: # Default =
|
||||
include: # Default =
|
||||
init: # Default =
|
||||
.inputrc: # Default =
|
||||
inputrc: # Default =
|
||||
.java: # Default =
|
||||
jenkinsfile: # Default =
|
||||
js: # Default =
|
||||
jule: # Default =
|
||||
.jupyter: # Default =
|
||||
kbuild: # Default =
|
||||
kconfig: # Default =
|
||||
kdeglobals: # Default =
|
||||
kdenliverc: # Default =
|
||||
known_hosts: # Default =
|
||||
.kshrc: # Default =
|
||||
libexec: # Default =
|
||||
lib32: # Default =
|
||||
lib64: # Default =
|
||||
lib: # Default =
|
||||
license: # Default =
|
||||
licenses: # Default =
|
||||
license: # Default =
|
||||
license: # Default =
|
||||
localized: # Default =
|
||||
lsb: # Default =
|
||||
.lynxrc: # Default =
|
||||
.mailcap: # Default =
|
||||
mail: # Default =
|
||||
magic: # Default =
|
||||
maintainers: # Default =
|
||||
makefile: # Default =
|
||||
makefile: # Default =
|
||||
manifest: # Default =
|
||||
md5sum: # Default =
|
||||
meson: # Default =
|
||||
metadata: # Default =
|
||||
metadata: # Default =
|
||||
media: # Default =
|
||||
.mime: # Default =
|
||||
mime: # Default =
|
||||
module: # Default =
|
||||
.mozilla: # Default =
|
||||
music: # Default =
|
||||
muttrc: # Default =
|
||||
.muttrc: # Default =
|
||||
.mutt: # Default =
|
||||
.mypy_cache: # Default =
|
||||
neomuttrc: # Default =
|
||||
.neomuttrc: # Default =
|
||||
netlify: # Default =
|
||||
.nix: # Default =
|
||||
.nix: # Default =
|
||||
.node: # Default =
|
||||
node_modules: # Default =
|
||||
.node_repl_history: # Default =
|
||||
npmignore: # Default =
|
||||
.npm: # Default =
|
||||
nvim: # Default =
|
||||
obj: # Default =
|
||||
os: # Default =
|
||||
package: # Default =
|
||||
package: # Default =
|
||||
packages: # Default =
|
||||
pam: # Default =
|
||||
passwd: # Default =
|
||||
pictures: # Default =
|
||||
pkgbuild: # Default =
|
||||
.pki: # Default =
|
||||
portage: # Default =
|
||||
profile: # Default =
|
||||
.profile: # Default =
|
||||
public: # Default =
|
||||
__pycache__: # Default =
|
||||
pyproject: # Default =
|
||||
.python_history: # Default =
|
||||
.pypirc: # Default =
|
||||
rc: # Default =
|
||||
readme: # Default =
|
||||
.release: # Default =
|
||||
requirements: # Default =
|
||||
robots: # Default =
|
||||
root: # Default =
|
||||
rubydoc: # Default =
|
||||
runtime: # Default =
|
||||
.rustup: # Default =
|
||||
rustfmt: # Default =
|
||||
.rvm: # Default =
|
||||
sass: # Default =
|
||||
sbin: # Default =
|
||||
scripts: # Default =
|
||||
scss: # Default =
|
||||
sha256sum: # Default =
|
||||
shadow: # Default =
|
||||
share: # Default =
|
||||
.shellcheckrc: # Default =
|
||||
shells: # Default =
|
||||
.spacemacs: # Default =
|
||||
.sqlite_history: # Default =
|
||||
src: # Default =
|
||||
source: # Default =
|
||||
.ssh: # Default =
|
||||
static: # Default =
|
||||
std: # Default =
|
||||
styles: # Default =
|
||||
subgid: # Default =
|
||||
subuid: # Default =
|
||||
sudoers: # Default =
|
||||
sxhkdrc: # Default =
|
||||
template: # Default =
|
||||
tests: # Default =
|
||||
test: # Default =
|
||||
tigrc: # Default =
|
||||
timezone: # Default =
|
||||
tox: # Default =
|
||||
.trash: # Default =
|
||||
ts: # Default =
|
||||
.tox: # Default =
|
||||
unlicense: # Default =
|
||||
url: # Default =
|
||||
user: # Default =
|
||||
vagrantfile: # Default =
|
||||
vendor: # Default =
|
||||
venv: # Default =
|
||||
videos: # Default =
|
||||
.viminfo: # Default =
|
||||
.vimrc: # Default =
|
||||
vimrc: # Default =
|
||||
.vim: # Default =
|
||||
vim: # Default =
|
||||
.vscode: # Default =
|
||||
webpack: # Default =
|
||||
.wgetrc: # Default =
|
||||
wgetrc: # Default =
|
||||
.xauthority: # Default =
|
||||
.Xauthority: # Default =
|
||||
xbps: # Default =
|
||||
xbps: # Default =
|
||||
.xinitrc: # Default =
|
||||
.xmodmap: # Default =
|
||||
.Xmodmap: # Default =
|
||||
xmonad: # Default =
|
||||
xorg: # Default =
|
||||
.xprofile: # Default =
|
||||
.Xprofile: # Default =
|
||||
.xresources: # Default =
|
||||
.yarnrc: # Default =
|
||||
yarn: # Default =
|
||||
zathurarc: # Default =
|
||||
.zcompdump: # Default =
|
||||
.zlogin: # Default =
|
||||
.zlogout: # Default =
|
||||
.zprofile: # Default =
|
||||
.zsh_history: # Default =
|
||||
.zshrc: # Default =
|
||||
|
||||
extension:
|
||||
1: # Default =
|
||||
2: # Default =
|
||||
3: # Default =
|
||||
4: # Default =
|
||||
5: # Default =
|
||||
6: # Default =
|
||||
7: # Default =
|
||||
7z: # Default =
|
||||
8: # Default =
|
||||
890: # Default =
|
||||
a: # Default =
|
||||
ai: # Default =
|
||||
ape: # Default =
|
||||
apk: # Default =
|
||||
apng: # Default =
|
||||
ar: # Default =
|
||||
asc: # Default =
|
||||
asm: # Default =
|
||||
asp: # Default =
|
||||
avi: # Default =
|
||||
avif: # Default =
|
||||
avro: # Default =
|
||||
awk: # Default =
|
||||
bak: # Default =
|
||||
bash_history: # Default =
|
||||
bash_profile: # Default =
|
||||
bashrc: # Default =
|
||||
bash: # Default =
|
||||
bat: # Default =
|
||||
bin: # Default =
|
||||
bio: # Default =
|
||||
blend: # Default =
|
||||
blend1: # Default =
|
||||
bmp: # Default =
|
||||
bz2: # Default =
|
||||
cc: # Default =
|
||||
cfg: # Default =
|
||||
cip: # Default =
|
||||
cjs: # Default =
|
||||
class: # Default =
|
||||
cljs: # Default =
|
||||
clj: # Default =
|
||||
cls: # Default =
|
||||
cl: # Default =
|
||||
cmd: # Default =
|
||||
coffee: # Default =
|
||||
conf: # Default =
|
||||
cpp: # Default =
|
||||
cp: # Default =
|
||||
cshtml: # Default =
|
||||
csh: # Default =
|
||||
csproj: # Default =
|
||||
css: # Default =
|
||||
cs: # Default =
|
||||
csv: # Default =
|
||||
csx: # Default =
|
||||
cts: # Default =
|
||||
c: # Default =
|
||||
c: # Default =
|
||||
cue: # Default =
|
||||
cxx: # Default =
|
||||
cypher: # Default =
|
||||
dart: # Default =
|
||||
dat: # Default =
|
||||
db: # Default =
|
||||
deb: # Default =
|
||||
desktop: # Default =
|
||||
diff: # Default =
|
||||
dll: # Default =
|
||||
dockerfile: # Default =
|
||||
doc: # Default =
|
||||
docx: # Default =
|
||||
download: # Default =
|
||||
ds_store: # Default =
|
||||
dump: # Default =
|
||||
ebook: # Default =
|
||||
ebuild: # Default =
|
||||
eclass: # Default =
|
||||
editorconfig: # Default =
|
||||
egg: # Default =
|
||||
ejs: # Default =
|
||||
elc: # Default =
|
||||
elf: # Default =
|
||||
elm: # Default =
|
||||
el: # Default =
|
||||
env: # Default =
|
||||
eot: # Default =
|
||||
epub: # Default =
|
||||
erb: # Default =
|
||||
erl: # Default =
|
||||
exe: # Default =
|
||||
exs: # Default =
|
||||
ex: # Default =
|
||||
fish: # Default =
|
||||
flac: # Default =
|
||||
flv: # Default =
|
||||
fnl: # Default =
|
||||
font: # Default =
|
||||
fpl: # Default =
|
||||
fsi: # Default =
|
||||
fs: # Default =
|
||||
fsx: # Default =
|
||||
gdoc: # Default =
|
||||
gemfile: # Default =
|
||||
gemspec: # Default =
|
||||
gform: # Default =
|
||||
gif: # Default =
|
||||
git: # Default =
|
||||
go: # Default =
|
||||
gpg: # Default =
|
||||
gradle: # Default =
|
||||
gsheet: # Default =
|
||||
gslides: # Default =
|
||||
guardfile: # Default =
|
||||
gv: # Default =
|
||||
gz: # Default =
|
||||
hbs: # Default =
|
||||
heic: # Default =
|
||||
heif: # Default =
|
||||
heix: # Default =
|
||||
hh: # Default =
|
||||
hpp: # Default =
|
||||
hs: # Default =
|
||||
html: # Default =
|
||||
htm: # Default =
|
||||
h: # Default =
|
||||
hxx: # Default =
|
||||
ico: # Default =
|
||||
image: # Default =
|
||||
img: # Default =
|
||||
iml: # Default =
|
||||
info: # Default =
|
||||
in: # Default =
|
||||
ini: # Default =
|
||||
ipynb: # Default =
|
||||
iso: # Default =
|
||||
j2: # Default =
|
||||
jar: # Default =
|
||||
java: # Default =
|
||||
jinja: # Default =
|
||||
jl: # Default =
|
||||
jpeg: # Default =
|
||||
jpg: # Default =
|
||||
jsonc: # Default =
|
||||
json: # Default =
|
||||
js: # Default =
|
||||
jsx: # Default =
|
||||
jule: # Default =
|
||||
key: # Default =
|
||||
ksh: # Default =
|
||||
kt: # Default =
|
||||
kts: # Default =
|
||||
kusto: # Default =
|
||||
ldb: # Default =
|
||||
ld: # Default =
|
||||
less: # Default =
|
||||
lhs: # Default =
|
||||
license: # Default =
|
||||
lisp: # Default =
|
||||
list: # Default =
|
||||
localized: # Default =
|
||||
lock: # Default =
|
||||
log: # Default =
|
||||
lss: # Default =
|
||||
lua: # Default =
|
||||
lz: # Default =
|
||||
mgc: # Default =
|
||||
m3u8: # Default =
|
||||
m3u: # Default =
|
||||
m4: # Default =
|
||||
m4a: # Default =
|
||||
m4v: # Default =
|
||||
magnet: # Default =
|
||||
make: # Default =
|
||||
makefile: # Default =
|
||||
malloy: # Default =
|
||||
man: # Default =
|
||||
markdown: # Default =
|
||||
md: # Default =
|
||||
mjs: # Default =
|
||||
mkd: # Default =
|
||||
mk: # Default =
|
||||
mkv: # Default =
|
||||
ml: # Default =
|
||||
mli: # Default =
|
||||
mll: # Default =
|
||||
mly: # Default =
|
||||
mobi: # Default =
|
||||
mov: # Default =
|
||||
mp3: # Default =
|
||||
mp4: # Default =
|
||||
msi: # Default =
|
||||
mts: # Default =
|
||||
mustache: # Default =
|
||||
nim: # Default =
|
||||
nimble: # Default =
|
||||
nix: # Default =
|
||||
npmignore: # Default =
|
||||
odp: # Default =
|
||||
ods: # Default =
|
||||
odt: # Default =
|
||||
ogg: # Default =
|
||||
ogv: # Default =
|
||||
old: # Default =
|
||||
opus: # Default =
|
||||
orig: # Default =
|
||||
org: # Default =
|
||||
otf: # Default =
|
||||
o: # Default =
|
||||
part: # Default =
|
||||
patch: # Default =
|
||||
pdb: # Default =
|
||||
pdf: # Default =
|
||||
pem: # Default =
|
||||
phar: # Default =
|
||||
php: # Default =
|
||||
pkg: # Default =
|
||||
pl: # Default =
|
||||
plist: # Default =
|
||||
pls: # Default =
|
||||
plx: # Default =
|
||||
pm: # Default =
|
||||
png: # Default =
|
||||
pod: # Default =
|
||||
pp: # Default =
|
||||
ppt: # Default =
|
||||
pptx: # Default =
|
||||
procfile: # Default =
|
||||
properties: # Default =
|
||||
prql: # Default =
|
||||
ps1: # Default =
|
||||
psd: # Default =
|
||||
pub: # Default =
|
||||
pug: # Default =
|
||||
sbv: # Default =
|
||||
scc: # Default =
|
||||
slt: # Default =
|
||||
smi: # Default =
|
||||
pxm: # Default =
|
||||
pyc: # Default =
|
||||
py: # Default =
|
||||
rakefile: # Default =
|
||||
rar: # Default =
|
||||
razor: # Default =
|
||||
rb: # Default =
|
||||
rdata: # Default =
|
||||
rdb: # Default =
|
||||
rdoc: # Default =
|
||||
rds: # Default =
|
||||
readme: # Default =
|
||||
rlib: # Default =
|
||||
rl: # Default =
|
||||
rmd: # Default =
|
||||
rmeta: # Default =
|
||||
rpm: # Default =
|
||||
rproj: # Default =
|
||||
rq: # Default =
|
||||
rspec_parallel: # Default =
|
||||
rspec_status: # Default =
|
||||
rspec: # Default =
|
||||
rss: # Default =
|
||||
rs: # Default =
|
||||
rtf: # Default =
|
||||
rubydoc: # Default =
|
||||
r: # Default =
|
||||
ru: # Default =
|
||||
sass: # Default =
|
||||
scala: # Default =
|
||||
scpt: # Default =
|
||||
scss: # Default =
|
||||
shell: # Default =
|
||||
sh: # Default =
|
||||
sig: # Default =
|
||||
slim: # Default =
|
||||
sln: # Default =
|
||||
so: # Default =
|
||||
sqlite3: # Default =
|
||||
sql: # Default =
|
||||
srt: # Default =
|
||||
styl: # Default =
|
||||
stylus: # Default =
|
||||
sublime: # Default =
|
||||
sublime: # Default =
|
||||
sublime: # Default =
|
||||
sublime: # Default =
|
||||
sub: # Default =
|
||||
s: # Default =
|
||||
svg: # Default =
|
||||
svelte: # Default =
|
||||
swift: # Default =
|
||||
swp: # Default =
|
||||
sym: # Default =
|
||||
tar: # Default =
|
||||
taz: # Default =
|
||||
tbz: # Default =
|
||||
tbz2: # Default =
|
||||
tex: # Default =
|
||||
tgz: # Default =
|
||||
tiff: # Default =
|
||||
timestamp: # Default =
|
||||
toml: # Default =
|
||||
torrent: # Default =
|
||||
trash: # Default =
|
||||
ts: # Default =
|
||||
tsx: # Default =
|
||||
ttc: # Default =
|
||||
ttf: # Default =
|
||||
t: # Default =
|
||||
twig: # Default =
|
||||
txt: # Default =
|
||||
unity: # Default =
|
||||
unity32: # Default =
|
||||
video: # Default =
|
||||
vim: # Default =
|
||||
vlc: # Default =
|
||||
vtt: # Default =
|
||||
vue: # Default =
|
||||
wav: # Default =
|
||||
webm: # Default =
|
||||
webp: # Default =
|
||||
whl: # Default =
|
||||
windows: # Default =
|
||||
wma: # Default =
|
||||
wmv: # Default =
|
||||
woff2: # Default =
|
||||
woff: # Default =
|
||||
wpl: # Default =
|
||||
xbps: # Default =
|
||||
xcf: # Default =
|
||||
xls: # Default =
|
||||
xlsx: # Default =
|
||||
xml: # Default =
|
||||
xul: # Default =
|
||||
xz: # Default =
|
||||
yaml: # Default =
|
||||
yml: # Default =
|
||||
zip: # Default =
|
||||
zig: # Default =
|
||||
zon: # Default =
|
||||
zshrc: # Default =
|
||||
zsh: # Default =
|
||||
zsh: # Default =
|
||||
zst: # Default =
|
||||
Loading…
Reference in New Issue