.TH "KShellProcess" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KShellProcess \- A class derived from \fBKProcess\fP to start child processes through a shell.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kprocess.h>\fP
.PP
Inherits \fBKProcess\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKShellProcess\fP (const char *shellname=0)"
.br
.ti -1c
.RI "\fB~KShellProcess\fP ()"
.br
.ti -1c
.RI "virtual bool \fBstart\fP (\fBRunMode\fP runmode=NotifyOnExit, \fBCommunication\fP comm=NoCommunication)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static \fBQString\fP \fBquote\fP (const \fBQString\fP &arg)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A class derived from \fBKProcess\fP to start child processes through a shell. 

\fBDeprecated\fP
.RS 4
.RE
.PP
Use \fBKProcess\fP and KProcess::setUseShell(true) instead.
.PP
\fBAuthor:\fP
.RS 4
Christian Czezatke <e9025461@student.tuwien.ac.at> 
.RE
.PP

.PP
Definition at line 883 of file kprocess.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KShellProcess::KShellProcess (const char * shellname = \fC0\fP)"
.PP
Constructor. 
.PP
If no shellname is specified, the user's default shell is used. 
.PP
Definition at line 1110 of file kprocess.cpp.
.PP
References KProcess::setUseShell().
.SS "KShellProcess::~\fBKShellProcess\fP ()"
.PP
Destructor. 
.PP
Definition at line 1116 of file kprocess.cpp.
.SH "Member Function Documentation"
.PP 
.SS "bool KShellProcess::start (\fBRunMode\fP runmode = \fCNotifyOnExit\fP, \fBCommunication\fP comm = \fCNoCommunication\fP)\fC [virtual]\fP"
.PP
Starts the process. 
.PP
For a detailed description of the various run modes and communication semantics, have a look at the general description of the \fBKProcess\fP class. Note that if you use setUsePty( Stdout | Stderr, <bool> ), you cannot use Stdout | Stderr here - instead, use Stdout only to receive the mixed output.
.PP
The following problems could cause this function to return false:
.PP
.PD 0
.IP "\(bu" 2
The process is already running. 
.IP "\(bu" 2
The command line argument list is empty. 
.IP "\(bu" 2
The the \fCcomm\fP parameter is incompatible with the selected pty usage. 
.IP "\(bu" 2
The starting of the process failed (could not fork). 
.IP "\(bu" 2
The executable was not found.
.PP
\fBParameters:\fP
.RS 4
\fIrunmode\fP The Run-mode for the process. 
.br
\fIcomm\fP Specifies which communication links should be established to the child process (stdin/stdout/stderr). By default, no communication takes place and the respective communication signals will never get emitted.
.RE
.PP
\fBReturns:\fP
.RS 4
true on success, false on error (see above for error conditions) 
.RE
.PP

.PP
Reimplemented from \fBKProcess\fP.
.PP
Definition at line 1124 of file kprocess.cpp.
.PP
References KProcess::start().
.SS "\fBQString\fP KShellProcess::quote (const \fBQString\fP & arg)\fC [static]\fP"
.PP
This function can be used to quote an argument string such that the shell processes it properly. 
.PP
This is e. g. necessary for user-provided file names which may contain spaces or quotes. It also prevents expansion of wild cards and environment variables. 
.PP
\fBParameters:\fP
.RS 4
\fIarg\fP the argument to quote 
.RE
.PP
\fBReturns:\fP
.RS 4
the quoted argument 
.RE
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP

.PP
Reimplemented from \fBKProcess\fP.
.PP
Definition at line 1119 of file kprocess.cpp.
.PP
References KProcess::quote().

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
