mirror of
https://github.com/xvxx/phd
synced 2024-11-10 13:10:23 +00:00
usage example
This commit is contained in:
parent
3490387bc1
commit
ad223c454a
25
README.md
25
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] <directory>
|
||||
|
||||
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] <root directory>
|
||||
|
||||
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
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user