Skip to content

Commit bca3f9e

Browse files
authored
Add code color highlighting to the README (#649)
* Add code color highlighting to the README And fix some typos. * Update README.md
1 parent 120b8cb commit bca3f9e

File tree

1 file changed

+43
-37
lines changed

1 file changed

+43
-37
lines changed

README.md

Lines changed: 43 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ status](https://repology.org/badge/vertical-allrepos/eternalterminal.svg)](https
2121

2222
The easiest way to install is using Homebrew:
2323

24-
```
24+
```bash
2525
brew install MisterTea/et/et
2626
```
2727

@@ -31,29 +31,29 @@ Then if you want a daemon to launch `etserver` on every boot:
3131

3232
On m1 (Apple Silicon) Macs:
3333

34-
```
34+
```bash
3535
sudo sed 's:/usr/local/bin/etserver:/opt/homebrew/bin/etserver:g' ../init/launchd/homebrew.mxcl.et.plist | sudo tee /Library/LaunchDaemons/homebrew.mxcl.et.plist
3636
sudo launchctl load -w /Library/LaunchDaemons/homebrew.mxcl.et.plist
3737
```
3838

3939
On x86 Macs:
4040

41-
```
41+
```bash
4242
sudo cp ../init/launchd/homebrew.mxcl.et.plist /Library/LaunchDaemons/homebrew.mxcl.et.plist
4343
sudo launchctl load -w /Library/LaunchDaemons/homebrew.mxcl.et.plist
4444
```
4545

4646
Alternatively, a package is available in MacPorts:
4747

48-
```
48+
```bash
4949
sudo port install et
5050
```
5151

5252
### Ubuntu
5353

5454
For Ubuntu, use our PPA:
5555

56-
```
56+
```bash
5757
sudo add-apt-repository ppa:jgmath2000/et
5858
sudo apt-get update
5959
sudo apt-get install et
@@ -65,7 +65,7 @@ Or see "Debian/Ubuntu" below to install and build from source (e.g., for ARM).
6565

6666
For Debian, use our deb repo:
6767

68-
```
68+
```bash
6969
echo "deb [signed-by=/etc/apt/keyrings/et.gpg] https://mistertea.github.io/debian-et/debian-source/ $(grep VERSION_CODENAME /etc/os-release | cut -d= -f2) main" | sudo tee -a /etc/apt/sources.list.d/et.list
7070
sudo mkdir -m 0755 -p /etc/apt/keyrings # only if you're using Debian 11 or older
7171
curl -sSL https://github.com/MisterTea/debian-et/raw/master/et.gpg | sudo tee /etc/apt/keyrings/et.gpg >/dev/null
@@ -79,7 +79,7 @@ Up to the present day the only way to install is to [build from source](#centos-
7979

8080
### CentOS 8
8181

82-
```
82+
```bash
8383
sudo dnf install epel-release
8484
sudo dnf install et
8585
```
@@ -88,19 +88,19 @@ sudo dnf install et
8888

8989
On FreeBSD, use:
9090

91-
```
91+
```bash
9292
pkg install eternalterminal
9393
```
9494

9595
### Fedora (version 29 and later):
9696

97-
```
97+
```bash
9898
sudo dnf install et
9999
```
100100

101101
### openSUSE
102102

103-
```
103+
```bash
104104
zypper ar -f obs://network
105105
zypper ref
106106
zypper in EternalTerminal
@@ -112,21 +112,21 @@ Install dependencies:
112112

113113
- Fedora (tested on 25):
114114

115-
```
115+
```bash
116116
sudo dnf install boost-devel libsodium-devel protobuf-devel \
117117
protobuf-compiler cmake gflags-devel libcurl-devel
118118
```
119119

120120
- Gentoo:
121121

122-
```
122+
```bash
123123
sudo emerge dev-libs/boost dev-libs/libsodium \
124124
dev-libs/protobuf dev-util/cmake dev-cpp/gflags
125125
```
126126

127127
Download and install from source:
128128

129-
```
129+
```bash
130130
git clone --recurse-submodules --depth 1 https://github.com/MisterTea/EternalTerminal.git
131131
cd EternalTerminal
132132
mkdir build
@@ -162,31 +162,32 @@ ET uses ssh for handshaking and encryption, so you must be able to ssh into the
162162

163163
ET uses TCP, so you need an open port on your server. By default, it uses 2022.
164164

165-
Once you have an open port, the syntax is similar to ssh. Username is default to the current username starting the et process, use `-u` or `user@` to specify a different if necessary.
166165

167-
```
166+
Once you have an open port, the syntax is similar to ssh. Username is default to the current username starting the et process, use `-u` or `user@` to specify a different one if necessary.
167+
168+
```bash
168169
et hostname (etserver running on default port 2022, username is the same as current)
169170
et user@hostname:8000 (etserver running on port 8000, different user)
170171
```
171172

172173
You can specify a jumphost and the port et is running on jumphost using `--jumphost` and `--jport`. If no `--jport` is given, et will try to connect to default port 2022.
173174

174-
```
175+
```bash
175176
et hostname -jumphost jump_hostname (etserver running on port 2022 on both hostname and jumphost)
176177
et hostname:8888 --jumphost jump_hostname --jport 9999
177178
```
178179

179-
Additional arguments that et accept are port forwarding pairs with option `-t "18000:8000, 18001-18003:8001-8003"`, a command to run immediately after the connection is setup through `-c`.
180+
Additional arguments that et accepts are port forwarding pairs with option `-t "18000:8000, 18001-18003:8001-8003"`, a command to run immediately after the connection is setup through `-c`.
180181

181-
Starting from the latest release, et supports parsing both user-specific and system-wide ssh config file.
182+
Starting from the latest release, et supports parsing both user-specific and system-wide SSH config files.
182183
The config file is required when your sshd on server/jumphost is listening on a port which is not 22.
183-
Here is an example ssh config file showing how to setup when
184+
Here is an example SSH config file showing how to setup when
184185

185186
- there is a jumphost in the middle
186-
- sshd is listening on a port which is not 22
187-
- connecting to a different username other than current one.
187+
- sshd is listening on a port that is not 22
188+
- connecting to a different username other than the current one.
188189

189-
```
190+
```ssh-config
190191
Host dev
191192
HostName 192.168.1.1
192193
User fred
@@ -196,7 +197,7 @@ Host dev
196197

197198
With the ssh config file set as above, you can simply call et with
198199

199-
```
200+
```bash
200201
et dev (etserver running on port 2022 on both hostname and jumphost)
201202
et dev:8000 -jport 9000 (etserver running on port 9000 on jumphost)
202203
```
@@ -207,7 +208,7 @@ et dev:8000 -jport 9000 (etserver running on port 9000 on jumphost)
207208

208209
To build Eternal Terminal on Mac, the easiest way is to grab dependencies with Homebrew:
209210

210-
```
211+
```bash
211212
brew install autoconf automake libtool
212213
git clone --recurse-submodules --depth 1 https://github.com/MisterTea/EternalTerminal.git
213214
cd EternalTerminal
@@ -220,7 +221,7 @@ make -j$(nproc) && sudo make install
220221
To run an `et` server for testing, run `./etserver`. To run an `et`
221222
server daemon persistently across reboots:
222223

223-
```
224+
```bash
224225
sudo cp ../init/launchd/homebrew.mxcl.et.plist /Library/LaunchDaemons
225226
sudo launchctl load -w /Library/LaunchDaemons/homebrew.mxcl.et.plist
226227
```
@@ -231,15 +232,15 @@ Grab the deps and then follow this process.
231232

232233
Debian/Ubuntu Dependencies:
233234

234-
```
235+
```bash
235236
sudo apt install libsodium-dev autoconf libtool \
236237
libprotobuf-dev protobuf-compiler libutempter-dev libcurl4-openssl-dev \
237238
build-essential ninja-build cmake git zip pkg-config
238239
```
239240

240241
Fetch source, build and install:
241242

242-
```
243+
```bash
243244
git clone --recurse-submodules --depth 1 https://github.com/MisterTea/EternalTerminal.git
244245
cd EternalTerminal
245246
mkdir build
@@ -259,7 +260,7 @@ Disable et server by `sudo systemctl disable --now et`
259260

260261
Install dependencies:
261262

262-
```
263+
```bash
263264
sudo yum install epel-release
264265
sudo yum install cmake3 boost-devel libsodium-devel protobuf-devel \
265266
protobuf-compiler gflags-devel protobuf-lite-devel libcurl-devel \
@@ -268,14 +269,14 @@ sudo yum install cmake3 boost-devel libsodium-devel protobuf-devel \
268269

269270
Install scl dependencies
270271

271-
```
272+
```bash
272273
sudo yum install centos-release-scl
273274
sudo yum install devtoolset-11 devtoolset-11-libatomic-devel rh-git227
274275
```
275276

276277
Download and install from source ([see #238 for details](https://github.com/MisterTea/EternalTerminal/issues/238)):
277278

278-
```
279+
```bash
279280
git clone --recurse-submodules --depth 1 https://github.com/MisterTea/EternalTerminal.git
280281
cd EternalTerminal
281282
mkdir build
@@ -288,27 +289,32 @@ sudo cp ../etc/et.cfg /etc/
288289

289290
Find the actual location of et:
290291

291-
which etserver
292+
```bash
293+
which etserver
294+
```
292295

293296
Correct the service file (see [#180](https://github.com/MisterTea/EternalTerminal/issues/180) for details).
294297

295-
```
298+
```bash
296299
sudo sed -ie "s|ExecStart=[^[:space:]]*[[:space:]]|ExecStart=$(which etserver) |" /etc/systemd/system/et.service
297300
```
298301

299-
Alternativelly, open the file /etc/systemd/system/et.service in an editor and correct the `ExectStart=...` line to point to the correct path of the `etserver` binary.
302+
Alternatively, open the file /etc/systemd/system/et.service in an editor and correct the `ExectStart=...` line to point to the correct path of the `etserver` binary.
303+
300304

301-
ExecStart=/usr/local/bin/etserver --cfgfile=/etc/et.cfg
305+
```
306+
ExecStart=/usr/local/bin/etserver --cfgfile=/etc/et.cfg
307+
```
302308

303309
Reload systemd configs:
304310

305-
```
311+
```bash
306312
sudo systemctl daemon-reload
307313
```
308314

309315
Start the et service:
310316

311-
```
317+
```bash
312318
sudo systemctl enable --now et.service
313319
```
314320

@@ -318,7 +324,7 @@ Builder Dockerfiles are located at [deployment/](deployment/). Supported OSes: C
318324

319325
## Reporting issues
320326

321-
If you have any problems with installation or usage, please [file an issue on github](https://github.com/MisterTea/EternalTerminal/issues).
327+
If you have any problems with installation or usage, please [file an issue on GitHub](https://github.com/MisterTea/EternalTerminal/issues).
322328

323329
## Developers
324330

0 commit comments

Comments
 (0)