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

Add syntax highlighting #67

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
44 changes: 31 additions & 13 deletions README.mdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,49 +2,67 @@

If you wish to activate TextMate from an ssh session you can do so by copying the `rmate` (ruby) script to the server you are logged into. The script will connect back to TextMate running on your Mac so you should setup an ssh tunnel (as your Mac is likely behind NAT):

ssh -R 52698:localhost:52698 [email protected]
```sh
ssh -R 52698:localhost:52698 [email protected]
```

This can be made permanent by adding a section to your `~/.ssh/config` file

Host <host>
RemoteForward 52698 localhost:52698
```ssh-config
Host <host>
RemoteForward 52698 localhost:52698
```

or, if using unix sockets (available with OpenSSH v6.7 and above):

ssh -R /home/user/.rmate.socket:localhost:52698 [email protected]
```sh
ssh -R /home/user/.rmate.socket:localhost:52698 [email protected]
```

# Install

## Rubygems

You can install `rmate` via `gem`:

gem install rmate
```sh
gem install rmate
```

Updating to latest version can be done using:

gem update rmate
```sh
gem update rmate
```

## Standalone

Installing into `~/bin` can be done using these two lines:

curl -Lo ~/bin/rmate https://raw.githubusercontent.com/textmate/rmate/master/bin/rmate
chmod a+x ~/bin/rmate
```sh
curl -Lo ~/bin/rmate https://raw.githubusercontent.com/textmate/rmate/master/bin/rmate
chmod a+x ~/bin/rmate
```

If `~/bin` is not already in your `PATH` then you may want to add something like this to your shell startup file (e.g. `~/.profile`):

export PATH="$PATH:$HOME/bin"
```sh
export PATH="$PATH:$HOME/bin"
```

# Usage

rmate [options] file
```sh
rmate [options] file
```

Call `rmate --help` for a list of options. Default options can be set in `/etc/rmate.rc` or `~/.rmate.rc`, e.g.:

host: auto # Prefer host from SSH_CONNECTION over localhost
port: 52698
unixsocket: ~/.rmate.socket # Use this socket file if it exists
```
host: auto # Prefer host from SSH_CONNECTION over localhost
port: 52698
unixsocket: ~/.rmate.socket # Use this socket file if it exists
```

You can also set the `RMATE_HOST`, `RMATE_PORT` and `RMATE_UNIXSOCKET` environment variables.

Expand Down