Mirror
/
LS_COLORS
mirror of https://github.com/trapd00r/LS_COLORS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #113 from Anton-Latukha/add_fish 

README: big clean-up and adding fish shell instructions
This commit is contained in:
Ryan Delaney 2018-12-11 10:06:58 -08:00 committed by GitHub
parent 0fd3a0330c 9a26efee91
commit 1ba5f6676d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 59 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

109
README.markdown
View File

@ -1,8 +1,16 @@
LS_COLORS
=========
### Table of contents
* [LS_COLORS](#ls_colors)
* [What does it look like?](#what-does-it-look-like)
* [Installation](#installation)
* [Arch Linux](#arch-linux)
* [ZSH syntax highlighting](#zsh-syntax-highlighting)
* [fish shell](#fish-shell)
* [Information for Developers](#information-for-developers)
* [Legal](#legal)
# LS_COLORS
This is a collection of extension:color mappings, suitable to use as your
LS COLORS environment variable. Most of them use the extended color map,
`LS_COLORS` environment variable. Most of them use the extended color map,
described in the ECMA-48 document; in other words, you'll need a terminal
with capabilities of displaying 256 colors.
@ -19,63 +27,64 @@ For files that usually ends up next to each other, like html, css and js,
try to pick colors that fits in nicely together. Filetypes with multiple
possible extensions, like htm and html, should have the same color.
# Installation
To install and use this file, put something like this is your shell resource
file:
# What does it look like?
Here's a screenshot _(font and minor color shades, of course, depend on terminal and its configuration)_:
eval $( dircolors -b $HOME/LS_COLORS )
A quick way to install would be the following set of commands (assuming bash):
```sh
wget https://raw.github.com/trapd00r/LS_COLORS/master/LS_COLORS -O $HOME/.dircolors
echo 'eval $(dircolors -b $HOME/.dircolors)' >> $HOME/.bashrc
. $HOME/.bashrc
```
### Archlinux
Archlinux users can install the [`lscolors-git`][3] package from the AUR for easy
integration with bash, csh, or zsh.
ZSH SYNTAX HIGHLIGHTING
=======================
[zsh-syntax-highlighting-filetypes][0] highlights file on the command-line in
realtime, using these colors.
DEVELOPERS
==========
There's a [library][1] I've written that lets you use various LS COLORS on
arbitrary files and directories. A simple implementation can be found [here][2].
Using this, you can do
find $HOME -maxdepth 1 | ls_color
mpc search artist Laleh | ls_color
... and so on.
SO WHAT DOES IT LOOK LIKE
=========================
Here's a screenshot:
![LS_COLORS](http://orig07.deviantart.net/f59a/f/2016/087/a/e/ls_colors_1_by_trapd00r-d9wrdoa.png)
![Screenshot1](http://orig07.deviantart.net/f59a/f/2016/087/a/e/ls_colors_1_by_trapd00r-d9wrdoa.png)
And another one:
![LS_COLORS_2](http://orig02.deviantart.net/5c73/f/2016/087/4/8/ls_colors_2_by_trapd00r-d9wrdrq.png)
![Screenshot2](http://orig02.deviantart.net/5c73/f/2016/087/4/8/ls_colors_2_by_trapd00r-d9wrdrq.png)
[0]: https://github.com/trapd00r/zsh-syntax-highlighting-filetypes
[1]: https://github.com/trapd00r/File-LsColor
[2]: https://github.com/trapd00r/File-LsColor/tree/master/bin
[3]: https://aur.archlinux.org/packages/lscolors-git
LEGAL
=====
# Installation
To install and use this file, put something like this is your shell resource
file:
```shell
eval $( dircolors -b $HOME/LS_COLORS )
```
A quick way to install would be the following set of commands (assuming bash):
```shell
wget https://raw.github.com/trapd00r/LS_COLORS/master/LS_COLORS -O $HOME/.dircolors
echo 'eval $(dircolors -b $HOME/.dircolors)' >> $HOME/.bashrc
. $HOME/.bashrc
```
## Arch Linux
Arch Linux users can install the [`lscolors-git`][3] package from the AUR for easy
integration with bash, csh, or zsh.
## ZSH syntax highlighting
[zsh-syntax-highlighting-filetypes][0] highlights file on the command-line in
realtime, using these colors.
## fish shell
```fish
eval ( dircolors --c-shell $HOME/LS_COLORS )
```
Place it in `~/.config/fish/config.fish` or any `*.fish*` file inside `~/.config/fish/conf.d/` to be loaded.
# Information for Developers
There's a [library][1] I've written that lets you use various LS COLORS on
arbitrary files and directories. A simple implementation can be found [here][2].
Using this, you can do
```shell
find $HOME -maxdepth 1 | ls_color
mpc search artist Laleh | ls_color
```
... and so on.
# Legal
© Copyright 2014-2018 Magnus Woldrich.
This program is distributed in the hope that it will be useful, but WITHOUT ANY