commit 10729c566e781d18a32421567ee70be70476bfac
Author: Raniconduh <clagv.randomgames@gmail.com>
Date: Mon Jan 31 17:33:44 2022 +0000
Update README.md
diff --git a/README.md b/README.md
index 5004977..83d09b5 100644
--- a/README.md
+++ b/README.md
@@ -276 +278 @@ Files that are executable but have another identifier will keep the identifier b
Symbolic links that point to directories will be suffixed with `@ => /` and may be entered as a normal directory. Otherwise, deletion of a symbolic link will not delete whatever the link points to; only the link itself and opening one will open what the link points to.
+File colors can also be customized. ([see variables](#variables))
+
### Options
* `-p`: Print the path cscroll ends in. Useful for commands like `cd $(cscroll -p)` to cd into the last directory
@@ -956 +977 @@ Example config file:
long = true
color = false
icons = false
+dir_color = "#123abc"
```
This will, by default, turn on long mode but turn off colors and icons. However, variables can still be set and unset when in cscroll itself. To turn off long listing mode once again, for example, one could run this command in cscroll: `:unset long`.
@@ -1096 +11219 @@ Variables allow changing settings while in cscroll itself as opposed to having t
* `icons`: (If compiled with icons) If true, show icons. Otherwise don't.
* `long`: Turn on or off long mode
+The following variables are specific to the config file and may be set as a string. These control the colors for each of the type of file specified by their names. Their values must be specified as six digit hexadecimal numbers with or without a leading hash (#). An example could be `dir_color = "#123abc"`.
+
+* `dir_color`: Directories
+* `reg_color`: Regular files (i.e. any file which is not any other color)
+* `fifo_color`: FIFO/Named pipes
+* `link_color`: Symbolic links
+* `block_color`: Block files (typically devices found in `/dev`)
+* `sock_color`: Unix sockets
+* `unknown_color`: A file that cannot be accessed to determine type
+* `exec_color`: Any executable file
+* `media_color`: Any media file (pictures, audio files, videos)
+* `archive_color`: Any file archives (tarballs, zips, etc.)
+
## Compilation
To run, cscroll requires libncurses and libterminfo. Compilation, however, also requires pkg-config.
