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.

Sign up for GitHub

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

Jump to bottom

Update documentation to reflect --stdio flag deprecation (#2439) #2554

Merged
merged 2 commits into from
Aug 1, 2023
Merged

Update documentation to reflect --stdio flag deprecation (#2439) #2554

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0a52ee
Update documentation to reflect --stdio flag deprecation (#2439)
MykolaBalakin Jul 28, 2023
9df0287
Merge branch 'master' into fix/2439-remove-stdio-flag-documentation
JoeRobich Jul 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/Using-Omnisharp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ OnmiSharp requires a fully functioning .NET Core SDK installed and available fro
This document is a rough overview of how to interact with OmniSharp, and what the various features are.

## Interfaces
OmniSharp supports several interfaces over the command line.
OmniSharp supports several interfaces over the command line. Depending on the interface, you need to use the corresponding package (see [Downloading OmniSharp](https://github.com/OmniSharp/omnisharp-roslyn/blob/master/README.md#downloading-omnisharp) for more info).

1. Http
1. Http (using the `omnisharp.http` package)
The http interface allows you to start up the server and communicate with it over HTTP. This interface is pull based, so the server has no way to push information to the client. The client may listen to the `Stdout` stream for logging information from the server.

You may specify the port for http using the `-p <port>` flag.
2. Stdio (using the flag `--stdio`)
2. Stdio (using the `omnisharp` package)
Stdio uses the standard process interfaces. The server will read `Stdin` for requests, and pipe responses back out over `Stdout`. Each line on either interface is a single request / response. With this interface, the server can have a two-way relationship with the server, such that the server can intelligently provide information for the client to consume. This can be anything from Diagnostics, to new references, package restores, and so on.

OmniSharp.exe --stdio
You may specify the encoding for `Stdin` and `Stdout` streams using `-e <encoding>` flag.

## Solutions
When starting the server you must specify a solution file, or a directory where OmniSharp will find a solution.
Expand Down