summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.md b/README.md
index aad1da0..c19f5b4 100644
--- a/README.md
+++ b/README.md
@@ -6,12 +6,13 @@ standard `netcat(1)`.
You start the server using:
- $ ./gosher [<PORT> [<GOPHERDIR>]
+ $ ./gosher [<GOPHERDIR> [<HOSTNAME> [<PORT>]]]
-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 netcat?" below).
+If HOSTNAME is not provided, it will be set to "localhost". 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
+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,
@@ -59,8 +60,8 @@ run `gosher` under `chroot(8)` be sure to have the following binaries (and
the corresponding libs) available in the chroot-ed environment:
```
- basename(1) cat(1) cut(1) dirname(1) mkfifo(1) netcat(1) realpath(1)
- rm(1) sed(1) sh(1) which(1)
+ basename(1) cat(1) cut(1) date(1) dirname(1) mkfifo(1) netcat(1)
+ realpath(1) rm(1) sed(1) sh(1) which(1)
```
Obviously, `netcat(1)` will be your preferred `netcat(1)` implementation.