summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Hilburn <bhilburn@gmail.com>2017-01-21 06:24:03 +0300
committerBen Hilburn <bhilburn@gmail.com>2017-01-21 06:24:03 +0300
commit64afe83cbd368d45c0ab23c05636b426230fcb57 (patch)
tree049b7d31c4cc996d8454231c08adba8b0ecbe4e9 /README.md
parent59b20b8f2780b8a0a3c812cd292393005a1638cb (diff)
Updating the readme wih `hdd_usage` details.
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index f6b8c54c..b1bdf978 100644
--- a/README.md
+++ b/README.md
@@ -88,6 +88,7 @@ The segments that are currently available are:
* [`battery`](#battery) - Current battery status.
* [`context`](#context) - Your username and host.
* [`dir`](#dir) - Your current working directory.
+* [`hdd_usage`](#hdd_usage) - Disk usage of your current partition.
* `history` - The command number for the current line.
* [`ip`](#ip) - Shows the current IP address.
* [`public_ip`](#public_ip) - Shows your public IP address.
@@ -306,6 +307,16 @@ If you want to customize the directory separator, you could set:
POWERLEVEL9K_DIR_PATH_SEPARATOR="%f "$'\uE0B1'" %F"
```
+##### hdd_usage
+
+The `hdd_usage` segment will show the usage level of the partition that your current working directory resides in. It can be configured with the following variables.
+
+| Variable | Default Value | Description |
+|----------|---------------|-------------|
+|POWERLEVEL9K_HDD_USAGE_ONLY_WARNING|false|Hide the segment except when usage levels have hit warning or critical levels.|
+|POWERLEVEL9K_HDD_USAGE_WARNING_LEVEL|90|The usage level that triggers a warning state.|
+|POWERLEVEL9K_HDD_USAGE_CRITICAL_LEVEL|95|The usage level that triggers a critical state.|
+
##### ip
This segment tries to examine all currently used network interfaces and prints