some more details in README.md

master
KatolaZ 6 years ago
parent 464cedb474
commit c6cdec9c57
  1. 39
      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,23 +26,26 @@ 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`?

Loading…
Cancel
Save