Skip to content

Commit

Permalink
Added a FAQ document.
Browse files Browse the repository at this point in the history
  • Loading branch information
sedwards2009 committed Mar 16, 2016
1 parent 8e6bcdd commit 6dccfb5
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,12 @@ Download
Release downloads can be found on the [Releases Page](https://github.com/sedwards2009/extraterm/releases). Installation and instructions are in the [guide is here](docs/guide.md).


FAQ
---
The [FAQ is here](docs/faq.md).


Development & Contributing
--------------------------

Extraterm is an open source project and welcomes contributors. More information about [development is here](docs/development.md).

26 changes: 26 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
FAQ
===

How can I use Extraterm's shell integration over ssh?
-----------------------------------------------------

To use Extraterm's shell integration across `ssh` two things have to be set up:

* Just like on your local machine the script from the extraterm-commands zip needs to be read in on the remote machine.
* The `EXTRATERM_COOKIE` environment variable needs to be set on the remote end.

First, before you run `ssh`, print the value of the `EXTRATERM_COOKIE` environment variable.
```
echo $EXTRATERM_COOKIE
```
Now, run `ssh` to go to your remote machine. Set the `EXTRATERM_COOKIE` environment variable to the value which was just displayed before.

For bash and zshell that is:
```
EXTRATERM_COOKIE=<value goes here>
```
Fish uses:
```
set -x EXTRATERM_COOKIE <value goes here>
```
Hopefully this will be made easier in the future.

0 comments on commit 6dccfb5

Please sign in to comment.