Adding SendEnv (thanks chris-work)

Steven L 2020-04-23 15:53:24 -04:00
parent 5bd7d47d68
commit 239e6d8e3e

@ -1,10 +1,10 @@
A [new feature](https://github.com/shazow/ssh-chat/pull/333) of `ssh-chat` is the ability to define locally what settings you would like to have in your `ssh-chat` session before connecting. The `ssh-chat` server will interpret your local variables and change settings to match yours accordingly (if they can be matched). A [new feature](https://github.com/shazow/ssh-chat/pull/333) of `ssh-chat` is the ability to define locally what settings you would like to have in your `ssh-chat` session before connecting. The `ssh-chat` server will interpret your local variables and change settings to match yours accordingly (if they can be matched). Variables have to sent with the `SendEnv` flag accordingly.
## `SSHCHAT_THEME` ## `SSHCHAT_THEME`
The simplest variable is the `SSHCHAT_THEME` variable which allows you to define what theme you would like for your session. This can be defined to match any theme defined within `ssh-chat`, so for example to connect using the `solarized` theme, which is normally activated by running `/theme solarized`, you can instead do the following: The simplest variable is the `SSHCHAT_THEME` variable which allows you to define what theme you would like for your session. This can be defined to match any theme defined within `ssh-chat`, so for example to connect using the `solarized` theme, which is normally activated by running `/theme solarized`, you can instead do the following:
```bash ```bash
$ SSHCHAT_THEME=solarized ssh -i my_id_file username@ssh.chat $ SSHCHAT_THEME=solarized ssh -o SendEnv=SSHCHAT_THEME -i my_id_file username@ssh.chat
``` ```
Upon joining, your session's theme will automatically be `solarized`. This works for all themes (`mono`, `colors`, `hacker`, `solarized`, etc). Upon joining, your session's theme will automatically be `solarized`. This works for all themes (`mono`, `colors`, `hacker`, `solarized`, etc).
@ -13,7 +13,7 @@ Upon joining, your session's theme will automatically be `solarized`. This works
`ssh-chat` supports the ability to log messages with a datetime stamp next to each received message. This behavior is enabled by running a `/timestamp` command within the chat. It can be turned on before connecting by doing the following: `ssh-chat` supports the ability to log messages with a datetime stamp next to each received message. This behavior is enabled by running a `/timestamp` command within the chat. It can be turned on before connecting by doing the following:
```bash ```bash
$ SSHCHAT_TIMESTAMP=1 ssh -i my_id_file username@ssh.chat $ SSHCHAT_TIMESTAMP=1 ssh -o SendEnv=SSHCHAT_TIMESTAMP -i my_id_file username@ssh.chat
``` ```
It also supports the ability to pre-load a datetime format as well. It also supports the ability to pre-load a datetime format as well.
@ -24,6 +24,6 @@ The `TERM` variable is meant to enable specific modes of `ssh-chat` which change
To turn on a specific mode, you can run the following: To turn on a specific mode, you can run the following:
```bash ```bash
$ TERM=bot ssh -i my_id_file username@ssh.chat $ TERM=bot ssh -o SendEnv=TERM -i my_id_file username@ssh.chat
``` ```