'\" t
.TH QProcess 3qt "18 March 2002" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2001 Trolltech AS.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QProcess \- Used to start external programs and to communicate with them
.SH SYNOPSIS
\fC#include <qprocess.h>\fR
.PP
Inherits QObject.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBQProcess\fR ( QObject * parent = 0, const char * name = 0 )"
.br
.ti -1c
.BI "\fBQProcess\fR ( const QString & arg0, QObject * parent = 0, const char * name = 0 )"
.br
.ti -1c
.BI "\fBQProcess\fR ( const QStringList & args, QObject * parent = 0, const char * name = 0 )"
.br
.ti -1c
.BI "\fB~QProcess\fR ()"
.br
.ti -1c
.BI "QStringList \fBarguments\fR () const"
.br
.ti -1c
.BI "void \fBclearArguments\fR ()"
.br
.ti -1c
.BI "virtual void \fBsetArguments\fR ( const QStringList & args )"
.br
.ti -1c
.BI "virtual void \fBaddArgument\fR ( const QString & arg )"
.br
.ti -1c
.BI "QDir \fBworkingDirectory\fR () const"
.br
.ti -1c
.BI "virtual void \fBsetWorkingDirectory\fR ( const QDir & dir )"
.br
.ti -1c
.BI "enum \fBCommunication\fR { Stdin = 0x01, Stdout = 0x02, Stderr = 0x04, DupStderr = 0x08 }"
.br
.ti -1c
.BI "void \fBsetCommunication\fR ( int commFlags )"
.br
.ti -1c
.BI "int \fBcommunication\fR () const"
.br
.ti -1c
.BI "virtual bool \fBstart\fR ( QStringList * env = 0 )"
.br
.ti -1c
.BI "virtual bool \fBlaunch\fR ( const QString & buf, QStringList * env = 0 )"
.br
.ti -1c
.BI "virtual bool \fBlaunch\fR ( const QByteArray & buf, QStringList * env = 0 )"
.br
.ti -1c
.BI "bool \fBisRunning\fR () const"
.br
.ti -1c
.BI "bool \fBnormalExit\fR () const"
.br
.ti -1c
.BI "int \fBexitStatus\fR () const"
.br
.ti -1c
.BI "virtual QByteArray \fBreadStdout\fR ()"
.br
.ti -1c
.BI "virtual QByteArray \fBreadStderr\fR ()"
.br
.ti -1c
.BI "bool \fBcanReadLineStdout\fR () const"
.br
.ti -1c
.BI "bool \fBcanReadLineStderr\fR () const"
.br
.ti -1c
.BI "virtual QString \fBreadLineStdout\fR ()"
.br
.ti -1c
.BI "virtual QString \fBreadLineStderr\fR ()"
.br
.ti -1c
.BI "PID \fBprocessIdentifier\fR ()"
.br
.in -1c
.SS "Public Slots"
.in +1c
.ti -1c
.BI "void \fBtryTerminate\fR () const"
.br
.ti -1c
.BI "void \fBkill\fR () const"
.br
.ti -1c
.BI "virtual void \fBwriteToStdin\fR ( const QByteArray & buf )"
.br
.ti -1c
.BI "virtual void \fBwriteToStdin\fR ( const QString & buf )"
.br
.ti -1c
.BI "virtual void \fBcloseStdin\fR ()"
.br
.in -1c
.SS "Signals"
.in +1c
.ti -1c
.BI "void \fBreadyReadStdout\fR ()"
.br
.ti -1c
.BI "void \fBreadyReadStderr\fR ()"
.br
.ti -1c
.BI "void \fBprocessExited\fR ()"
.br
.ti -1c
.BI "void \fBwroteToStdin\fR ()"
.br
.ti -1c
.BI "void \fBlaunchFinished\fR ()"
.br
.in -1c
.SH DESCRIPTION
The QProcess class is used to start external programs and to communicate with them.
.PP
You can write to the started program's standard input, and can read the program's standard output and standard error. You can pass command line arguments to the program either in the constructor or with setArguments() or addArgument(). The program's working directory can be set with setWorkingDirectory(). If you need to set up environment variables pass them to the start() or launch() function (see below). The processExited() signal is emitted if the program exits. The program's exit status is available from exitStatus(), although you could simply call normalExit() to see if the program terminated normally.
.PP
There are two different ways to start a process. If you just want to run a program, optionally passing data to its standard input at the beginning, use one of the launch() functions. If you want full control of the program's standard input (especially if you don't know all data you want to send to standard input at the beginning), use the start() function.
.PP
If you use start() you can write to the program's standard input using writeToStdin() and you can close the standard input with closeStdin(). The wroteToStdin() signal is emitted if the data sent to standard input has been written. You can read from the program's standard output using readStdout() or readLineStdout(). These functions return an empty QByteArray if there is no data to read. The readyReadStdout() signal is emitted when there is data available to be read from standard output. Standard error has a set of functions that correspond to the standard output functions, i.e. readStderr(), readLineStderr() and readyReadStderr().
.PP
If you use one of the launch() functions the data you pass will be sent to the program's standard input which will be closed once all the data has been written. You should \fInot\fR use writeToStdin() or closeStdin() if you use launch(). If you need to send data to the program's standard input after it has started running use start() instead of launch().
.PP
Both start() and launch() can accept a string list of strings with the format, key=value, where the keys are the names of environment variables.
.PP
You can test to see if a program is running with isRunning(). The program's process identifier is available from processIdentifier(). If you want to terminate a running program use tryTerminate(), but note that the program may ignore this. If you \fIreally\fR want to terminate the program, without it having any chance to clean up, you can use kill().
.PP
As an example, suppose we want to start the \fCuic\fR command (a Qt command line tool used with \fIQt Designer\fR) and perform some operations on the output (the \fCuic\fR outputs the code it generates to standard output by default). Suppose further that we want to run the program on the file "small_dialog.ui" with the command line options "-tr i18n". On the command line we would write:
.PP
.nf
.br
  uic -tr i18n small_dialog.ui
