diff options
author | Boris Kolpackov <boris@codesynthesis.com> | 2011-06-29 14:08:29 +0200 |
---|---|---|
committer | Boris Kolpackov <boris@codesynthesis.com> | 2011-06-29 14:08:29 +0200 |
commit | 2bc006daa59995085626b3e9c0754823bf9d95a5 (patch) | |
tree | 25854abe3450783ad641da07e14b3ca8e23b7c2f /doc | |
parent | 21fc3270c40e0623cee4363e00bb4435518a4bb7 (diff) |
Add --include-regex and --include-regex-trace options
This requires libcutl update.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/odb-epilogue.1 | 24 | ||||
-rw-r--r-- | doc/odb-epilogue.xhtml | 28 |
2 files changed, 52 insertions, 0 deletions
diff --git a/doc/odb-epilogue.1 b/doc/odb-epilogue.1 index c2dbd05..b202796 100644 --- a/doc/odb-epilogue.1 +++ b/doc/odb-epilogue.1 @@ -1,4 +1,28 @@ .\" +.\" REGEX AND SHELL QUOTING +.\" +.SH REGEX AND SHELL QUOTING +When entering a regular expression argument in the shell command line +it is often necessary to use quoting (enclosing the argument in " " +or ' ') in order to prevent the shell from interpreting certain +characters, for example, spaces as argument separators and $ as +variable expansions. + +Unfortunately it is hard to achieve this in a manner that is portable +across POSIX shells, such as those found on GNU/Linux and UNIX, and +Windows shell. For example, if you use " " for quoting you will get +a wrong result with POSIX shells if your expression contains $. The +standard way of dealing with this on POSIX systems is to use ' ' +instead. Unfortunately, Windows shell does not remove ' ' from +arguments when they are passed to applications. As a result you may +have to use ' ' for POSIX and " " for Windows ($ is not treated as +a special character on Windows). + +Alternatively, you can save regular expression options into a file, +one option per line, and use this file with the +.B --options-file +option. With this approach you don't need to worry about shell quoting. +.\" .\" DIAGNOSTICS .\" .SH DIAGNOSTICS diff --git a/doc/odb-epilogue.xhtml b/doc/odb-epilogue.xhtml index 4f67528..f489a15 100644 --- a/doc/odb-epilogue.xhtml +++ b/doc/odb-epilogue.xhtml @@ -1,3 +1,31 @@ + <h1>REGEX AND SHELL QUOTING</h1> + + <p>When entering a regular expression argument in the shell + command line it is often necessary to use quoting (enclosing + the argument in <code><b>" "</b></code> or + <code><b>' '</b></code>) in order to prevent the shell + from interpreting certain characters, for example, spaces as + argument separators and <code><b>$</b></code> as variable + expansions.</p> + + <p>Unfortunately it is hard to achieve this in a manner that is + portable across POSIX shells, such as those found on + GNU/Linux and UNIX, and Windows shell. For example, if you + use <code><b>" "</b></code> for quoting you will get a + wrong result with POSIX shells if your expression contains + <code><b>$</b></code>. The standard way of dealing with this + on POSIX systems is to use <code><b>' '</b></code> instead. + Unfortunately, Windows shell does not remove <code><b>' '</b></code> + from arguments when they are passed to applications. As a result you + may have to use <code><b>' '</b></code> for POSIX and + <code><b>" "</b></code> for Windows (<code><b>$</b></code> is + not treated as a special character on Windows).</p> + + <p>Alternatively, you can save regular expression options into + a file, one option per line, and use this file with the + <code><b>--options-file</b></code> option. With this approach + you don't need to worry about shell quoting.</p> + <h1>DIAGNOSTICS</h1> <p>If the input file is not valid C++, <code><b>odb</b></code> |