FILES

   1
   2 The socat distribution contains the following files:
   3
   4 * README: an introduction to socat
   5
   6 * FILES: a navigator through the socat distribution (this file)
   7
   8 * EXAMPLES: a collection of simple examples how to use socat.
   9
  10 * COPYING: what you and others are allowed to do with socat.
  11
  12 * PORTING: instructions and tips if you want to try socat on a new platform.
  13
  14 * BUGREPORTS: instructions what to do with problems and contributions.
  15
  16 * SECURITY: tips if you want to use socat in a security relevant environment.
  17
  18 * DEVELOPMENT: infos for programmers
  19
  20 * VERSION: the version of the socat distribution, for inclusion during
  21 compilation
  22
  23 * CHANGES: what happened since first public release
  24
  25 * socat.1: man page of socat
  26 * socat.html: html version of man page
  27 * xio.help: reference manual of the address definitions (xioopen function)
  28
  29 * daemon.sh: example shell script for running socat as TCP relay daemon
  30 * ftp.sh: example shell based ftp client, using socat for transport
  31 * mail.sh: example shell based smtp client, for execution by socat
  32
  33 * gatherinfo.sh: shell script for gathering info about platform and socat
  34 implementation
  35
  36 * server.pem: a self signed test cerificate, for self test only
  37
  38
  39 The source code system:
  40
  41 * configure: the autoconf generated configurator script
  42
  43 * Makefile.in: the Makefile source input to configure
  44
  45 * config.h.in: the config.h source input to configure
  46
  47 * Config/config.<platform>.h: sample config.h for platform.
  48 * Config/Makefile.<platform>: sample Makefile for platform.
  49 Copy the appropriate files to ./config.h and ./Makefile if configure fails
  50
  51 * socat.c: the main C source, including option parsing, general control, and
  52 the data shuffler
  53
  54 * xio-*.c, xio-*.h: the source of the different address type implementations
  55 with all their modes and options
  56
  57 * xio*.c, xio*.h: the source of the xio API and xio utilities
  58
  59 * filan.c, filan.h: file descriptor analyzer function
  60
  61 * dalan.c, dalan.h: data language, a most primitive subset of what should
  62 become a language for describing/generating all kinds of binary data.
  63
  64 * error.c, error.h: the logging subsystem
  65
  66 * sycls.c, sycls.h: explicit system call and C library trace functions
  67 * sslcls.c, sslcls.h: explicit openssl call trace functions
  68
  69 * xioconfig.h: ensures some dependencies between configure WITH defines; to be
  70 included immediately after config.h
  71
  72 * sysutils.c, sysutils.h: some more general system (socket, IP) related
  73 functions, e.g. converting socket addresses to human readable form
  74
  75 * utils.c, utils.h: useful additions to C library; currently memdup, binary
  76 search, and setenv.
  77
  78 * mytypes.h: some types and macros I miss in C89
  79
  80 * test.sh: an incomplete attempt to automate tests of socat
  81
  82 * compat.h: ensure some features that might be missing on some platforms