awesomewm-mirrors
/
awesome-viewport
mirror of https://github.com/jcrd/awesome-viewport.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
AwesomeWM library for managing tags based on viewports
11 Commits 4 Branches 1 Tag 67 KiB
Lua 90.2%
Makefile 9.8%
Go to file
James Reed 103cdd73a8
Makefile: Add target to serve gh-pages with python 		2020-08-05 14:47:31 -06:00
rockspec Initial commit 2019-09-16 11:55:41 -06:00
.gitignore Add .gitignore 2020-08-05 14:37:40 -06:00
Dockerfile.toolbox Add toolbox Dockerfile 2020-08-05 14:37:46 -06:00
LICENSE Initial commit 2019-09-16 11:55:41 -06:00
Makefile Makefile: Add target to serve gh-pages with python 2020-08-05 14:47:31 -06:00
README.md README: Change example usage to awesome v4.3 API 2019-10-03 16:30:55 -06:00
config.ld Initial commit 2019-09-16 11:55:41 -06:00
init.lua Fix use of old function name 2019-10-23 12:26:44 -06:00

README.md

awesome-viewport

awesome-viewport is a library for Awesome window manager that manages tags based on viewports.

Installation

$ git clone https://github.com/jcrd/awesome-viewport.git
$ cd awesome-viewport
$ luarocks make --local rockspec/awesome-viewport-devel-1.rockspec

Usage

Require the library:

local viewport = require("awesome-viewport")

Connect to a screen to begin managing its tags:

awful.screen.connect_for_each_screen(function (s)
      viewport.connect(s)
  end)

View a single tag:

tag1:view_only()

This tag will be the new viewport.

Get the viewport for the focused screen:

viewport()

Toggle another tag into view:

awful.tag.viewtoggle(tag2)

tag1 will remember that tag2 is toggled while its the viewport, so that if the viewport changes and tag1 is re-viewed, tag2 will also be toggled into view.

See the API documentation for descriptions of all functions.

License

awesome-viewport is licensed under the GNU General Public License v3.0 or later (see LICENSE).