|
2 | 2 |
|
3 | 3 | ## Client |
4 | 4 |
|
5 | | -TODO... |
| 5 | +Start the server from jar or native executable: |
6 | 6 |
|
| 7 | +```sh |
| 8 | +java [options] -jar org.eclipse.lemminx.jar |
| 9 | +# or |
| 10 | +org.eclipse.lemminx [options] |
7 | 11 | ``` |
8 | | - java -classpath ... org.eclipse.lsp4xml.XMLServerLauncher |
| 12 | + |
| 13 | +### Environment Variables |
| 14 | + |
| 15 | +Environment variables can be used to configure the server. For example: |
| 16 | + |
| 17 | +```sh |
| 18 | +export HTTP_PROXY_HOST=localhost |
| 19 | +java -jar org.eclipse.lemminx.jar |
| 20 | +# or |
| 21 | +$env:HTTP_PROXY_HOST=localhost |
| 22 | +org.eclipse.lemminx.exe -Djdk.xml.maxOccur=20000 |
9 | 23 | ``` |
10 | 24 |
|
11 | | -## Existing Implementations |
| 25 | +* `$HTTP_PROXY_HOST`: The hostname of the HTTP proxy server. |
| 26 | +* `$HTTP_PROXY_PASSWORD`: The password to use for the HTTP proxy. |
| 27 | +* `$HTTP_PROXY_PORT`: The port number of the HTTP proxy server. |
| 28 | +* `$HTTP_PROXY_USER`: The user name to use for the HTTP proxy. |
| 29 | +* `$LEMMINX_DEBUG`: Enable debug logging for Lemminx. |
12 | 30 |
|
13 | | -To see how current implementations of this language server send configurations, |
14 | | -refer to [VSCode XML](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-xml). |
| 31 | +### System Properties |
| 32 | + |
| 33 | +System properties are options start with `-D`. For example: |
| 34 | + |
| 35 | +```sh |
| 36 | +java -Djdk.xml.maxOccur=20000 -jar org.eclipse.lemminx.jar |
| 37 | +# or |
| 38 | +org.eclipse.lemminx -Djdk.xml.maxOccur=20000 |
| 39 | +``` |
15 | 40 |
|
16 | | -1. Go to preferences and set `xml.trace.server` to `verbose` |
17 | | -2. With an XML file open, go to View -> Output -> XML Support (top right drop down menu) |
18 | | -3. Ctrl + f, and search for 'workspace/didChangeConfiguration' |
| 41 | +* `-Dhttp.proxyPassword=<string>`: The password to use for the HTTP proxy. Defaults from environment variable `HTTP_PROXY_PASSWORD`. |
| 42 | +* `-Dhttp.proxyUser=<string>`: The user name to use for the HTTP proxy. Defaults from environment variable `HTTP_PROXY_USER`. |
| 43 | +* `-Djava.home=<string>`: The Java installation directory. |
| 44 | +* `-Djava.runtime.name=<string>`: The name of the Java Runtime Environment. |
| 45 | +* `-Djava.vm.name=<string>`: The name of the Java Virtual Machine. |
| 46 | +* `-Djava.version=<string>`: The version of the Java Runtime Environment. |
| 47 | +* `-Djdk.xml.entityExpansionLimit=<integer>`: The maximum number of XML entities to expand. Defaults to `64000`. |
| 48 | +* `-Djdk.xml.maxOccur=<integer>`: The maximum number of XML elements to occur. Defaults to `5000`. |
| 49 | +* `-Dlemminx.workdir=<string>`: The working directory for Lemminx. Defaults to `{-Duser.home}/.lemminx`, `{-Duser.dir}/.lemminx` or `{$PWD}/.lemminx`. |
| 50 | +* `-Dlog.level=<all|info|warn|error|off>`: The logging level. Defaults to `info`. |
| 51 | +* `-Dos.arch=<string>`: The operating system architecture. |
| 52 | +* `-Dos.name=<string>`: The operating system name. |
| 53 | +* `-Dos.version=<string>`: The operating system version. |
| 54 | +* `-Duser.dir=<string>`: The user directory. |
| 55 | +* `-Duser.home=<string>`: The user home directory. |
| 56 | +* `-DwatchParentProcess=<boolean>`: Whether to watch the parent process for termination. Defaults to `true`. |
19 | 57 |
|
20 | 58 | ## Settings |
21 | 59 |
|
|
0 commit comments