GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  EXPLAIN_SYSTEM_OR_DIE (3)

NAME

explain_system_or_die - execute a shell command and report errors

CONTENTS

Synopsis
Description
See Also
Copyright

SYNOPSIS

#include <libexplain/system.h>

void explain_system_or_die(const char *command);
void explain_system_success_or_die(const char *command);
int explain_system_success(const char *command);

DESCRIPTION

These functions may be used to execute commands via the I]system(3) function, and report the results.

    explain_system_or_die

void explain_system_or_die(const char *command);

The B]explain_system_or_die function is used to call the I]system(3) system call. On failure an explanation will be printed to I]stderr, obtained from I]explain_system(3), and then the process terminates by calling CW]exit(EXIT_FAILURE).

This function is intended to be used in a fashion similar to the following example:

int status = explain_system_or_die(command);

I]command
  The command, exactly as to be passed to the I]system(3) system call.
Returns: This function only returns on success, see I]system(3) for more information. On failure, prints an explanation and exits.

    explain_system_success_or_die

void explain_system_success_or_die(const char *command);

The B]explain_system_success_or_die function is used to call the I]system(3) system call. On failure, including any exit status other than EXIT_SUCCESS, an explanation will be printed to I]stderr, obtained from I]explain_system(3), and then the process terminates by calling CW]exit(EXIT_FAILURE).

This function is intended to be used in a fashion similar to the following example:

explain_system_success_or_die(command);

I]command
  The command, exactly as to be passed to the I]system(3) system call.
Returns: This function only returns on success. On failure, prints an explanation and exits.

    explain_system_success

int explain_system_success(const char *command);

The B]explain_system_success function is used to call the I]system(3) system call. On failure, including any exit status other than EXIT_SUCCESS, an explanation will be printed to I]stderr, obtained from I]explain_system(3). However, the priniting of an error message does B]not also cause I]exit(2) to be called.

This function is intended to be used in a fashion similar to the following example:

int status = explain_system_success(command);

I]command
  The command, exactly as to be passed to the I]system(3) system call.
Returns: the value returned by the I]system(3) system call. In all cases other than EXIT_SUCCESS, an error message will also have been printed to stderr.

SEE ALSO

I]system(3)
  execute a shell command
I]explain_system(3)
  explain I]system(3) errors
I]exit(2) terminate the calling process

COPYRIGHT

libexplain version 1.3
Copyright © 2008 Peter Miller
Search for    or go to Top of page |  Section 3 |  Main Index


EXPLAIN_SYSTEM_OR_DIE (3) -->

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.