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

Supported ANSI escapes - authoritative list #138

Closed
parkovski opened this issue Mar 19, 2018 · 5 comments
Closed

Supported ANSI escapes - authoritative list #138

parkovski opened this issue Mar 19, 2018 · 5 comments
Assignees
Labels
Area-VT Virtual Terminal sequence support Help Wanted We encourage anyone to jump in on these. Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs Needs-Tag-Fix Doesn't match tag requirements Product-Meta The product is the management of the products.

Comments

@parkovski
Copy link

I wrote ANSI escape handling for PSReadLine on Windows and it involved a good amount of showkey -a. Currently adding ^[[Z because I know that’s supported now, but I’m not sure if there have been any other changes. Can we either get updated docs with all supported escapes or a terminfo page?

@zadjii-msft
Copy link
Member

Are we talking about as input to a client, or as output from a client application?

There is This MSDN page, but I don't know if I've updated it since Creator's Update.

I can add a backlog item to myself to update that page. We're pretty quickly building up a documentation backlog (cough @bitcrazed )

@zadjii-msft zadjii-msft added the Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs label Mar 19, 2018
@bitcrazed bitcrazed self-assigned this Mar 19, 2018
@parkovski
Copy link
Author

For the purpose of PSReadLine, input is all that matters (what escape does it generate for a given key?), but I imagine other people would be interested in the rest, especially with upcoming PTY support.

I think the main things the list left out were around which keys supported Alt/Shift and their sequences (the F keys, PgUp, etc, but not Delete, for example), can't remember if there was anything else.

@ghost ghost added the Needs-Tag-Fix Doesn't match tag requirements label May 17, 2019
@miniksa miniksa added Area-VT Virtual Terminal sequence support Product-Meta The product is the management of the products. labels May 29, 2019
@ghost ghost removed the Needs-Tag-Fix Doesn't match tag requirements label May 29, 2019
@miniksa miniksa added Help Wanted We encourage anyone to jump in on these. Needs-Tag-Fix Doesn't match tag requirements labels May 29, 2019
@ghost ghost removed the Needs-Tag-Fix Doesn't match tag requirements label May 29, 2019
@miniksa
Copy link
Member

miniksa commented May 29, 2019

Now that the code is opened, I would love to have someone help us update the documentation here.

If someone can help update the documentation and build a beautiful table of what we support based on reading the VT parser/adapter libraries, I can provide assistance by spelunking the history that you all cannot see to find when each sequence showed up as being supported.

@oising
Copy link
Collaborator

oising commented May 29, 2019

I was talking with @Jaykul about this the other day -- building a nice excel style table of support ops. Assign to me and I'll take a crack at it this weekend (I'm nearly done the other issue for install doc - its been a long week for me) -- I need a good excuse to spelunk into the parser, and this sounds like a great starter.

@zadjii-msft
Copy link
Member

Hey so this has been open for some time now. I think we made this a lot better with #1884. We're tracking further updates to these docs in MicrosoftDocs/terminal#350, MicrosoftDocs/Console-Docs#91 and MicrosoftDocs/Console-Docs#243. (some of those should also be de-duped)

Thanks all!

@ghost ghost added the Needs-Tag-Fix Doesn't match tag requirements label Jan 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-VT Virtual Terminal sequence support Help Wanted We encourage anyone to jump in on these. Issue-Docs It's a documentation issue that really should be on MicrosoftDocs/Console-Docs Needs-Tag-Fix Doesn't match tag requirements Product-Meta The product is the management of the products.
Projects
None yet
Development

No branches or pull requests

5 participants