Welcome to little lamb

Code » comain » commit 54b76c0

doc/include: Add esc.md

author Olivier Brunel
2023-12-22 13:17:09 UTC
committer Olivier Brunel
2024-01-02 10:18:38 UTC
parent 8cdddeb96793547a9b4f54306c120126211271b9

doc/include: Add esc.md

For whenever an application relies on escall_scan()

src/doc/include/esc.md +34 -0

diff --git a/src/doc/include/esc.md b/src/doc/include/esc.md
new file mode 100644
index 0000000..f9b3355
--- /dev/null
+++ b/src/doc/include/esc.md
@@ -0,0 +1,34 @@
+Characters with special escaping are as follow :
+
+: double-quote (`"`)
+:: Escaped by prefixing with a backslash (`\`)
+
+: backslash (`\`)
+:: Escaped by prefixing with a backslash (`\`)
+
+: bell (`0x07`)
+:: Escaped as `\a`
+
+: backspace (`0x08`)
+:: Escaped as `\b`
+
+: tabulation (`0x09`)
+:: Escaped as `\t`
+
+: line feed (`0x0a`)
+:: Escaped as `\n`
+
+: vertical tabulation (`0x0b`)
+:: Escaped as `\v`
+
+: form feed (`0x0c`)
+:: Escaped as `\f`
+
+: carriage return (`0x0d`)
+:: Escaped as `\r`
+
+Additionally, specific bytes can be specified using hex-mode, that is `\x`
+followed by its hexadecimal code. (For example, byte 127 would be escaped as
+`\x7f`).
+
+Anything else will be treated as-is.