.br
.fi
.PP
A code snippet for this with the QProcess class might look like this:
.PP
.nf
.br
    UicManager::UicManager()
.br
    {
.fi
.PP
.nf
.br
        proc = new QProcess( this );
.fi
.PP
.nf
.br
        proc->addArgument( "uic" );
.br
        proc->addArgument( "-tr" );
.br
        proc->addArgument( "i18n" );
.br
        proc->addArgument( "small_dialog.ui" );
.br
.br
        connect( proc, SIGNAL(readyReadStdout()),
.br
                this, SLOT(readFromStdout()) );
.fi
.PP
.nf
.br
        if ( !proc->start() ) {
.br
            // error handling
.fi
.PP
.nf
.br
        }
.br
    }
.fi
.PP
.nf
.br
    void UicManager::readFromStdout()
.br
    {
.br
        // Read and process the data.
.br
        // Bear in mind that the data might be output in chunks.
.fi
.PP
.nf
.br
    }
.fi
.PP
Although you may need quotes for a file named on the command line (e.g. if it contains spaces) you shouldn't use extra quotes for arguments passed to addArgument() or setArguments().
.PP
The readyReadStdout() signal is emitted when there is new data on standard output. This happens asynchronously: you don't know if more data will arrive later. In the above example you could connect the processExited() signal to the slot UicManager::readFromStdout() instead. If you do so, you will be certain that all the data is available when the slot is called. On the other hand, you must wait until the process has finished before doing any processing.
.PP
See also QSocket, Input/Output and Networking and Miscellaneous Classes.
.SS "Member Type Documentation"
.SH "QProcess::Communication"
This enum type defines the communication channels connected to the process.
.TP
\fCQProcess::Stdin\fR - Data can be written to the process's standard input.
.TP
\fCQProcess::Stdout\fR - Data can be read from the process's standard output.
.TP
\fCQProcess::Stderr\fR - Data can be read from the process's standard error.
.TP
\fCQProcess::DupStderr\fR - Duplicates standard error to standard output for new processes; i.e. everything that the process writes to standard error, is reported by QProcess on standard output instead. This is especially useful if your application requires that the output on standard output and standard error is read in the same order as the process output it. Please note that this is a binary flag, so if you want to activate this together with standard input, output and error redirection (the default), you have to specify \fCStdin|Stdout|Stderr|DupStderr\fR for the setCommunication() call.
.PP
See also setCommunication() and communication().
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QProcess::QProcess ( QObject * parent = 0, const char * name = 0 )"
Constructs a QProcess object. The \fIparent\fR and \fIname\fR parameters are passed to the QObject constructor.
.PP
See also setArguments(), addArgument() and start().
.SH "QProcess::QProcess ( const QString & arg0, QObject * parent = 0, const char * name = 0 )"
Constructs a QProcess with \fIarg0\fR as the command to be executed. The \fIparent\fR and \fIname\fR parameters are passed to the QObject constructor.
.PP
The process is not started. You must call start() or launch() to start the process.
.PP
See also setArguments(), addArgument() and start().
.SH "QProcess::QProcess ( const QStringList & args, QObject * parent = 0, const char * name = 0 )"
Constructs a QProcess with \fIargs\fR as the arguments of the process. The first element in the list is the command to be executed. The other elements in the list are the arguments to this command. The \fIparent\fR and \fIname\fR parameters are passed to the QObject constructor.
.PP
The process is not started. You must call start() or launch() to start the process.
.PP
See also setArguments(), addArgument() and start().
.SH "QProcess::~QProcess ()"
Destroys the class.
.PP
If the process is running, it is NOT terminated! Standard input, standard output and standard error of the process are closed.
.PP
You can connect the destroyed() signal to the kill() slot, if you want the process to be terminated automatically when the class is destroyed.
.PP
See also tryTerminate() and kill().
.SH "void QProcess::addArgument ( const QString & arg )\fC [virtual]\fR"
Adds \fIarg\fR to the end of the list of arguments.
.PP
The first element in the list of arguments is the command to be executed; the following elements are the arguments to the command.
.PP
See also arguments() and setArguments().
.PP
Example: process/process.cpp.
.SH "QStringList QProcess::arguments () const"
Returns the list of arguments that are set for the process. Arguments can be specified with the constructor or with the functions setArguments() and addArgument().
.PP
Note that if you want to iterate over the list, you should iterate over a copy, e.g.
.PP
.nf
.br
    QStringList list = myProcess.arguments();
.br
    QStringList::Iterator it = list.begin();
.br
    while( it != list.end() ) {
.br
        myProcessing( *it );
.br
        ++it;
.br
    }
.br
.fi
.PP
See also setArguments() and addArgument().
.SH "bool QProcess::canReadLineStderr () const"
Returns TRUE if it's possible to read an entire line of text from standard error at this time; otherwise returns FALSE.
.PP
See also readLineStderr() and canReadLineStdout().
.SH "bool QProcess::canReadLineStdout () const"
Returns TRUE if it's possible to read an entire line of text from standard output at this time; otherwise returns FALSE.
.PP
See also readLineStdout() and canReadLineStderr().
.SH "void QProcess::clearArguments ()"
Clears the list of arguments that are set for the process.
.PP
See also setArguments() and addArgument().
.SH "void QProcess::closeStdin ()\fC [virtual slot]\fR"
Closes standard input of the process.
.PP
This function also deletes pending data that is not written to standard input yet.
.PP
See also wroteToStdin().
.SH "int QProcess::communication () const"
Returns the communication required with the process.
.PP
See also setCommunication().
.SH "int QProcess::exitStatus () const"
Returns the exit status of the process or 0 if the process is still running. This function returns immediately and does not wait until the process is finished.
.PP
If normalExit() is FALSE (e.g. if the program was killed or crashed), this function returns 0, so you should check the return value of normalExit() before relying on this value.
.PP
See also normalExit() and processExited().
.SH "bool QProcess::isRunning () const"
Returns TRUE if the process is running, otherwise FALSE.
.PP
See also normalExit(), exitStatus() and processExited().
.SH "void QProcess::kill () const\fC [slot]\fR"
Terminates the process. This is not a safe way to end a process since the process will not be able to do cleanup. tryTerminate() is a safer way to do it, but processes might ignore a tryTerminate().
.PP
The nice way to end a process and to be sure that it is finished, is doing something like this:
.PP
.nf
.br
    process->tryTerminate();
