From ad223c454a138a2364b59d30126dae5460aa69c4 Mon Sep 17 00:00:00 2001 From: dvkt Date: Sat, 28 Dec 2019 13:45:47 -0800 Subject: [PATCH] usage example --- README.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b04d8ec..204332c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ `phd` is an esoteric gopher server for small gopherholes. -point it at a directory and it'll serve up all its text files, sub-directories, and binary files over gopher. `any .gph` files will be served up as [gopermaps](https://en.wikipedia.org/wiki/Gopher_(protocol)#Source_code_of_a_menu), and executable `.gph` files will be run as a script with their output served to the client, like cgi! +point it at a directory and it'll serve up all its text files, sub-directories, and binary files over gopher. any `.gph` files will be served up as [gopermaps](https://en.wikipedia.org/wiki/Gopher_(protocol)#Source_code_of_a_menu), and executable `.gph` files will be run as a script with their output served to the client, like cgi! special files: @@ -55,11 +55,26 @@ then: ## usage - phd [options] - phd ./path/to/gopher/root # Serve directory over port 70. - phd -p 7070 docs # Serve 'docs' directory on port 7070 - phd -h localhost # Serve current dir using hostname "localhost". + Usage: + + phd [options] + + Options: + + -p, --port Port to bind to. + -h, --host Hostname to use when generating links. + + Other flags: + + -h, --help Print this screen. + -v, --version Print phd version. + + Examples: + + phd ./path/to/gopher/root # Serve directory over port 70. + phd -p 7070 docs # Serve 'docs' directory on port 7070 + phd -h localhost # Serve current dir using hostname "localhost". ## installation