Docs and spelling errors.

This commit is contained in:
Aldo Cortesi 2012-04-29 21:51:03 +12:00
parent 0b347db612
commit cd025636fa

View File

@ -1,27 +1,25 @@
__pathod__ __pathod__ is a pathological HTTP/S daemon, useful for testing and torturing
========== HTTP clients. At __pathod__'s heart is a tiny, terse language for crafting HTTP
responses. The simplest way to use __pathod__ is to fire up the daemon, and
__pathod__ is a pathological HTTP/S daemon, useful for testing and torturing client specify the response behaviour you want using this language in the request URL.
software. At __pathod__'s core is a small, terse language for crafting HTTP Here's a minimal example:
responses. The simplest way to use __pathod__ is to fire up the daemon, and specify
the respnse behaviour you want using this language in the request URL. Here's a
minimal example:
http://localhost:9999/p/200 http://localhost:9999/p/200
Everything below the magic "/p/" path component is a response specifier - in Everything after the "/p/" path component is a response specifier - in this
this case just a vanilla 200 OK response. See the docs below to get (much) case just a vanilla 200 OK response. See the docs below to get (much) fancier.
fancier. You can also add anchors to the __pathod__ server that serve a fixed You can also add anchors to the __pathod__ server that serve a fixed response
response whenever a matching URL is requested: whenever a matching URL is requested:
pathod --anchor "/foo=200" pathod --anchor "/foo=200"
Here, the part before the "=" is a regex specifying the anchor path, and the Here, "/foo" a regex specifying the anchor path, and the part after the "=" is
part after is a response specifier. a response specifier.
__pathod__ also has a nifty built-in web interface, which exposes activity logs, __pathod__ also has a nifty built-in web interface, which lets you play with
online help and various other goodies. Try it by visiting the server root: the language by previewing responses, exposes activity logs, online help and
various other goodies. Try it by visiting the server root:
http://localhost:9999 http://localhost:9999
@ -57,7 +55,7 @@ ASCII letters instead:
Full documentation on the value specification syntax can be found in the next Full documentation on the value specification syntax can be found in the next
section. section.
Following the response code specifier is a colon-separateed list of features. Following the response code specifier is a colon-separated list of features.
For instance, this specifies a response with a body consisting of 1 megabyte of For instance, this specifies a response with a body consisting of 1 megabyte of
random data: random data:
@ -73,7 +71,7 @@ same response again, but with a 1k randomly generated header name:
200:b@1m:h@1k,ascii_letters="foo" 200:b@1m:h@1k,ascii_letters="foo"
A few specific headers have shortcuts, because they're used so often. The A few specific headers have shortcuts, because they're used so often. The
shorcut for the content-type header is "c": shortcut for the content-type header is "c":
200:b@1m:c"text/json" 200:b@1m:c"text/json"