aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorterminaldweller <devi@terminaldweller.com>2023-03-24 13:44:29 +0000
committerterminaldweller <devi@terminaldweller.com>2023-03-24 13:44:29 +0000
commit17b15dfcebce7537e411ef69f6493c8ab1f49544 (patch)
tree9295dca8bc19cbc89b570a37b8fb8a1be191c334 /README.md
parentfixed the main function so poetry build actually works correctly (diff)
downloadvirttop-17b15dfcebce7537e411ef69f6493c8ab1f49544.tar.gz
virttop-17b15dfcebce7537e411ef69f6493c8ab1f49544.zip
fixed the help option, fixed some breakages, some operations are now async, updated the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 28 insertions, 7 deletions
diff --git a/README.md b/README.md
index 15649cd..718c522 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,6 @@
# virttop
a top like utility for libvirt
-
![Image](virttop.png)
## How to get
@@ -9,6 +8,23 @@ a top like utility for libvirt
pip install virttop
```
+## Options
+```sh
+usage: virttop.py [-h] [--uri URI [URI ...]] [--config CONFIG]
+ [--active ACTIVE] [--logfile LOGFILE]
+
+options:
+ -h, --help show this help message and exit
+ --uri URI [URI ...], -u URI [URI ...]
+ A list of URIs to connect to seperated by commas
+ --config CONFIG, -c CONFIG
+ Path to the config file
+ --active ACTIVE, -a ACTIVE
+ Show active VMs only
+ --logfile LOGFILE, -l LOGFILE
+ Location of the log file
+```
+
## Configfile
The default location for the config file is '~/.virttop.toml'.
@@ -28,9 +44,14 @@ selected_bg=36
## Keybindings
-`j` and `k` and arrow keys move up and down.</br>
-`g` moves to the top of the list.</br>
-`G` moved to the bottom of the list.</br>
-`r` runs an inactive domain.</br>
-`s` shuts down a running domain.</br>
-`d` destroy a running domain.</br>
+`j`,`k` and arrow keys move up and down.
+
+`g` moves to the top of the list.
+
+`G` moves to the bottom of the list.
+
+`r` runs an inactive domain.
+
+`s` shuts down a running domain.
+
+`d` destroys a running domain.