%PDF-
%PDF-
Mini Shell
Mini Shell
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Nagios: runcmd.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Nagios
 <span id="projectnumber">4.4.3</span>
</div>
<div id="projectbrief">Dev docs for Nagios core and neb-module hackers</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">runcmd.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>runcmd library function declarations
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <signal.h></code><br/>
</div>
<p><a href="runcmd_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="memitem:a137b2e453f35e694292e3c9c26222dea"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#a137b2e453f35e694292e3c9c26222dea">RUNCMD_HAS_REDIR</a>   (1 << 0)</td></tr>
<tr class="memdesc:a137b2e453f35e694292e3c9c26222dea"><td class="mdescLeft"> </td><td class="mdescRight">Return code bitflags for <a class="el" href="runcmd_8h.html#aca907b3c82a3885186b590f44a758079" title="Convert a string to a vector of arguments like a shell would. ">runcmd_cmd2strv()</a> <a href="#a137b2e453f35e694292e3c9c26222dea">More...</a><br/></td></tr>
<tr class="separator:a137b2e453f35e694292e3c9c26222dea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a627d7784a16a94482628b40989fc6fd0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a627d7784a16a94482628b40989fc6fd0"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#a627d7784a16a94482628b40989fc6fd0">RUNCMD_HAS_SUBCOMMAND</a>   (1 << 1)</td></tr>
<tr class="memdesc:a627d7784a16a94482628b40989fc6fd0"><td class="mdescLeft"> </td><td class="mdescRight">subcommands present <br/></td></tr>
<tr class="separator:a627d7784a16a94482628b40989fc6fd0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7c1913db9537a97d1eaf36dd571a9a89"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c1913db9537a97d1eaf36dd571a9a89"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#a7c1913db9537a97d1eaf36dd571a9a89">RUNCMD_HAS_PAREN</a>   (1 << 2)</td></tr>
<tr class="memdesc:a7c1913db9537a97d1eaf36dd571a9a89"><td class="mdescLeft"> </td><td class="mdescRight">parentheses present in command <br/></td></tr>
<tr class="separator:a7c1913db9537a97d1eaf36dd571a9a89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:accc702fcefbca1c9fcfb4d6250c301cf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="accc702fcefbca1c9fcfb4d6250c301cf"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#accc702fcefbca1c9fcfb4d6250c301cf">RUNCMD_HAS_JOBCONTROL</a>   (1 << 3)</td></tr>
<tr class="memdesc:accc702fcefbca1c9fcfb4d6250c301cf"><td class="mdescLeft"> </td><td class="mdescRight">job control stuff present <br/></td></tr>
<tr class="separator:accc702fcefbca1c9fcfb4d6250c301cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a282866d10a90c2ce1f6e12c1b6f3b35a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a282866d10a90c2ce1f6e12c1b6f3b35a"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#a282866d10a90c2ce1f6e12c1b6f3b35a">RUNCMD_HAS_UBSQ</a>   (1 << 4)</td></tr>
<tr class="memdesc:a282866d10a90c2ce1f6e12c1b6f3b35a"><td class="mdescLeft"> </td><td class="mdescRight">unbalanced single quotes <br/></td></tr>
<tr class="separator:a282866d10a90c2ce1f6e12c1b6f3b35a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a09e28c161575948fd3e23bbc0fe62f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3a09e28c161575948fd3e23bbc0fe62f"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#a3a09e28c161575948fd3e23bbc0fe62f">RUNCMD_HAS_UBDQ</a>   (1 << 5)</td></tr>
<tr class="memdesc:a3a09e28c161575948fd3e23bbc0fe62f"><td class="mdescLeft"> </td><td class="mdescRight">unbalanced double quotes <br/></td></tr>
<tr class="separator:a3a09e28c161575948fd3e23bbc0fe62f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7604776ddc73f8fa2e32c4cc88499557"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7604776ddc73f8fa2e32c4cc88499557"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#a7604776ddc73f8fa2e32c4cc88499557">RUNCMD_HAS_WILDCARD</a>   (1 << 6)</td></tr>
<tr class="memdesc:a7604776ddc73f8fa2e32c4cc88499557"><td class="mdescLeft"> </td><td class="mdescRight">wildcards present <br/></td></tr>
<tr class="separator:a7604776ddc73f8fa2e32c4cc88499557"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ff4773f5388adbf6811f83e7cb24590"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8ff4773f5388adbf6811f83e7cb24590"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#a8ff4773f5388adbf6811f83e7cb24590">RUNCMD_HAS_SHVAR</a>   (1 << 7)</td></tr>
<tr class="memdesc:a8ff4773f5388adbf6811f83e7cb24590"><td class="mdescLeft"> </td><td class="mdescRight">shell variables present <br/></td></tr>
<tr class="separator:a8ff4773f5388adbf6811f83e7cb24590"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a809d1418175a99f46a35070f5b59e6e2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a809d1418175a99f46a35070f5b59e6e2"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#a809d1418175a99f46a35070f5b59e6e2">RUNCMD_EFD</a>   (-1)</td></tr>
<tr class="memdesc:a809d1418175a99f46a35070f5b59e6e2"><td class="mdescLeft"> </td><td class="mdescRight">Failed to pipe() or open() <br/></td></tr>
<tr class="separator:a809d1418175a99f46a35070f5b59e6e2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8ffc6efe0e7c45e4df5b5f8e64f4139"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad8ffc6efe0e7c45e4df5b5f8e64f4139"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#ad8ffc6efe0e7c45e4df5b5f8e64f4139">RUNCMD_EALLOC</a>   (-2)</td></tr>
<tr class="memdesc:ad8ffc6efe0e7c45e4df5b5f8e64f4139"><td class="mdescLeft"> </td><td class="mdescRight">Failed to alloc. <br/></td></tr>
<tr class="separator:ad8ffc6efe0e7c45e4df5b5f8e64f4139"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08a1e2d5ee5aea3289e3f73116acda32"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a08a1e2d5ee5aea3289e3f73116acda32"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#a08a1e2d5ee5aea3289e3f73116acda32">RUNCMD_ECMD</a>   (-3)</td></tr>
<tr class="memdesc:a08a1e2d5ee5aea3289e3f73116acda32"><td class="mdescLeft"> </td><td class="mdescRight">Bad command. <br/></td></tr>
<tr class="separator:a08a1e2d5ee5aea3289e3f73116acda32"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad6f804d34b23a2b0ce80d0f4e984f9a8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad6f804d34b23a2b0ce80d0f4e984f9a8"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#ad6f804d34b23a2b0ce80d0f4e984f9a8">RUNCMD_EFORK</a>   (-4)</td></tr>
<tr class="memdesc:ad6f804d34b23a2b0ce80d0f4e984f9a8"><td class="mdescLeft"> </td><td class="mdescRight">Failed to fork() <br/></td></tr>
<tr class="separator:ad6f804d34b23a2b0ce80d0f4e984f9a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a049ff19afdd6870b63cfaeaf3bfb4119"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a049ff19afdd6870b63cfaeaf3bfb4119"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#a049ff19afdd6870b63cfaeaf3bfb4119">RUNCMD_EINVAL</a>   (-5)</td></tr>
<tr class="memdesc:a049ff19afdd6870b63cfaeaf3bfb4119"><td class="mdescLeft"> </td><td class="mdescRight">Invalid parameters. <br/></td></tr>
<tr class="separator:a049ff19afdd6870b63cfaeaf3bfb4119"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab45ee0914807f380887acf8d78c197a9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab45ee0914807f380887acf8d78c197a9"></a>
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#ab45ee0914807f380887acf8d78c197a9">RUNCMD_EWAIT</a>   (-6)</td></tr>
<tr class="memdesc:ab45ee0914807f380887acf8d78c197a9"><td class="mdescLeft"> </td><td class="mdescRight">Failed to wait() <br/></td></tr>
<tr class="separator:ab45ee0914807f380887acf8d78c197a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae3353ec3d6496563eff990f1f8f41b2f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#ae3353ec3d6496563eff990f1f8f41b2f">runcmd_init</a> (void)</td></tr>
<tr class="memdesc:ae3353ec3d6496563eff990f1f8f41b2f"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the runcmd library. <a href="#ae3353ec3d6496563eff990f1f8f41b2f">More...</a><br/></td></tr>
<tr class="separator:ae3353ec3d6496563eff990f1f8f41b2f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abaa915421b65f5c0f386cae83d43f776"><td class="memItemLeft" align="right" valign="top">pid_t </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#abaa915421b65f5c0f386cae83d43f776">runcmd_pid</a> (int fd)</td></tr>
<tr class="memdesc:abaa915421b65f5c0f386cae83d43f776"><td class="mdescLeft"> </td><td class="mdescRight">Return pid of a command with a specific file descriptor. <a href="#abaa915421b65f5c0f386cae83d43f776">More...</a><br/></td></tr>
<tr class="separator:abaa915421b65f5c0f386cae83d43f776"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac264bd14731ff4521acaee5d505f85ec"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#ac264bd14731ff4521acaee5d505f85ec">runcmd_strerror</a> (int code)</td></tr>
<tr class="memdesc:ac264bd14731ff4521acaee5d505f85ec"><td class="mdescLeft"> </td><td class="mdescRight">Return explanation of which system call or operation failed. <a href="#ac264bd14731ff4521acaee5d505f85ec">More...</a><br/></td></tr>
<tr class="separator:ac264bd14731ff4521acaee5d505f85ec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a941bffadcd8ec578e93216d144097856"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#a941bffadcd8ec578e93216d144097856">runcmd_open</a> (const char *cmd, int *pfd, int *pfderr, char **env, void(*iobreg)(int, int, void *), void *iobregarg)</td></tr>
<tr class="memdesc:a941bffadcd8ec578e93216d144097856"><td class="mdescLeft"> </td><td class="mdescRight">Start a command from a command string. <a href="#a941bffadcd8ec578e93216d144097856">More...</a><br/></td></tr>
<tr class="separator:a941bffadcd8ec578e93216d144097856"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca041c180a0e52fce527197923aa7834"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#aca041c180a0e52fce527197923aa7834">runcmd_close</a> (int fd)</td></tr>
<tr class="memdesc:aca041c180a0e52fce527197923aa7834"><td class="mdescLeft"> </td><td class="mdescRight">Close a command and return its exit status. <a href="#aca041c180a0e52fce527197923aa7834">More...</a><br/></td></tr>
<tr class="separator:aca041c180a0e52fce527197923aa7834"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca907b3c82a3885186b590f44a758079"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#aca907b3c82a3885186b590f44a758079">runcmd_cmd2strv</a> (const char *str, int *out_argc, char **out_argv)</td></tr>
<tr class="memdesc:aca907b3c82a3885186b590f44a758079"><td class="mdescLeft"> </td><td class="mdescRight">Convert a string to a vector of arguments like a shell would. <a href="#aca907b3c82a3885186b590f44a758079">More...</a><br/></td></tr>
<tr class="separator:aca907b3c82a3885186b590f44a758079"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89517237851fef77721db7aef7b87955"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a89517237851fef77721db7aef7b87955"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="runcmd_8h.html#a89517237851fef77721db7aef7b87955">runcmd_free_pids</a> (void)</td></tr>
<tr class="memdesc:a89517237851fef77721db7aef7b87955"><td class="mdescLeft"> </td><td class="mdescRight">If you're using libnagios to execute a remote command, the static pid_t pids is not freed after runcmd_open You can call this function when you're sure pids is no longer in use, to keep down memory leaks. <br/></td></tr>
<tr class="separator:a89517237851fef77721db7aef7b87955"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>runcmd library function declarations </p>
<p>A simple interface to executing programs from other programs, using an optimized and safer popen()-like implementation. It is considered safer in that no shell needs to be spawned for simple commands, and the environment passed to the execve()'d program is essentially empty.</p>
<p>This code is based on popen.c, which in turn was taken from "Advanced Programming in the UNIX Environment" by W. Richard Stevens.</p>
<p>Care has been taken to make sure the functions are async-safe. The exception is <a class="el" href="runcmd_8h.html#ae3353ec3d6496563eff990f1f8f41b2f" title="Initialize the runcmd library. ">runcmd_init()</a> which multithreaded applications or plugins must call in a non-reentrant manner before calling any other runcmd function.</p>
<dl class="section note"><dt>Note</dt><dd>This is inherited from the nagiosplugins project, although it might need refactoring for performance later. </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a137b2e453f35e694292e3c9c26222dea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define RUNCMD_HAS_REDIR   (1 << 0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return code bitflags for <a class="el" href="runcmd_8h.html#aca907b3c82a3885186b590f44a758079" title="Convert a string to a vector of arguments like a shell would. ">runcmd_cmd2strv()</a> </p>
<p>I/O redirection </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="aca041c180a0e52fce527197923aa7834"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int runcmd_close </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close a command and return its exit status. </p>
<dl class="section note"><dt>Note</dt><dd>Don't use this. It's a retarded way to reap children suitable only for launching a one-shot program.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fd</td><td>The child's stdout filedescriptor </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>exit-status of the child, or -1 in case of errors </dd></dl>
</div>
</div>
<a class="anchor" id="aca907b3c82a3885186b590f44a758079"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int runcmd_cmd2strv </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>out_argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>out_argv</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert a string to a vector of arguments like a shell would. </p>
<dl class="section note"><dt>Note</dt><dd>This might have bugs and is only tested to behave similar to how /bin/sh does things. For csh or other non bash-ish shells there are no guarantees. </dd>
<dd>
The out_argv array has to be large enough to hold all strings found in the command. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">str</td><td>The string to convert to an argument vector </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out_argc</td><td>The number of arguments found </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out_argv</td><td>The argument vector </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on (great) success, or a bitmask of failure-codes representing f.e. unclosed quotes, job control or output redirection. See the RUNCMD_HAS_* and their ilk to find out about the flag. </dd></dl>
</div>
</div>
<a class="anchor" id="ae3353ec3d6496563eff990f1f8f41b2f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void runcmd_init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the runcmd library. </p>
<p>Only multi-threaded programs that might launch the first external program from multiple threads simultaneously need to bother with this, and they must ensure this is called at least once in a non-reentrant manner before calling any other runcmd function. </p>
</div>
</div>
<a class="anchor" id="a941bffadcd8ec578e93216d144097856"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int runcmd_open </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>cmd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>pfd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"><em>pfderr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"><em>env</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(int, int, void *) </td>
<td class="paramname"><em>iobreg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>iobregarg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start a command from a command string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cmd</td><td>The command to launch </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">pfd</td><td>Child's stdout filedescriptor </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">pfderr</td><td>Child's stderr filedescriptor </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">env</td><td>Currently ignored for portability </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">iobreg</td><td>The callback function to register the iobrokers for the read ends of the pipe </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">iobregarg</td><td>The "arg" value to pass to <a class="el" href="iobroker_8h.html#ac3d3b9c54f65c31ce8ade64ef0bea74c" title="Register a socket for input polling with the broker. ">iobroker_register()</a> </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abaa915421b65f5c0f386cae83d43f776"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">pid_t runcmd_pid </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>fd</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return pid of a command with a specific file descriptor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">fd</td><td>stdout filedescriptor of the child to get pid from </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pid of the child, or 0 on errors </dd></dl>
</div>
</div>
<a class="anchor" id="ac264bd14731ff4521acaee5d505f85ec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* runcmd_strerror </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>code</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return explanation of which system call or operation failed. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">code</td><td>Error code returned by a library function </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A non-free()'able string explaining where the error occurred </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
Zerion Mini Shell 1.0