Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create_output is undocumented #5553

Open
rpigott opened this issue Jul 16, 2020 · 5 comments
Open

create_output is undocumented #5553

rpigott opened this issue Jul 16, 2020 · 5 comments
Labels
docs Errors or omissions in the man pages

Comments

@rpigott
Copy link
Member

rpigott commented Jul 16, 2020

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 rpigott added the bug Not working as intended label Jul 16, 2020
@rpigott
Copy link
Member Author

rpigott commented Jul 16, 2020

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

@emersion
Copy link
Member

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.

@Zocker1999NET
Copy link

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:

@progandy
Copy link
Contributor

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)

@rpigott rpigott added docs Errors or omissions in the man pages and removed bug Not working as intended labels Dec 25, 2020
@thecoder-001
Copy link

thecoder-001 commented Apr 19, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Errors or omissions in the man pages
Development

No branches or pull requests

5 participants