summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorUltrabug <ultrabug@gentoo.org>2015-03-29 15:04:40 +0200
committerUltrabug <ultrabug@gentoo.org>2015-03-29 15:04:40 +0200
commitefaac51e73538e2c166f4302580cb1a00e80b32f (patch)
tree01d5445a216d81656d6f2824a08ea2e25e8d67f7
parent6c036a26769ec694e9d40b62d4f7b4359514c13a (diff)
add CLI modules list documentation
-rw-r--r--README.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 0eb79b4..4185de0 100644
--- a/README.rst
+++ b/README.rst
@@ -52,6 +52,17 @@ Usually you have your own i3status configuration, just point to it:
Available modules
=================
+You can get a list and short description of all the available modules by using the CLI:
+::
+
+ $ py3status modules list
+
+
+To get more details about all the available modules, use:
+::
+
+ $ py3status modules details
+
All the modules shipped with py3status are present in the sources in the `py3status/modules <https://github.com/ultrabug/py3status/tree/master/py3status/modules>`_ folder.
Most of them are **configurable directly from your current i3status.conf**, check them out to see all the configurable variables.