aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSyphdias <syphdias+git@gmail.com>2022-10-31 12:18:12 +0100
committerSyphdias <syphdias+git@gmail.com>2022-10-31 12:18:12 +0100
commit75b309c99502492b2409597a14bf3472ef4c3ff3 (patch)
tree6ebcc3be9a742e222e1c938595ab70ee8d399b39
parentef9815dac7225659a1b2fdb3f0f69534c52e10c2 (diff)
downloadautotiling-75b309c99502492b2409597a14bf3472ef4c3ff3.tar.gz
Add information about --limit
The help and README did not go into details what exactly the --limit option does. Since it can be used to imitate a master-stack layout, and can enable tabbed or stacking layouts to some degree, this adds the explanation in the section talking about this limitation. It softens the limitations of autotiling while still stressing that tabbed and stacked layouts may behave unexpectedly and are not supported by autotiling.
-rw-r--r--README.md27
-rw-r--r--autotiling/main.py3
2 files changed, 22 insertions, 8 deletions
diff --git a/README.md b/README.md
index 14375b7..9325ed1 100644
--- a/README.md
+++ b/README.md
@@ -12,18 +12,28 @@ action](https://img.youtube.com/vi/UWRZuhn92bQ/0.jpg)](https://www.youtube.com/w
## PLEASE DO READ THIS
-The script does one thing: it checks the window height / width ratio, and executes
-the equivalent of either `swaymsg splitv` or `swaymsg splith`. Nothing less, nothing more. Yes, it may make
-stacking and tabbed layouts behave oddly. No, nothing can be done about it. If you like stacking/tabbed layouts,
-you may use them on workspaces with autotiling turned off (`--workspaces` argument). Do not submit issues about it.
+The script does one thing: it checks the window height / width ratio, and
+executes the equivalent of either `swaymsg splitv` or `swaymsg splith`. Nothing
+less, nothing more. This may make stack and tabbed layouts behave oddly.
+Unfortunately, there is nothing that can be done about it – please, do not
+submit issues about it –, but there are two workaround that you can try.
-For instance, you may configure autotiling to work on odd workspaces, but not on even:
+One option is, to enable autotiling on certain workspaces only. For instance,
+you could configure autotiling to be enabled on odd workspaces, but not on
+even ones:
```text
### Autostart
- exec autotiling -w 1 3 5 7 9
+ exec_always autotiling -w 1 3 5 7 9
```
+Another option you can try, is setting `--limit` and only use stacking or
+tabbing on the lowest level. A good place to start would be `--limit 2`. Open
+four windows with the third and fourth window in the same container as two. This
+might mimic a master-stack layout and you should now be able to switch to
+stacking or tabbed. Beware that the decision on how to split is still based on
+the height / width ratio.
+
## Installation
The script has been packaged for the following distributions:
@@ -54,6 +64,9 @@ optional arguments:
-w [WORKSPACES ...], --workspaces [WORKSPACES ...]
restricts autotiling to certain workspaces; example: autotiling --workspaces 8
9
+ -l LIMIT, --limit LIMIT
+ limit how often autotiling will split a container; try "2", if you like
+ master-stack layouts; default: 0 (no limit)
-e [EVENTS ...], --events [EVENTS ...]
list of events to trigger switching split orientation; default: WINDOW MODE
```
@@ -64,4 +77,4 @@ Changing event subscription has already been the objective of several pull reque
starting from v1.6 you may specify them in the `-e` | `--events` argument. If no value given, the script will subscribe
to `Event.WINDOW` and `Event.MODE`, as if it was executed with `autotiling -e WINDOW MODE`. See
[altdesktop/i3ipc-python`](https://github.com/altdesktop/i3ipc-python/blob/a670f24e7e04f509de8161cf760afe929c22ae93/i3ipc/events.py#L12)
-for event enumeration. \ No newline at end of file
+for event enumeration.
diff --git a/autotiling/main.py b/autotiling/main.py
index 941863b..38f236c 100644
--- a/autotiling/main.py
+++ b/autotiling/main.py
@@ -128,7 +128,8 @@ def main():
default=[], )
parser.add_argument("-l",
"--limit",
- help="limit how often autotiling will split a container; default: 0 (no limit)",
+ help='limit how often autotiling will split a container; '
+ 'try "2", if you like master-stack layouts; default: 0 (no limit)',
type=int,
default=0, )
"""