summaryrefslogtreecommitdiffstats
path: root/src/basic/escape.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/basic/escape.h')
-rw-r--r--src/basic/escape.h9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/basic/escape.h b/src/basic/escape.h
index b8eb137c3d..0b00b116ed 100644
--- a/src/basic/escape.h
+++ b/src/basic/escape.h
@@ -34,8 +34,13 @@ typedef enum UnescapeFlags {
} UnescapeFlags;
typedef enum EscapeStyle {
- ESCAPE_BACKSLASH = 1,
- ESCAPE_POSIX = 2,
+ ESCAPE_BACKSLASH = 1, /* Add shell quotes ("") so the shell will consider this a single
+ argument, possibly multiline. Tabs and newlines are not escaped. */
+ ESCAPE_BACKSLASH_ONELINE = 2, /* Similar to ESCAPE_BACKSLASH, but always produces a single-line
+ string instead. Shell escape sequences are produced for tabs and
+ newlines. */
+ ESCAPE_POSIX = 3, /* Similar to ESCAPE_BACKSLASH_ONELINE, but uses POSIX shell escape
+ * syntax (a string enclosed in $'') instead of plain quotes. */
} EscapeStyle;
char *cescape(const char *s);