1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Global shell</title> 6<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../../process/reference.html#header.boost.process.shell_hpp" title="Header <boost/process/shell.hpp>"> 10<link rel="prev" href="search_path.html" title="Function search_path"> 11<link rel="next" href="spawn.html" title="Function template spawn"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> 16<td align="center"><a href="../../../../index.html">Home</a></td> 17<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<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> 25</div> 26<div class="refentry"> 27<a name="boost.process.shell"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Global shell</span></h2> 30<p>boost::process::shell</p> 31</div> 32<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> 33<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>> 34 35</span><span class="emphasis"><em><span class="identifier">unspecified</span></em></span> shell<span class="special">;</span></pre></div> 36<div class="refsect1"> 37<a name="id-1.3.30.9.21.3.4"></a><h2>Description</h2> 38<p>The shell property enables to launch a program through the shell of the system.</p> 39<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> 40</pre> 41<p>The shell argument goes without any expression. The operator() is overloaded, to obtain the path of the system shell.</p> 42<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> 43<span class="comment">//avoid exceptions</span> 44<span class="identifier">std</span><span class="special">::</span><span class="identifier">error_code</span> <span class="identifier">ec</span><span class="special">;</span> 45<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> 46</pre> 47<div class="note"><table border="0" summary="Note"> 48<tr> 49<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> 50<th align="left">Note</th> 51</tr> 52<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></td></tr> 53</table></div> 54<p> 55</p> 56<div class="note"><table border="0" summary="Note"> 57<tr> 58<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../doc/src/images/note.png"></td> 59<th align="left">Note</th> 60</tr> 61<tr><td align="left" valign="top"><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> 62</table></div> 63<p> 64</p> 65</div> 66</div> 67<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 68<td align="left"></td> 69<td align="right"><div class="copyright-footer">Copyright © 2006-2012 Julio M. Merino Vidal, Ilya Sokolov, 70 Felipe Tanus, Jeff Flinn, Boris Schaeling<br>Copyright © 2016 Klemens D. Morgenstern<p> 71 Distributed under the Boost Software License, Version 1.0. (See accompanying 72 file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) 73 </p> 74</div></td> 75</tr></table> 76<hr> 77<div class="spirit-nav"> 78<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> 79</div> 80</body> 81</html> 82
