swaywm/sway

create_output is undocumented

rpigott opened this issue · 5 comments

rpigott commented

Headlining the new features for 1.5 is the new create_output command, but it doesn't appear in sway(5).

Steps to reproduce:

$ swaymsg -t get_version
sway version v1.5-e215557b (Jul 16 2020, branch 'master')
$ MANPAGER=less LESS=+/create_output man 5 sway
Pattern not found

:(

rpigott commented

Also could there maybe be a "docs" issue label? Wasn't sure where to file this.

emersion commented

Ooops. It was originally a developer-only feature, so intentionally undocumented. But now that it can be useful to end-users, it should definitely be documented.

  • 👍7
Zocker1999NET commented

Is there somewhere a developer-doc already existing? It could be used as template for the end-user doc and maybe useful for all finding this issue.

For references:

  • Introducing: #2669
  • Implementation of backend: #5216
  • Implementation of command: #5215
  • 👍1
progandy commented

I wonder if it should remain undocumented and the command merged with output, like

output "HL_MY_NAME" create (any name prefixed with HL that does not exist)
output "HL_MY_NAME" destroy
(output "*" create to create a sequential HEADLESS# name)

  • 👍1
  • 👀2
thecoder-001 commented

Just posting it here for anyone else who has stumbled here & wants to get things working without looking at the commits to figure things out:
Someone at reddit posted their setup here along with an example config.

  • 👍2