summaryrefslogtreecommitdiffstats
path: root/desktop/somebar/README
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/somebar/README')
-rw-r--r--desktop/somebar/README27
1 files changed, 27 insertions, 0 deletions
diff --git a/desktop/somebar/README b/desktop/somebar/README
new file mode 100644
index 0000000000..4ef8b19a85
--- /dev/null
+++ b/desktop/somebar/README
@@ -0,0 +1,27 @@
+Some bar is a dwl-like bar for dwl.
+
+Configuration:
+
+Copy src/config.def.hpp to src/config.hpp, and adjust if needed.
+
+Usage:
+
+You must start somebar using dwl's -s flag, e.g. dwl -s somebar.
+
+Somebar can be controlled by writing to $XDG_RUNTIME_DIR/somebar-0 or
+the path defined by -s argument. The following commands are supported:
+
+ status TEXT: Updates the status bar
+ hide MONITOR Hides somebar on the specified monitor
+ show MONITOR Shows somebar on the specified monitor
+ toggle MONITOR Toggles somebar on the specified monitor
+
+MONITOR is an zxdg_output_v1 name, which can be determined e.g.
+using weston-info. Additionally, MONITOR can be all (all monitors) or
+selected (the monitor with focus).
+
+Commands can be sent either by writing to the file name above, or
+equivalently by calling somebar with the -c argument.
+For example: somebar -c toggle all.
+This is recommended for shell scripts, as there is no race-free way to
+write to a file only if it exists.