lib/libc/stdlib/system.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" the American National Standards Committee X3, on Information
   6 .\" Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)system.3    8.1 (Berkeley) 6/4/93
  37 .\" $FreeBSD: src/lib/libc/stdlib/system.3,v 1.6.2.4 2001/12/14 18:33:58 ru Exp $
  38 .\" $DragonFly: src/lib/libc/stdlib/system.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  39 .\"
  40 .Dd June 4, 1993
  41 .Dt SYSTEM 3
  42 .Os
  43 .Sh NAME
  44 .Nm system
  45 .Nd pass a command to the shell
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In stdlib.h
  50 .Ft int
  51 .Fn system "const char *string"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn system
  55 function
  56 hands the argument
  57 .Fa string
  58 to the command interpreter
  59 .Xr sh 1 .
  60 The calling process waits for the shell
  61 to finish executing the command,
  62 ignoring
  63 .Dv SIGINT
  64 and
  65 .Dv SIGQUIT ,
  66 and blocking
  67 .Dv SIGCHLD .
  68 .Pp
  69 If
  70 .Fa string
  71 is a
  72 .Dv NULL
  73 pointer,
  74 .Fn system
  75 will return non-zero if the command interpreter
  76 .Xr sh 1
  77 is available, and zero if it is not.
  78 .Pp
  79 The
  80 .Fn system
  81 function
  82 returns the exit status of the shell as returned by
  83 .Xr waitpid 2 ,
  84 or \-1 if an error occurred when invoking
  85 .Xr fork 2
  86 or
  87 .Xr waitpid 2 .
  88 A return value of 127 means the execution of the shell
  89 failed.
  90 .Sh SEE ALSO
  91 .Xr sh 1 ,
  92 .Xr execve 2 ,
  93 .Xr fork 2 ,
  94 .Xr waitpid 2 ,
  95 .Xr popen 3
  96 .Sh STANDARDS
  97 The
  98 .Fn system
  99 function
 100 conforms to
 101 .St -isoC .
 102 and is expected to be
 103 .St -p1003.2
 104 compatible.