compiler/posixc/background.c

   1 /*
   2     Copyright © 2013, The AROS Development Team. All rights reserved.
   3
   4     This file is there to provide a background section in the Autodocs
   5     for the stdc.library
   6 */
   7
   8 /*******************************************************************************
   9
  10     NAME
  11         --background_POSIX--
  12
  13     NOTES
  14         On AROS standardized C interfaces are implemented with a few shared
  15         libraries. A distinction is made between a standard ANSI-C/ISO-C
  16         part and a POSIX emulation layer.
  17         Here the POSIX part is documented.
  18
  19         The posixc.library is a shared library that implements (part of) the C
  20         interface for POSIX.1-2008 on AROS and the standard document is used
  21         as guideline for this implementation.
  22         Purpose of this library is to implement a POSIX compliant compatibility
  23         layer. Currently no full implementation of the POSIX layer is provided
  24         but enough to port a lot of POSIX compliant or LINUX code over to AROS.
  25         As this library has overhead in implementatio 'real' AROS/Amiga programs
  26         should not depend on this library.
  27
  28         Also some non-standard or legacy POSIX functions are provided by the
  29         library. If possible they are put in the static link library so the
  30         functions can be removed in the future without breaking backwards
  31         compatibility.
  32         When porting code it is then preferred to patch the source code to use
  33         the POSIX.1-2008 version of files or provide a local version of some
  34         of the functions.
  35
  36         The include files provided for the POSIX code implement a proper
  37         separation of the include files. The includes should only define the
  38         prototypes, constants etc.  as defined by the standard. This means
  39         includes like proto/posixc.h should not be included in the standard
  40         POSIX include files. Developers improving or extending these libraries
  41         should keep this in mind.
  42
  43         In order to use the posixc.library programs need to properly initialize
  44         the library using the __posixc_nixmain() function. It is assumed that
  45         this is taken care of by the startup code provided by the compiler.
  46
  47     SEE ALSO
  48         stdc.library/--background_C99--
  49
  50
  51 *******************************************************************************/