| | 25 | |
| | 26 | """ |
| | 27 | sx-bookmarks is a simple plugin for bookmarking windows. You can |
| | 28 | assign ("set") a unique "bookmark key" to the currently focused |
| | 29 | window to easily jump back to this window at any time (i.e. |
| | 30 | "activate the bookmark"). You can assign multiple bookmarks to one window. |
| | 31 | |
| | 32 | Example: You focus a window, press ``Meta+b e`` ... and at any time |
| | 33 | you want to, you can press ``Meta+g e`` to jump to the window's desktop |
| | 34 | and focus it. |
| | 35 | |
| | 36 | sx-bookmarks doesn't have dependencies and isn't configurable. |
| | 37 | |
| | 38 | Actions |
| | 39 | ------- |
| | 40 | |
| | 41 | .. function:: bookmarks.set(name) |
| | 42 | :module: |
| | 43 | |
| | 44 | Associate the bookmark *name* to the currently focused window. |
| | 45 | |
| | 46 | .. function:: bookmarks.set_key() |
| | 47 | :module: |
| | 48 | |
| | 49 | Grab the keyboard, wait for the user pressing an arbitrary key |
| | 50 | and assign that key to the currently focused window. |
| | 51 | |
| | 52 | .. function:: bookmarks.activate(name) |
| | 53 | :module: |
| | 54 | |
| | 55 | Activate the bookmark *name*. If needed, jump to another desktop. |
| | 56 | If there is no such bookmark, print a warning to the log. |
| | 57 | |
| | 58 | .. function:: bookmarks.activate_key() |
| | 59 | :module: |
| | 60 | |
| | 61 | Grab the keyboard, wait for the user pressing an arbitrary key |
| | 62 | and pass that key to :func:`bookmarks.activate` as bookmark name. |
| | 63 | |
| | 64 | Example |
| | 65 | ------- |
| | 66 | |
| | 67 | A typical configuration for sx-bookmarks would look like that:: |
| | 68 | |
| | 69 | 'bind.keys': { |
| | 70 | 'meta+b': 'bookmarks.set_key', |
| | 71 | 'meta+g': 'bookmarks.activate_key' |
| | 72 | } |
| | 73 | |
| | 74 | """ |
