Debian Codegraph @

COSMIC/DOC/README

raw
1
2 S I M P L E S O C K E T S L I B R A R Y
3 ----------- ------------- -------------
4 Charles E. Campbell, Jr. PhD.
5 Terry McRoberts
6
7 =====================================================================
8
9 1. Current Version: 7c Tue Aug 23 09:03:41 EDT 2005
10
11 (an [a-z] suffix to your version number indicates that you have
12 received a beta copy of the next release).
13
14 2. The Simple Sockets Library is public domain, and therefore may be copied and
15 distributed freely.
16
17 3. You should have the following files:
18
19 Makefile -- UNIX makefile -> simpleskts.a and executables
20 Makelib. -- MSDOS/MicroSoft Library making commands
21 Makeskt.bat -- MSDOS "makefile" -> smplskts.lib and executables
22 Makeskt.com -- VMS "makefile" -> simpleskts.lib and executables
23
24 -- Sockets Library Functions <sockets.h>
25 Saccept.c -- generate an Accept Socket from a Server Socket
26 Sclose.c -- close any kind of Socket
27 Sgets.c -- get a null-byte-terminated string from a Socket
28 Smaskwait.c -- mask (group of) Socket support: Smaskwait Smaskset etc
29 Smkskt.c -- internal: make a Socket
30 Sopen.c -- open a Server or Client Socket
31 Sopenv.c -- open a Server or Client Socket over a machine path
32 Speek.c -- peek on a Socket
33 Speeraddr.c -- returns the peer's IP address
34 Speername.c -- returns the peer's name (a string)
35 Sprintf.c -- print formatted i/o to a Socket
36 Sprtskt.c -- return a string describing a Socket
37 Sputs.c -- put a null-byte-terminated string onto a Socket
38 Sread.c -- read available bytes from a Socket
39 Sreadbytes.c -- read specified qty of bytes from a Socket
40 Srmsrvr.c -- forcibly remove a Server from the PortMaster
41 Sscanf.c -- read formatted i/o from a Socket
42 Stest.c -- test if anything is available on a Socket
43 Stimeoutwait.c -- set timeout parameters for Smaskwait
44 Svprintf.c -- "vprintf" for a Socket
45 Swait.c -- wait on a Socket
46 Swrite.c -- write bytes onto a Socket
47
48 -- "Extended I/O" Library Support <xtdio.h>
49 cprt.c -- make a character into a visible string
50 error.c -- give ***error***/warning/note messages
51 fopenv.c -- fopen with search along an environment variable path
52 outofmem.c -- check if memory allocation succeeded
53 rdcolor.c -- make GREEN, UYELLOW, etc escape-sequence strings
54 rdcolor.dat -- specifies GREEN etc escape-sequences for various terminals
55 sprt.c -- make a string into a completely-visible'ized version
56 srmtrblk.c -- remove trailing white space from a string
57 stpblk.c -- return a ptr to first non-white-space character
58 stpnxt.c -- return a ptr past a format-code specified (ex. %d) string
59 strnxtfmt.c -- returns a ptr to the end of a format code
60
61 ./DOC:
62 History -- History, differences, and updates file
63 README -- This file
64 porting.doc -- Directions on how to port the Simple Sockets Library
65 (sockets.ps -- PostScript document source, not always distributed)
66 sockets.tex -- LaTeX document source, used to create <sockets.ps>
67
68 ./EXAMPLES:
69 multiskt.c -- Multiple client example program
70 oobrecv.c -- How to receive out-of-band data
71 oobsend.c -- How to send out-of-band data
72 sktpoll.c -- Client polling for a server to open example
73 sktsig.c -- Sockets and SIGIO handling (unix)
74 smclient.c -- A real small client example
75 smsrvr.c -- A real small server example
76 Makefile -- Used to make these examples
77
78 ./EXE:
79 Spm.c -- The PortMaster
80 sktdbg.c -- Simple Sockets Library Debugger
81 spmchk.c -- PortMaster presence detector:
82 Returns 0/1 status for testing if the PortMaster is running
83 spmtable.c -- Gets tables of current servers the PortMaster has
84 srmsrvr.c -- Remove servers from a PortMaster
85 Makefile -- Used to make these utilities
86
87 ./HDR:
88 rdcolor.h -- BLACK, RED, GREEN, ... support
89 sockets.h -- The Simple Sockets Library header file
90 xstdlib.h -- For those sorry machines without <stdlib.h>
91 xtdio.h -- "Extended I/O" Library (partial) header file
92
93 ./AS400: -- Steve Richard's AS/400 Port
94 ADUCBAT -- cl will compile library modules
95 ADUCBATB -- cl will compile and bind executables
96 AS400.NOTES -- notes on Steve Richard's modifications
97 READ.ME -- file containing explanation of scripts
98 RUNAU17 -- Spm will auto-start a server
99 adusslbnd -- binder export file that crtsslsrv uses
100 crtsslsrv -- cl will create service program after module compiling
101 startau17w -- supports the RUNAU17 command
102
103 4. Check out <rdcolor.dat> for better use of color terminals. If your sktdbg,
104 for example, appears in monochrome, you may have to modify <rdcolor.dat> to
105 support your terminal. Some machines (such as PCs) may not have the
106 environment variable TERM set. More info on this is in <sockets.tex>.
107
108 5. The latest version is available via the web:
109 http://www.erols.com/astronaut/ssl
110
111 However, that website is due to change soon (by Sep 2004) to
112 http://www.verizon.net/astronaut/ssl
113
114 Charles E Campbell, Jr., Ph.D.