diff options
Diffstat (limited to 'src/lib/libc/stdlib/system.3')
| -rw-r--r-- | src/lib/libc/stdlib/system.3 | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/src/lib/libc/stdlib/system.3 b/src/lib/libc/stdlib/system.3 new file mode 100644 index 0000000000..985adb07de --- /dev/null +++ b/src/lib/libc/stdlib/system.3 | |||
| @@ -0,0 +1,98 @@ | |||
| 1 | .\" Copyright (c) 1990, 1991 The Regents of the University of California. | ||
| 2 | .\" 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 | .\" $OpenBSD: system.3,v 1.5 1996/12/11 23:09:53 tholo Exp $ | ||
| 37 | .\" | ||
| 38 | .Dd June 29, 1991 | ||
| 39 | .Dt SYSTEM 3 | ||
| 40 | .Os | ||
| 41 | .Sh NAME | ||
| 42 | .Nm system | ||
| 43 | .Nd pass a command to the shell | ||
| 44 | .Sh SYNOPSIS | ||
| 45 | .Fd #include <stdlib.h> | ||
| 46 | .Ft int | ||
| 47 | .Fn system "const char *string" | ||
| 48 | .Sh DESCRIPTION | ||
| 49 | The | ||
| 50 | .Fn system | ||
| 51 | function | ||
| 52 | hands the argument | ||
| 53 | .Fa string | ||
| 54 | to the command interpreter | ||
| 55 | .Xr sh 1 . | ||
| 56 | The calling process waits for the shell to finish executing the command, | ||
| 57 | ignoring | ||
| 58 | .Dv SIGINT | ||
| 59 | and | ||
| 60 | .Dv SIGQUIT , | ||
| 61 | and blocking | ||
| 62 | .Dv SIGCHLD . | ||
| 63 | .Pp | ||
| 64 | If | ||
| 65 | .Fa string | ||
| 66 | is a | ||
| 67 | .Dv NULL | ||
| 68 | pointer, | ||
| 69 | .Fn system | ||
| 70 | will return non-zero. | ||
| 71 | Otherwise, | ||
| 72 | .Fn system | ||
| 73 | returns the termination status of the shell in the format specified by | ||
| 74 | .Xr waitpid 2 . | ||
| 75 | .Sh RETURN VALUES | ||
| 76 | If a child process cannot be created, or the termination status of | ||
| 77 | the shell cannot be obtained, | ||
| 78 | .Fn system | ||
| 79 | returns -1 and sets | ||
| 80 | .Va errno | ||
| 81 | to indicate the error. | ||
| 82 | If execution of the shell fails, | ||
| 83 | .Fn system | ||
| 84 | returns the termination status for a program that terminates with a call of | ||
| 85 | .Fn exit 127 . | ||
| 86 | .Sh SEE ALSO | ||
| 87 | .Xr sh 1 , | ||
| 88 | .Xr execve 2 , | ||
| 89 | .Xr waitpid 2 , | ||
| 90 | .Xr popen 3 | ||
| 91 | .Sh STANDARDS | ||
| 92 | The | ||
| 93 | .Fn system | ||
| 94 | function | ||
| 95 | conforms to | ||
| 96 | .St -ansiC | ||
| 97 | and | ||
| 98 | .St -p1003.2-92 . | ||
