aboutsummaryrefslogtreecommitdiff
path: root/libbutl/command.mxx
diff options
context:
space:
mode:
authorKaren Arutyunov <karen@codesynthesis.com>2019-09-13 20:57:00 +0300
committerKaren Arutyunov <karen@codesynthesis.com>2019-09-27 17:08:05 +0300
commit3fa1b103014bab51f8f257e1e12f27f7e498f42e (patch)
tree4958c20dead025ffa0305dd0c99041382bda16a8 /libbutl/command.mxx
parentc4292d57e2e67dfcdac9004f8edb229976f6669a (diff)
Add support for builtin escaping to command running API
Diffstat (limited to 'libbutl/command.mxx')
-rw-r--r--libbutl/command.mxx5
1 files changed, 5 insertions, 0 deletions
diff --git a/libbutl/command.mxx b/libbutl/command.mxx
index 0e6617b..8423f59 100644
--- a/libbutl/command.mxx
+++ b/libbutl/command.mxx
@@ -37,6 +37,11 @@ LIBBUTL_MODEXPORT namespace butl
// error, ios::failure on the underlying OS error, process_error on the
// process running error and std::system_error on the builtin running error.
//
+ // To run a system utility rather than a builtin prefix its name with `^`,
+ // for example:
+ //
+ // ^cat --squeeze-blank file
+ //
// The process environment path is unused and must point to the empty
// process path.
//