diff options
author | Cameron Katri <me@cameronkatri.com> | 2021-04-28 14:41:53 -0400 |
---|---|---|
committer | Cameron Katri <me@cameronkatri.com> | 2021-04-28 14:41:53 -0400 |
commit | 80de3780c13b7c27c67737a0225716f657589dd4 (patch) | |
tree | 96e4da855cc96ffb8018824ef40315a271f7276c /README.md | |
parent | b96ac7a7af7b35c0219ffd63f3867a75621ff8a9 (diff) | |
download | opendircolors-80de3780c13b7c27c67737a0225716f657589dd4.tar.gz opendircolors-80de3780c13b7c27c67737a0225716f657589dd4.tar.zst opendircolors-80de3780c13b7c27c67737a0225716f657589dd4.zip |
Add README.md
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..fb3f3ed --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# opendircolors +A BSD-licensed replacement for GNU dircolors(1) + +FreeBSD's (and MacOS') `ls(1)` supports colors using the `LSCOLORS` variable, where as GNU's uses the more customizable `LS_COLORS` which is generated with the command `dircolors(1)` in coreutils. This repo contains two different utilites, `opendircolors(1)` and `dirconvert(1)`. + +### `opendircolors(1) [-bch] file` +A near drop in replacement for GNU's `dircolors(1)`, lacking only built in defaults and `-p`. This will read from `file` and prints the commands needed to set both `LSCOLORS` and `LS_COLORS`. The typical usage is to add ``eval "`opendircolors ~/.dir_colors`"`` to your `.*shrc`. + +### `dirconvert(1) LSCOLORS | LS_COLORS` +Will read the inputed string and convert it to the other format, ignoring anything that can't be converted. |