Skip to content

Commit 4da4f32

Browse files
committed
README changes
1 parent b2fb325 commit 4da4f32

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,25 @@ SYNOPSIS
66

77
barmaid.lua is a status-bar generation program with unicode and modules support. It is written in lua using libUseful-lua. It can generate output suitable for dzen2, lemonbar, xterm title-bars, dwm and the terminal. It can display info on date, time, system load, memory usage, partition usage, cpu usage, ip4 address/netmask/broadcast, hostname, kernel, architecture, ostype, uptime, cpu count, battery level, and cpu temperature. No external programs are run to generate this data, so barmaid's resource usage should be low. Unfortuantely, as barmaid pulls a lot of data from /proc and /sys, it's a mostly linux-only program. Barmaid is extensible via its modules system.
88

9+
910
INSTALL
1011
=======
1112

1213
You'll need to install libUseful (https://github.com/ColumPaget/libUseful) and libUseful-lua (https://github.com/ColumPaget/libUseful-lua)
1314

15+
The program consists of one big script 'barmaid.lua'. The code is broken into parts, and can be built using the supplied makefile by typing 'make'.
16+
17+
Either run barmaid.lua using 'lua barmaid.lua' or use the linux binfmt system to auto invoke it.
18+
19+
Extension modules (supplied in the 'modules' subdirectory) currently go in /usr/local/lib/barmaid/
20+
21+
22+
1423
USAGE
1524
======
1625

1726
```
18-
lua barmaid.lua [-t output_type] [-type output_type] [-x xpos] [-y ypos] [-w width] [-h height] [-a align] [-bg color] [-fg color] [-fn font] [-font font] [-kvfile path] [-sock path] [format string]
27+
lua barmaid.lua [-t output_type] [-type output_type] [-x xpos] [-y ypos] [-w width] [-h height] [-a align] [-bg color] [-fg color] [-fn font] [-font font] [-kvfile path] [-sock path] [-icon-path] [format string]
1928
```
2029

2130
online help can be called up with 'lua barmaid.lua -help'
@@ -219,7 +228,7 @@ Where 'name' is the name of a value, and 'value' is it's actual displayed result
219228

220229
Could be used to supply a green 'G' to indicate google is accessible, but not interfere with any other values that return 'up'.
221230

222-
The 'key' of the translation (i.e. 'name=value') can contain shell/fnmatch-style wildcards. The symbols '*', '+', '?', '[' and ']' will be honored with their shell/fnmatch meanings. '\' can be used to quote these characters.
231+
The 'key' of the translation (i.e. 'name=value') can contain shell/fnmatch-style wildcards. The symbols `*`, `+`, `?`, `[` and `]` will be honored with their shell/fnmatch meanings. `\` can be used to quote these characters.
223232

224233
EXAMPLE:
225234

barmaid.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ SHELL_OKAY=0
1212
SHELL_CLOSED=1
1313
SHELL_CLS=2
1414

15-
version="5.7"
15+
version="6.0"
1616
settings={}
1717
lookup_counter=0
1818
lookup_values={}

0 commit comments

Comments
 (0)