lib/replace/README

   1 This subsystem ensures that we can always use a certain core set of
   2 functions and types, that are either provided by the OS or by replacement
   3 functions / definitions in this subsystem. The aim is to try to stick
   4 to POSIX functions in here as much as possible. Convenience functions
   5 that are available on no platform at all belong in other subsystems
   6 (such as LIBUTIL).
   7
   8 The following functions are guaranteed:
   9
  10 ftruncate
  11 strlcpy
  12 strlcat
  13 mktime
  14 rename
  15 initgroups
  16 memmove
  17 strdup
  18 setlinebuf
  19 vsyslog
  20 timegm
  21 setenv
  22 unsetenv
  23 strndup
  24 strnlen
  25 waitpid
  26 seteuid
  27 setegid
  28 asprintf
  29 snprintf
  30 vasprintf
  31 vsnprintf
  32 opendir
  33 readdir
  34 telldir
  35 seekdir
  36 clock_gettime
  37 closedir
  38 dlopen
  39 dlclose
  40 dlsym
  41 dlerror
  42 chroot
  43 bzero
  44 strerror
  45 errno
  46 mkdtemp
  47 mkstemp (a secure one!)
  48 pread
  49 pwrite
  50 chown
  51 lchown
  52 getpass
  53 readline (the library)
  54 inet_ntoa
  55 inet_ntop
  56 inet_pton
  57 inet_aton
  58 strtoll
  59 strtoull
  60 socketpair
  61 strptime
  62 getaddrinfo
  63 freeaddrinfo
  64 getnameinfo
  65 gai_strerror
  66 getifaddrs
  67 freeifaddrs
  68 utime
  69 utimes
  70 dup2
  71 link
  72 readlink
  73 symlink
  74 realpath
  75 poll
  76
  77 Types:
  78 bool
  79 socklen_t
  80 uint{8,16,32,64}_t
  81 int{8,16,32,64}_t
  82 intptr_t
  83 sig_atomic_t
  84 blksize_t
  85 blkcnt_t
  86
  87 Constants:
  88 PATH_NAME_MAX
  89 UINT{16,32,64}_MAX
  90 INT32_MAX
  91 RTLD_LAZY
  92 HOST_NAME_MAX
  93 UINT16_MAX
  94 UINT32_MAX
  95 UINT64_MAX
  96 CHAR_BIT
  97
  98 Macros:
  99 va_copy
 100 __FUNCTION__
 101 __FILE__
 102 __LINE__
 103 __LINESTR__
 104 __location__
 105 __STRING
 106 __STRINGSTRING
 107 MIN
 108 MAX
 109 QSORT_CAST
 110 ZERO_STRUCT
 111 ZERO_STRUCTP
 112 ZERO_STRUCTPN
 113 ZERO_ARRAY
 114 ARRAY_SIZE
 115 PTR_DIFF
 116
 117 Headers:
 118 stdint.h
 119 stdbool.h
 120
 121 Optional C keywords:
 122 volatile
 123
 124 Prerequisites:
 125 memset (for bzero)
 126 syslog (for vsyslog)
 127 mktemp (for mkstemp and mkdtemp)