summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKatolaZ <katolaz@freaknet.org>2018-07-19 16:14:28 +0100
committerKatolaZ <katolaz@freaknet.org>2018-07-19 16:14:28 +0100
commitc6cdec9c576439cea1a625947d1fa24270c06ebb (patch)
treed352454b8d8b26df4a68df341b2034723e065199 /README.md
parent464cedb474557f28b467164ae08bcb04a2d41ab3 (diff)
some more details in README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 22 insertions, 19 deletions
diff --git a/README.md b/README.md
index 8b57ae0..2518c6e 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ You start the server using:
If PORT is not specified, it will bind on port 70. If GOPHERDIR is not
provided, it defaults to "./". Before starting `gosher` you might need
to modify the values of the variables `NETCAT` and `STYLE` in `gosher`
-(see "Which netca?" below).
+(see "Which netcat?" below).
If the selector is a directory, `gosher` will look for a file named
`gophermap` to render the submenu. If a `gophermap` does not exist,
@@ -26,24 +26,27 @@ set of options. For the sake of using `gosher`, the main issue is
whether your `netcat` implementation does exit or not when its standard
input gets closed. Notably, the original `netcat` implementation by
hobbit@avian.org does **not** exit, while other common implementations
-(OpenBSD `netcat`, `ncat` from the nmap project, and GNU `netcat`). The
-current version of `gosher` can work with different implementations of
-`netcat`, provided that the variable `NETCAT` points to the `netcat`
-version you want to use, and that the variable `STYLE` in `gosher` is set
-correctly. Please check below what is the recommended combination for
-your version of `netcat`:
-
- +----------------+--------+
- | netcat version | STYLE |
- +----------------+--------+
- | traditional | 'fork' |
- +----------------+--------+
- | OpenBSD | 'pipe' |
- +----------------+--------+
- | ncat | 'pipe' |
- +----------------+--------+
-
-
+(OpenBSD `netcat`, `ncat` from the nmap project, and GNU `netcat`)
+normally do. The current version of `gosher` can work with different
+implementations of `netcat`, provided that the variable `NETCAT` points
+to the `netcat` version you want to use, and that the variable `STYLE`
+in `gosher` is set correctly. In particular, `STYLE` can pe set equal to
+either 'pipe' or 'fork'. Please check below what is the recommended
+combination for your version of `netcat`:
+
+ +----------------+--------------+--------------+
+ | netcat version | STYLE='fork' | STYLE='pipe' |
+ +----------------+--------------+--------------+
+ | traditional | YES | NO |
+ +----------------+--------------+--------------+
+ | OpenBSD | NO | YES |
+ +----------------+--------------+--------------+
+ | ncat | YES | YES |
+ +----------------+--------------+--------------+
+
+**N.B.: Using STYLE='pipe' is preferable, since the '-c' option used by
+the 'fork' mode is a potential security risk**
+
## Why `gosher`?
Just for fun. There are only a few TCP/IP application protocols left