From d33d3663ecb166461d9cb5a78a29b44ee7a8fbb7 Mon Sep 17 00:00:00 2001 From: Maximilian Hils Date: Thu, 18 Feb 2016 13:03:40 +0100 Subject: combine projects --- pathod/templates/docs_lang.html | 196 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 196 insertions(+) create mode 100644 pathod/templates/docs_lang.html (limited to 'pathod/templates/docs_lang.html') diff --git a/pathod/templates/docs_lang.html b/pathod/templates/docs_lang.html new file mode 100644 index 00000000..a1d22aef --- /dev/null +++ b/pathod/templates/docs_lang.html @@ -0,0 +1,196 @@ +{% extends "docframe.html" %} {% block body %} +
+

+ Language Spec + The mini-language at the heart of pathoc and pathod. +

+
+ + + +
+
+ {% include "docs_lang_responses.html" %} +
+
+ {% include "docs_lang_requests.html" %} +
+
+ {% include "docs_lang_websockets.html" %} +
+
+ +
+
+

Features

+
+ + +

OFFSET

+ +

+ Offsets are calculated relative to the base message, before any injections or other + transforms are applied. They have 3 flavors: +

+ + + + +

VALUE

+ +

Literals

+ +

Literal values are specified as a quoted strings:

+ + 
"foo"
+ +

+ Either single or double quotes are accepted, and quotes can be escaped with backslashes + within the string: +

+ + 
'fo\'o'
+ +

Literal values can contain Python-style backslash escape sequences:

+ + 
'foo\r\nbar'
+ +

Files

+ +

+ You can load a value from a specified file path. To do so, you have to specify a + _staticdir_ option to pathod on the command-line, like so: +

+ + 
pathod -d ~/myassets
+ +

+ All paths are relative paths under this directory. File loads are indicated by starting + the value specifier with the left angle bracket: +

+ + 
<my/path
+ +

The path value can also be a quoted string, with the same syntax as literals:

+ + 
<"my/path"
+ + +

Generated values

+ +

+ An @-symbol lead-in specifies that generated data should be used. There are two components + to a generator specification - a size, and a data type. By default pathod + assumes a data type of "bytes". +

+ +

Here's a value specifier for generating 100 bytes: + + 

@100
+

+ +

+ You can use standard suffixes to indicate larger values. Here, for instance, is a + specifier for generating 100 megabytes: +

+ + 
@100m
+ +

+ Data is generated and served efficiently - if you really want to send a terabyte + of data to a client, pathod can do it. The supported suffixes are: +

+ + + + + + + + + + + + + + + + + + + + + + + + +
b1024**0 (bytes)
k1024**1 (kilobytes)
m1024**2 (megabytes)
g1024**3 (gigabytes)
t1024**4 (terabytes)
+ +

+ Data types are separated from the size specification by a comma. This specification + generates 100mb of ASCII: +

+ + 
@100m,ascii
+ +

Supported data types are:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
asciiAll ASCII characters
ascii_lettersA-Za-z
ascii_lowercasea-z
ascii_uppercaseA-Z
bytesAll 256 byte values
digits0-9
hexdigits0-f
octdigits0-7
punctuation + 
!"#$%&\'()*+,-./:;
+                        <=>?@[\\]^_`{|}~
+
whitespace + 
\t\n\x0b\x0c\r and space
+
+
+{% endblock %} -- cgit v1.2.3