Skip to content

Commit 9a17382

Browse files
committed
update documentation
1 parent b6b37c1 commit 9a17382

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Supported Window Managers
1212

1313
blackbox https://github.com/bradleythughes/blackbox/
1414
fluxbox http://fluxbox.org/
15+
openbox http://openbox.org/
1516
icewm https://ice-wm.org/
1617
pekwm http://www.pekwm.org/
1718
mlvwm http://www2u.biglobe.ne.jp/~y-miyata/mlvwm.html
@@ -60,8 +61,10 @@ Multiple 'window manager' arguements can be supplied and can contain the followi
6061
all this will write out menu files for all supported window managers
6162
blackbox write to file ~/.blackbox/menu
6263
fluxbox write to file ~/.fluxbox/menu
64+
openbox write to file ~/.config/openbox/menu.xml
6365
icewm write to file ~/.icewm/menu
6466
pekwm write to file ~/.pekwm/menu
67+
pwm write to file ~/.pwm/rootmenu.conf
6568
jwm write to file ~/.menu.jwm
6669
mlvwm write to file ~/.menu.mlvwm
6770
twm write to file ~/.menu.twm
@@ -70,8 +73,10 @@ Multiple 'window manager' arguements can be supplied and can contain the followi
7073
7174
stdout:blackbox write blackbox menu to stdout
7275
stdout:fluxbox write fluxbox menu to stdout
76+
stdout:openbox write fluxbox menu to stdout
7377
stdout:icewm write icewm menu to stdout
7478
stdout:pekwm write pekwm menu to stdout
79+
stdout:pwm write pwm menu to stdout
7580
stdout:jwm write jwm menu to stdout
7681
stdout:mlvwm write mlvwm menu to stdout
7782
stdout:twm write twm menu to stdout
@@ -83,7 +88,9 @@ Multiple 'window manager' arguements can be supplied and can contain the followi
8388
Example
8489
-------
8590

91+
```
8692
menubuilder.lua -faves xterm,links,smplayer jwm icewm
93+
```
8794

8895
Including the menus
8996
-------------------
@@ -179,6 +186,11 @@ the group the application belongs to
179186
Icons are only currently supported for the JWM and IceWM window managers. Icons can be turned off altogether with the '-no-icons' command-line option.
180187

181188

189+
Window Manager Update
190+
---------------------
191+
192+
The jwm, openbox and icewm window managers support auto-update, so that when menubuilder creates a new menu for them, it signals them to reload their menus. This allows menubuilder to be launched by an inotify or other filesystem notification service sees new files created. Menus can thus be automatically updated and the window-manager told to reload.
193+
182194

183195
Config File
184196
-----------

menubuilder.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1594,7 +1594,7 @@ elseif arg=="-?" or arg=="-h" or arg=="-help" or arg=="--help"
15941594
then
15951595
DisplayHelp()
15961596
os.exit(0)
1597-
elseif arg=="all" then settings.output="jwm,twm,pwm,icewm,pekwm,mlvwm,blackbox,fluxbox"
1597+
elseif arg=="all" then settings.output="jwm,twm,vtwm,ctwm,pwm,icewm,pekwm,mlvwm,blackbox,fluxbox,openbox"
15981598
else settings.output=settings.output .. args[i]..","
15991599
end
16001600

0 commit comments

Comments
 (0)