diff options
Diffstat (limited to 'doc/html/boost/process/shell.html')
| -rw-r--r-- | doc/html/boost/process/shell.html | 75 |
1 files changed, 75 insertions, 0 deletions
diff --git a/doc/html/boost/process/shell.html b/doc/html/boost/process/shell.html new file mode 100644 index 0000000000..acad35b497 --- /dev/null +++ b/doc/html/boost/process/shell.html @@ -0,0 +1,75 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>Global shell</title> +<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> +<link rel="up" href="../../process/reference.html#header.boost.process.shell_hpp" title="Header <boost/process/shell.hpp>"> +<link rel="prev" href="search_path.html" title="Function search_path"> +<link rel="next" href="spawn.html" title="Function template spawn"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> +<td align="center"><a href="../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="search_path.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.shell_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="spawn.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="refentry"> +<a name="boost.process.shell"></a><div class="titlepage"></div> +<div class="refnamediv"> +<h2><span class="refentrytitle">Global shell</span></h2> +<p>boost::process::shell</p> +</div> +<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> +<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../process/reference.html#header.boost.process.shell_hpp" title="Header <boost/process/shell.hpp>">boost/process/shell.hpp</a>> + +</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> shell<span class="special">;</span></pre></div> +<div class="refsect1"> +<a name="idp438212224"></a><h2>Description</h2> +<p>The shell property enables to launch a program through the shell of the system.</p> +<pre class="programlisting"><span class="identifier">system</span><span class="special">(</span><span class="string">"gcc"</span><span class="special">,</span> <span class="identifier">shell</span><span class="special">)</span><span class="special">;</span> +</pre> +<p>The shell argument goes without any expression. The operator() is overloaded, to obtain the path of the system shell.</p> +<pre class="programlisting"><span class="keyword">auto</span> <span class="identifier">shell_cmd</span> <span class="special">=</span> <span class="identifier">shell</span><span class="special">(</span><span class="special">)</span><span class="special">;</span> +<span class="comment">//avoid exceptions</span> +<span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">ec</span><span class="special">;</span> +<span class="identifier">shell_cmd</span> <span class="special">=</span> <span class="identifier">shell</span><span class="special">(</span><span class="identifier">ec</span><span class="special">)</span><span class="special">;</span> +</pre> +<div class="note"><table border="0" summary="Note"> +<tr> +<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> +<th align="left">Note</th> +</tr> +<tr><td align="left" valign="top"> +<p>Launching through the shell will NOT provide proper error handling, i.e. you will get an error via the return code.</p> +<p>Executing shell commands that incorporate unsanitized input from an untrusted source makes a program vulnerable to shell injection, a serious security flaw which can result in arbitrary command execution. For this reason, the use of <code class="computeroutput">shell</code> is strongly discouraged in cases where the command string is constructed from external input: </p> +</td></tr> +</table></div> +<p> +</p> +</div> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, + Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 2016 Klemens D. Morgenstern<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="search_path.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../process/reference.html#header.boost.process.shell_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="spawn.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |