usr/src/man/man3c/system.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  45 .\" Copyright (c) 2006, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\"
  47 .TH SYSTEM 3C "Dec 14, 2006"
  48 .SH NAME
  49 system \- issue a shell command
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <stdlib.h>
  54
  55 \fBint\fR \fBsystem\fR(\fBconst char *\fR\fIstring\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBsystem()\fR function causes \fIstring\fR to be given to the shell as
  62 input, as if \fIstring\fR had been typed as a command at a terminal. The
  63 invoker waits until the shell has completed, then returns the exit status of
  64 the shell in the format specified by \fBwaitpid\fR(3C).
  65 .sp
  66 .LP
  67 If \fIstring\fR is a null pointer, \fBsystem()\fR checks if the shell exists
  68 and is executable.  If the shell is available, \fBsystem()\fR returns a
  69 non-zero value; otherwise, it returns \fB0\fR.
  70 .sp
  71 .LP
  72 The \fBsystem()\fR function sets the \fBSIGINT\fR and \fBSIGQUIT\fR signals to
  73 be ignored, and blocks the \fBSIGCHLD\fR signal for the calling thread, while
  74 waiting for the command to terminate. The \fBsystem()\fR function does not
  75 affect the termination status of any child of the calling processes other than
  76 the process it creates.
  77 .sp
  78 .LP
  79 The termination status of the process created by the \fBsystem()\fR function is
  80 not affected by the actions of other threads in the calling process (it is
  81 invisible to \fBwait\fR(3C)) or by the disposition of the \fBSIGCHLD\fR signal
  82 in the calling process, even if it is set to be ignored. No \fBSIGCHLD\fR
  83 signal is sent to the process containing the calling thread when the command
  84 terminates.
  85 .SH RETURN VALUES
  86 .sp
  87 .LP
  88 The \fBsystem()\fR function executes \fBposix_spawn\fR(3C) to create a child
  89 process running the shell that in turn executes the commands in \fIstring\fR.
  90 If \fBposix_spawn()\fR fails, \fBsystem()\fR returns \fB\(mi1\fR and sets
  91 \fBerrno\fR to indicate the error; otherwise the exit status of the shell is
  92 returned.
  93 .SH ERRORS
  94 .sp
  95 .LP
  96 The \fBsystem()\fR function may set \fBerrno\fR values as described by
  97 \fBfork\fR(2), in particular:
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBEAGAIN\fR\fR
 102 .ad
 103 .RS 10n
 104 A resource control or  limit on the total number of  processes, tasks or LWPs
 105 under execution by a single user,  task,  project, or  zone has been exceeded,
 106 or the total amount of system memory available  is temporarily insufficient to
 107 duplicate this process.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBENOMEM\fR\fR
 114 .ad
 115 .RS 10n
 116 There is not enough swap space.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBEPERM\fR\fR
 123 .ad
 124 .RS 10n
 125 The  {\fBPRIV_PROC_FORK\fR} privilege is  not asserted in the effective set of
 126 the calling process.
 127 .RE
 128
 129 .SH USAGE
 130 .sp
 131 .LP
 132 The \fBsystem()\fR function manipulates the signal handlers for \fBSIGINT\fR
 133 and \fBSIGQUIT\fR. It is therefore not safe to call \fBsystem()\fR in a
 134 multithreaded process, since some other thread that manipulates these signal
 135 handlers and a thread that concurrently calls \fBsystem()\fR can interfere with
 136 each other in a destructive manner.  If, however, no such other thread is
 137 active, \fBsystem()\fR can safely be called concurrently from multiple threads.
 138 See \fBpopen\fR(3C) for an alternative to \fBsystem()\fR that is thread-safe.
 139 .SH ATTRIBUTES
 140 .sp
 141 .LP
 142 See \fBattributes\fR(5) for descriptions of the following attributes:
 143 .sp
 144
 145 .sp
 146 .TS
 147 box;
 148 c | c
 149 l | l .
 150 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 151 _
 152 Interface Stability     Standard
 153 _
 154 MT-Level        Unsafe
 155 .TE
 156
 157 .SH SEE ALSO
 158 .sp
 159 .LP
 160 \fBksh\fR(1), \fBsh\fR(1), \fBpopen\fR(3C), \fBposix_spawn\fR(3C),
 161 \fBwait\fR(3C), \fBwaitpid\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)