[font="arial, sans-serif;font-size:12px;"]Broadcast messages (Broams) are messages sent to Blackbox and plugins to trigger some actions.[/font]
[font="arial, sans-serif;"]They may be sent[/font]
- [font="arial, sans-serif;"]from the menu, such as:[/font]
[font="'lucida console';"][exec] (label) {@BroadcastMessage}[/font]
- [font="arial, sans-serif;"]from a key shortcut, in bbkeys.rc:[/font]
[font="'lucida console';"]..., WithAction(@BBCore.ShowMenu)[/font]
- [font="arial, sans-serif;"]by other means, for instance by a 'BBInterface' button.[/font]
[font="arial, sans-serif;"]Broadcast messages recognized by the core:[/font]
[font="helvetica, sans-serif;"]Menu[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu[/font]
[font="helvetica, sans-serif;"]show pinned menu, or main menu as default[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu Root[/font]
[font="helvetica, sans-serif;"]show the main menu[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu Workspaces[/font]
[font="helvetica, sans-serif;"]show workspaces menu[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu Tasks[/font]
[font="helvetica, sans-serif;"]show menu with all tasks[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu Icons[/font]
[font="helvetica, sans-serif;"]show menu with minimized tasks[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu Configuration[/font]
[font="helvetica, sans-serif;"]show configuration menu[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu <path>[/font]
[font="helvetica, sans-serif;"]show folder as specified[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu <menu.rc>[/font]
[font="helvetica, sans-serif;"]display alternative menu as specified[/font]
[font="helvetica, sans-serif;"]@BBCore.HideMenu[/font]
[font="helvetica, sans-serif;"]hide all menus that are not 'pinned'[/font]
[font="helvetica, sans-serif;"]ShowMenu Options[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu -at x,y ...[/font]
[font="helvetica, sans-serif;"]show menu at position x,y as specified[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu -at rb x,y ...[/font]
[font="helvetica, sans-serif;"]align at position with right and/or bottom edge[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu -key ...[/font]
[font="helvetica, sans-serif;"]show menu at position as in blackbox.rc[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu -toggle[/font]
[font="helvetica, sans-serif;"]hide menu if it currently has focus[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu -pinned ...[/font]
[font="helvetica, sans-serif;"]make menu stay permanently[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu -ontop ...[/font]
[font="helvetica, sans-serif;"]make menu stay on top[/font]
[font="helvetica, sans-serif;"]@BBCore.ShowMenu -notitle ...[/font]
[font="helvetica, sans-serif;"]show title-less menu[/font]
[font="helvetica, sans-serif;"]Windows[/font]
[font="helvetica, sans-serif;"]@BBCore.PrevWindow[/font]
[font="helvetica, sans-serif;"]activate previous window[/font]
[font="helvetica, sans-serif;"]@BBCore.NextWindow[/font]
[font="helvetica, sans-serif;"]activate next window[/font]
[font="helvetica, sans-serif;"]@BBCore.PrevWindowAllWorkspaces[/font]
[font="helvetica, sans-serif;"]activate previous window (all workspaces)[/font]
[font="helvetica, sans-serif;"]@BBCore.NextWindowAllWorkspaces[/font]
[font="helvetica, sans-serif;"]activate next window (all workspaces)[/font]
[font="helvetica, sans-serif;"]@BBCore.RaiseWindow[/font]
[font="helvetica, sans-serif;"]bring bottom window on top[/font]
[font="helvetica, sans-serif;"]@BBCore.LowerWindow[/font]
[font="helvetica, sans-serif;"]send top window to bottom[/font]
[font="helvetica, sans-serif;"]@BBCore.ShadeWindow[/font]
[font="helvetica, sans-serif;"]shade window[/font]
[font="helvetica, sans-serif;"]@BBCore.StickWindow[/font]
[font="helvetica, sans-serif;"]make window appear on all workspaces[/font]
[font="helvetica, sans-serif;"]@BBCore.OnTopWindow[/font]
[font="helvetica, sans-serif;"]make window always on top[/font]
[font="helvetica, sans-serif;"]@BBCore.MinimizeWindow[/font]
[font="helvetica, sans-serif;"]minimize window[/font]
[font="helvetica, sans-serif;"]@BBCore.MaximizeWindow[/font]
[font="helvetica, sans-serif;"]maximize window[/font]
[font="helvetica, sans-serif;"]@BBCore.MaximizeVertical[/font]
[font="helvetica, sans-serif;"]maximize window vertically[/font]
[font="helvetica, sans-serif;"]@BBCore.MaximizeHorizontal[/font]
[font="helvetica, sans-serif;"]maximize window horizontally[/font]
[font="helvetica, sans-serif;"]@BBCore.RestoreWindow[/font]
[font="helvetica, sans-serif;"]restore window[/font]
[font="helvetica, sans-serif;"]@BBCore.MoveWindow[/font]
[font="helvetica, sans-serif;"]move the window[/font]
[font="helvetica, sans-serif;"]@BBCore.ResizeWindow[/font]
[font="helvetica, sans-serif;"]resize the window[/font]
[font="helvetica, sans-serif;"]@BBCore.CloseWindow[/font]
[font="helvetica, sans-serif;"]close window[/font]
[font="helvetica, sans-serif;"]@BBCore.ActivateWindow[/font]
[font="helvetica, sans-serif;"]activate the window in the foreground[/font]
[font="helvetica, sans-serif;"]All Windows[/font]
[font="helvetica, sans-serif;"]@BBCore.MinimizeAll[/font]
[font="helvetica, sans-serif;"]minimize all windows[/font]
[font="helvetica, sans-serif;"]@BBCore.RestoreAll[/font]
[font="helvetica, sans-serif;"]restore all windows[/font]
[font="helvetica, sans-serif;"]@BBCore.Cascade[/font]
[font="helvetica, sans-serif;"]cascade windows[/font]
[font="helvetica, sans-serif;"]@BBCore.TileVertical[/font]
[font="helvetica, sans-serif;"]tile windows vertically[/font]
[font="helvetica, sans-serif;"]@BBCore.TileHorizontal[/font]
[font="helvetica, sans-serif;"]tile windows horizontally[/font]
[font="helvetica, sans-serif;"]Workspaces[/font]
[font="helvetica, sans-serif;"]@BBCore.PrevWorkspace[/font]
[font="helvetica, sans-serif;"]previous workspace[/font]
[font="helvetica, sans-serif;"]@BBCore.NextWorkspace[/font]
[font="helvetica, sans-serif;"]next workspace[/font]
[font="helvetica, sans-serif;"]@BBCore.SwitchToWorkspace #n[/font]
[font="helvetica, sans-serif;"]switch to workspace number #n[/font]
[font="helvetica, sans-serif;"]@BBCore.LastWorkspace[/font]
[font="helvetica, sans-serif;"]switch to last used workspace[/font]
[font="helvetica, sans-serif;"]@BBCore.MoveWindowLeft[/font]
[font="helvetica, sans-serif;"]move window to previous workspace[/font]
[font="helvetica, sans-serif;"]@BBCore.MoveWindowRight[/font]
[font="helvetica, sans-serif;"]move window to next workspace[/font]
[font="helvetica, sans-serif;"]@BBCore.MoveWindowToWS #n[/font]
[font="helvetica, sans-serif;"]move window to workspace number #n and switch WS[/font]
[font="helvetica, sans-serif;"]@BBCore.SendWindowToWS #n[/font]
[font="helvetica, sans-serif;"]send window to workspace number #n and don't switch[/font]
[font="helvetica, sans-serif;"]@BBCore.GatherWindows[/font]
[font="helvetica, sans-serif;"]gather all windows in the current workspace[/font]
[font="helvetica, sans-serif;"]@BBCore.AddWorkspace[/font]
[font="helvetica, sans-serif;"]add another workspace[/font]
[font="helvetica, sans-serif;"]@BBCore.DelWorkspace[/font]
[font="helvetica, sans-serif;"]remove the last workspace[/font]
[font="helvetica, sans-serif;"]@BBCore.EditWorkspaceNames[/font]
[font="helvetica, sans-serif;"]edit the names of workspaces[/font]
[font="helvetica, sans-serif;"]Blackbox[/font]
[font="helvetica, sans-serif;"]@BBCore.toggleplugins[/font]
[font="helvetica, sans-serif;"]toggle plugins (if configured to 'toggle with plugins')[/font]
[font="helvetica, sans-serif;"]@BBCore.toggleplugins true/false[/font]
[font="helvetica, sans-serif;"]show/hide plugins (if configured to 'toggle with plugins')[/font]
[font="helvetica, sans-serif;"]@BBCore.aboutstyle[/font]
[font="helvetica, sans-serif;"]display style info[/font]
[font="helvetica, sans-serif;"]@BBCore.aboutplugins[/font]
[font="helvetica, sans-serif;"]display plugin info[/font]
[font="helvetica, sans-serif;"]@BBCore.about[/font]
[font="helvetica, sans-serif;"]display core info[/font]
[font="helvetica, sans-serif;"]@BBCore.reconfig[/font]
[font="helvetica, sans-serif;"]reload style-settings and rc-settings[/font]
[font="helvetica, sans-serif;"]@BBCore.restart [-p][/font]
[font="helvetica, sans-serif;"]unload and reload all plugins. [/font][font="helvetica, sans-serif;"](*) -p(ause) = paused restart.[/font]
[font="helvetica, sans-serif;"]@BBCore.exit [-q][/font]
[font="helvetica, sans-serif;"]exit the blackbox shell. -q(uiet) = no confirmation.[/font]
[font="helvetica, sans-serif;"]Edit[/font]
[font="helvetica, sans-serif;"]@BBCore.editstyle[/font]
[font="helvetica, sans-serif;"]run the 'blackbox editor' on the current style[/font]
[font="helvetica, sans-serif;"]@BBCore.editmenu[/font]
[font="helvetica, sans-serif;"]run the 'blackbox editor' on menu.rc[/font]
[font="helvetica, sans-serif;"]@BBCore.editplugins[/font]
[font="helvetica, sans-serif;"]run the 'blackbox editor' on plugins.rc[/font]
[font="helvetica, sans-serif;"]@BBCore.editextensions[/font]
[font="helvetica, sans-serif;"]run the 'blackbox editor' on extensions.rc[/font]
[font="helvetica, sans-serif;"]@BBCore.editblackbox[/font]
[font="helvetica, sans-serif;"]run the 'blackbox editor' on blackbox.rc[/font]
[font="helvetica, sans-serif;"]@BBCore.edit <file>[/font]
[font="helvetica, sans-serif;"]run the 'blackbox editor' on the specified file[/font]
[font="arial, sans-serif;"]The 'blackbox editor' is specified in extensions.rc.[/font]
[font="helvetica, sans-serif;"]Shutdown[/font]
[font="helvetica, sans-serif;"]@BBCore.shutdown [-q][/font]
[font="helvetica, sans-serif;"]shutdown the computer. -q(uiet) = no confirmation.[/font]
[font="helvetica, sans-serif;"]@BBCore.reboot [-q][/font]
[font="helvetica, sans-serif;"]reboot the computer[/font]
[font="helvetica, sans-serif;"]@BBCore.logoff [-q][/font]
[font="helvetica, sans-serif;"]logoff[/font]
[font="helvetica, sans-serif;"]@BBCore.hibernate [-q][/font]
[font="helvetica, sans-serif;"]hibernate[/font]
[font="helvetica, sans-serif;"]@BBCore.suspend [-q][/font]
[font="helvetica, sans-serif;"]suspend the computer[/font]
[font="helvetica, sans-serif;"]@BBCore.lockworkstation[/font]
[font="helvetica, sans-serif;"]lock workstation[/font]
[font="helvetica, sans-serif;"]@BBCore.switchuser[/font]
[font="helvetica, sans-serif;"]fast user switch[/font]
[font="helvetica, sans-serif;"]@BBCore.exitwindows[/font]
[font="helvetica, sans-serif;"]display standard shutdown dialog[/font]
[font="helvetica, sans-serif;"]Other[/font]
[font="helvetica, sans-serif;"]@BBCore.exec <command>[/font]
[font="helvetica, sans-serif;"]execute command[/font]
[font="helvetica, sans-serif;"]@BBCore.style <stylefile>[/font]
[font="helvetica, sans-serif;"]apply the specified style[/font]
[font="helvetica, sans-serif;"]@BBCore.rootCommand <command>[/font]
[font="helvetica, sans-serif;"]set wallpaper, command is any line, 'style' or 'none'.[/font]
[font="helvetica, sans-serif;"]@BBCore.run[/font]
[font="helvetica, sans-serif;"]display the windows 'run' dialog[/font]
[font="helvetica, sans-serif;"]@BBCore.message <message>[/font]
[font="helvetica, sans-serif;"]popup a message box for confirmation[/font]
[font="helvetica, sans-serif;"]@BBCore.label <message>[/font]
[font="helvetica, sans-serif;"]display message on the toolbar label for 2 seconds[/font]
[font="helvetica, sans-serif;"]@BBCore.pause #n[/font]
[font="helvetica, sans-serif;"]pause for #n milliseconds[/font]
[font="helvetica, sans-serif;"]@BBCore.nop[/font]
[font="helvetica, sans-serif;"]do nothing[/font]
[font="helvetica, sans-serif;"]@BBCore.post <command>[/font]
[font="helvetica, sans-serif;"]execute command slightly later. Useful to unload a plugin from itself.[/font]
[font="helvetica, sans-serif;"]@BBCore.showAppnames[/font]
[font="helvetica, sans-serif;"]display module information of running tasks.[/font]
[font="helvetica, sans-serif;"]@BBCore.showRecoverMenu[/font]
[font="helvetica, sans-serif;"]display a menu that can be used to recover hidden windows after a crash while alternate workspace method was enabled. [/font][font="helvetica, sans-serif;"]Use with care.[/font]
[font="helvetica, sans-serif;"]Configuration[/font]
[font="helvetica, sans-serif;"]@BBCfg.plugin.load <plugin>[/font]
[font="helvetica, sans-serif;"]load/unload a plugin[/font]
[font="helvetica, sans-serif;"]@BBCfg.plugin.inslit <plugin>[/font]
[font="helvetica, sans-serif;"]toggle slit mode for plugin[/font]
[font="helvetica, sans-serif;"]@BBCfg.plugin.add <pathToPlugin>[/font]
[font="helvetica, sans-serif;"]add a plugin to the list and load it[/font]
[font="arial, sans-serif;"]Any '@BBCfg...' command that toggles a setting, can have an optional argument 'true' or 'false' to specify the new state. For example to unload bbLeanBar if loaded and do nothing otherwise:[/font]
[font="'lucida console';"]@BBCfg.plugin.load bbLeanBar false[/font]
[font="arial, sans-serif;"]Use the[/font] [font="arial, sans-serif;"]Show Bro@ms[/font] [font="arial, sans-serif;"]option in Configuration->Menus to view other broadcast messages for core configuration and plugins[/font]