diff options
Diffstat (limited to 'runcap.3')
| -rw-r--r-- | runcap.3 | 23 |
1 files changed, 12 insertions, 11 deletions
@@ -10,13 +10,13 @@ .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with runcap. If not, see <http://www.gnu.org/licenses/>. -.TH RUNCAP 2 "August 19, 2017" "RUNCAP" "User Commands" +.TH RUNCAP 2 "August 22, 2017" "RUNCAP" "User Commands" .SH NAME runcap \- run external process and capture its stdout and stderr .SH SYNOPSIS .nf .B #include <runcap.h> .sp @@ -75,18 +75,18 @@ struct runcap int rc_status; /* [\fIOUT\fR] Termination status */ int rc_errno; /* [\fIOUT\fR] System error code */ }; .fi .in .PP -The members that may be initialized on input are marked with +Members that may be initialized on input are marked with [\fIIN\fR], those that are set upon return from \fBruncap()\fR are marked with [\fIOUT\fR]. .PP The caller is responsible for initializing the \fBrc_argv\fR member -with a pointer to the command line arguments array. The other +with a pointer to the command line arguments array. Other input fields are: .TP .B rc_program Actual pathname of the program to be executed. If initialized, the \fBRCF_PROGRAM\fR bit must be set in \fIflags\fR. Otherwise, the value of \fBrc_argv[0]\fR is assumed. @@ -137,26 +137,27 @@ struct stream_capture The caller may initialize the following members in \fBrc_cap[RUNCAP_STDOUT]\fR and \fBrc_cap[RUNCAP_STDERR]\fR: .TP .B sc_size Size of the buffer (\fBsize_t\fR). If set, the \fBRCF_STDOUT_SIZE\fR (for \fBRUNCAP_STDOUT\fR) or \fBRCF_STDERR_SIZE\fR (for -\fBRUNCAP_STDERR\fR) bit must be set in \fIflags\fR. The default -buffer size is 4096 bytes. If the amount of input data exceeds the -buffer size, the data are saved in the disk file, therefore setting a -larger buffer can improve performance. Setting \fBsc_size\fR to 0 -disables capturing. +\fBRUNCAP_STDERR\fR) bit must be set in \fIflags\fR. If the amount of +input data exceeds the buffer size, the data are saved in the disk +file, therefore setting a larger buffer can improve performance. +Setting \fBsc_size\fR to 0 disables capturing. + +Default buffer size is 4096 bytes. .TP .B sc_linemon A pointer to the line monitor function. If set, the \fBRCF_STDOUT_LINEMON\fR (for \fBRUNCAP_STDOUT\fR), or \fBRCF_STDERR_LINEMON\fR (for \fBRUNCAP_STDERR\fR) bit must be set in \fIflags\fR. .sp The line monitor function allows the caller to monitor the arrival of -the new data in the corresponding stream. Its signature is: +the new data in the corresponding stream. It is declared as follows: .sp .BI "void linemon(const char *" line ", size_t " size ", void *" data ) .sp where \fIline\fR is the line that has been read, \fIsize\fR is its length, and \fIdata\fR is an opaque pointer to application-specific data, supplied in the \fBsc_monarg\fR member. @@ -205,13 +206,13 @@ Upon return, the following fields are initialized: Termination status, as returned by .BR wait (2). .TP .B rc_errno Value of errno, if terminated on error. .PP -Upon successful return, the following fields are initialized: +The following fields are defined upon successful return: .TP .B rc_cap[RUNCAP_STDOUT].sc_leng Total length of captured stdout. .TP .B rc_cap[RUNCAP_STDOUT].sc_nlines Number of lines in the captured stdout. @@ -224,13 +225,13 @@ Number of lines in the captured stderr. .PP The actual data can be retrieved using the \fBruncap_getc\fR, and \fBruncap_getline\fR functions, described below. .SH Examining output Upon return from \fBruncap\fR the following functions can be used to retrieve the captured data from the \fBstruct runcap\fR object pointed -to by its \fIrc\fR argument. The stream to retrieve the data from is +to by its \fIrc\fR argument. The stream to retrieve data from is identified by the \fIstream\fR argument, whose valid values are \fBRUNCAP_STDOUT\fR (or \fB1\fR) or \fBRUNCAP_STDERR\fR (or \fB2\fR). .PP The function \fBruncap_getc\fR reads the next character from the captured stream and returns it as an unsigned char cast to an int. It returns 0 on end of stream, and -1 on error. In the latter case, |