.br
    QTimer::singleShot( 5000, process, SLOT( kill() ) );
.br
.fi
.PP
This tries to terminate the process the nice way. If the process is still running after 5 seconds, it terminates the process the hard way. The timeout should be chosen depending on the time the process needs to do all the cleanup: use a higher value if the process is likely to do heavy computation on cleanup.
.PP
The slot returns immediately: it does not wait until the process has finished. When the process really exited, the signal processExited() is emitted.
.PP
See also tryTerminate() and processExited().
.SH "bool QProcess::launch ( const QByteArray & buf, QStringList * env = 0 )\fC [virtual]\fR"
Runs the process and writes the data \fIbuf\fR to the process's standard input. If all the data is written to standard input, standard input is closed. The command is searched for in the path for executable programs; you can also use an absolute path in the command itself.
.PP
If \fIenv\fR is null, then the process is started with the same environment as the starting process. If \fIenv\fR is non-null, then the values in the stringlist are interpreted as environment setttings of the form \fCkey=value\fR and the process is started with these environment settings. For convenience, there is a small exception to this rule under Unix: if \fIenv\fR does not contain any settings for the environment variable \fCLD_LIBRARY_PATH\fR, then this variable is inherited from the starting process.
.PP
Returns TRUE if the process could be started; otherwise returns FALSE.
.PP
Note that you should not use the slots writeToStdin() and closeStdin() on processes started with launch(), since the result is not well-defined. If you need these slots, use start() instead.
.PP
The process may or may not read the \fIbuf\fR data sent to its standard input.
.PP
You can call this function even when a process that was started with this instance is still running. Be aware that if you do this the standard input of the process that was launched first will be closed, with any pending data being deleted, and the process will be left to run out of your control. Similarly, if the process could not be started the standard input will be closed and the pending data deleted. (On operating systems that have zombie processes, Qt will also wait() on the old process.)
.PP
The object emits the signal launchFinished() when this function call is finished. If the start was successful, this signal is emitted after all the data has been written to standard input. If the start failed, then this signal is emitted immediately.
.PP
See also start() and launchFinished().
.SH "bool QProcess::launch ( const QString & buf, QStringList * env = 0 )\fC [virtual]\fR"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
The data \fIbuf\fR is written to standard input with writeToStdin() using the QString::local8Bit() representation of the strings.
.SH "void QProcess::launchFinished ()\fC [signal]\fR"
This signal is emitted when the process was started with launch(). If the start was successful, this signal is emitted after all the data has been written to standard input. If the start failed, then this signal is emitted immediately.
.PP
This signal is especially useful if you want to know when you can safely delete the QProcess object for the case that you are not intrested in reading from standard output or standard error.
.PP
See also launch() and QObject::deleteLater().
.SH "bool QProcess::normalExit () const"
Returns TRUE if the process has exited normally; otherwise returns FALSE. This implies that this function returns FALSE if the process is still running.
.PP
See also isRunning(), exitStatus() and processExited().
.SH "void QProcess::processExited ()\fC [signal]\fR"
This signal is emitted when the process has exited.
.PP
See also isRunning(), normalExit(), exitStatus(), start() and launch().
.PP
Example: process/process.cpp.
.SH "PID QProcess::processIdentifier ()"
Returns platform dependent information about the process. This can be used together with platform specific system calls.
.PP
Under Unix the return value is the PID of the process, or -1 if no process is belonging to this object.
.PP
Under Windows it is a pointer to the \fCPROCESS_INFORMATION\fR struct, or 0 if no process is belonging to this object.
.SH "QString QProcess::readLineStderr ()\fC [virtual]\fR"
Reads a line of text from standard error, excluding any trailing newline or carriage return characters and returns it. Returns QString::null if canReadLineStderr() returns FALSE.
.PP
See also canReadLineStderr(), readyReadStderr(), readStderr() and readLineStdout().
.SH "QString QProcess::readLineStdout ()\fC [virtual]\fR"
Reads a line of text from standard output, excluding any trailing newline or carriage return characters, and returns it. Returns QString::null if canReadLineStdout() returns FALSE.
.PP
See also canReadLineStdout(), readyReadStdout(), readStdout() and readLineStderr().
.SH "QByteArray QProcess::readStderr ()\fC [virtual]\fR"
Reads the data that the process has written to standard error. When new data is written to standard error, the class emits the signal readyReadStderr().
.PP
If there is no data to read, this function returns a QByteArray of size 0: it does not wait until there is something to read.
.PP
See also readyReadStderr(), readLineStderr(), readStdout() and writeToStdin().
.SH "QByteArray QProcess::readStdout ()\fC [virtual]\fR"
Reads the data that the process has written to standard output. When new data is written to standard output, the class emits the signal readyReadStdout().
.PP
If there is no data to read, this function returns a QByteArray of size 0: it does not wait until there is something to read.
.PP
See also readyReadStdout(), readLineStdout(), readStderr() and writeToStdin().
.PP
Example: process/process.cpp.
.SH "void QProcess::readyReadStderr ()\fC [signal]\fR"
This signal is emitted when the process has written data to standard error. You can read the data with readStderr().
.PP
Note that this signal is only emitted when there is new data and not when there is old, but unread data. In the slot connected to this signal, you should always read everything that is available at that moment to make sure that you don't lose any data.
.PP
See also readStderr(), readLineStderr() and readyReadStdout().
.SH "void QProcess::readyReadStdout ()\fC [signal]\fR"
This signal is emitted when the process has written data to standard output. You can read the data with readStdout().
.PP
Note that this signal is only emitted when there is new data and not when there is old, but unread data. In the slot connected to this signal, you should always read everything that is available at that moment to make sure that you don't lose any data.
.PP
See also readStdout(), readLineStdout() and readyReadStderr().
.PP
Example: process/process.cpp.
.SH "void QProcess::setArguments ( const QStringList & args )\fC [virtual]\fR"
Sets \fIargs\fR as the arguments for the process. The first element in the list is the command to be executed. The other elements in the list are the arguments to the command. Any previous arguments are deleted.
.PP
QProcess does not make any substitution of the arguments: if you specify "*" or "$DISPLAY", these values are passed to the process literally. If you want to have the same behavior as on the shell, you have to do the substitution yourself; i.e. instead of specifying a "*" you have to specify the list of all filenames and instead of the "$DISPLAY" you have to specify the value of the environment variable \fCDISPLAY\fR. The same applies for Windows, although a literal "*" as an argument is usually understood and substituted by Windows programs.
.PP
See also arguments() and addArgument().
.SH "void QProcess::setCommunication ( int commFlags )"
Sets \fIcommFlags\fR as the communication required with the process.
.PP
\fIcommFlags\fR is a bitwise OR between the flags defined in Communication.
.PP
The default is \fCStdin|Stdout|Stderr\fR.
.PP
See also communication().
.SH "void QProcess::setWorkingDirectory ( const QDir & dir )\fC [virtual]\fR"
Sets \fIdir\fR as the working directory for a process. This does not affect running processes; only processes that are started afterwards are affected.
.PP
Setting the working directory is especially useful for processes that try to access files with relative filenames.
.PP
See also workingDirectory() and start().
.SH "bool QProcess::start ( QStringList * env = 0 )\fC [virtual]\fR"
Tries to run a process for the command and arguments that were specified with setArguments(), addArgument() or that were specified in the constructor. The command is searched in the path for executable programs; you can also use an absolute path to the command.
.PP
If \fIenv\fR is null, then the process is started with the same environment as the starting process. If \fIenv\fR is non-null, then the values in the stringlist are interpreted as environment setttings of the form \fCkey=value\fR and the process is started in these environment settings. For convenience, there is a small exception to this rule: under Unix, if \fIenv\fR does not contain any settings for the environment variable \fCLD_LIBRARY_PATH\fR, then this variable is inherited from the starting process; under Windows the same applies for the environment variable \fCPATH\fR.
.PP
Returns TRUE if the process could be started, otherwise FALSE.
.PP
You can write data to standard input of the process with writeToStdin(), you can close standard input with closeStdin() and you can terminate the process tryTerminate() resp. kill().
.PP
You can call this function even when there already is a running process in this object. In this case, QProcess closes standard input of the old process and deletes pending data, i.e., you loose all control over that process, but the process is not terminated. This applies also if the process could not be started. (On operating systems that have zombie processes, Qt will also wait() on the old process.)
.PP
See also launch() and closeStdin().
.PP
Example: process/process.cpp.
.SH "void QProcess::tryTerminate () const\fC [slot]\fR"
Asks the process to terminate. Processes can ignore this wish. If you want to be sure that the process really terminates, you must use kill() instead.
.PP
The slot returns immediately: it does not wait until the process has finished. When the process really exited, the signal processExited() is emitted.
.PP
See also kill() and processExited().
.SH "QDir QProcess::workingDirectory () const"
Returns the working directory that was set with setWorkingDirectory(), or the current directory if none has been set.
.PP
See also setWorkingDirectory() and QDir::current().
.SH "void QProcess::writeToStdin ( const QByteArray & buf )\fC [virtual slot]\fR"
Writes the data \fIbuf\fR to the standard input of the process. The process may or may not read this data.
.PP
This function returns immediately; the QProcess class might write the data at a later point (you have to enter the event loop for that). When all the data is written to the process, the signal wroteToStdin() is emitted. This does not mean that the process really read the data, since this class only detects when it was able to write the data to the operating system.
.PP
See also wroteToStdin(), closeStdin(), readStdout() and readStderr().
.SH "void QProcess::writeToStdin ( const QString & buf )\fC [virtual slot]\fR"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
The string \fIbuf\fR is handled as text using the QString::local8Bit() representation.
.SH "void QProcess::wroteToStdin ()\fC [signal]\fR"
This signal is emitted if the data sent to standard input (via writeToStdin()) was actually written to the process. This does not imply that the process really read the data, since this class only detects when it was able to write the data to the operating system. But it is now safe to close standard input without losing pending data.
.PP
See also writeToStdin() and closeStdin().

.SH "SEE ALSO"
.BR http://doc.trolltech.com/qprocess.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2001 Trolltech AS, http://www.trolltech.com.  See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
If you find a bug in Qt, please report it as described in
.BR http://doc.trolltech.com/bughowto.html .
Good bug reports help us to help you. Thank you.
.P
The definitive Qt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using Qt Assistant or with
a web browser. This man page is provided as a convenience for those
users who prefer man pages, although this format is not officially
supported by Trolltech. 
.P
If you find errors in this manual page, please report them to
.BR qt-bugs@trolltech.com .
Please include the name of the manual page (qprocess.3qt) and the Qt
version (3.0.3).