delete .cvsignore
[reactos.git] / rosapps / net / ncftp / libncftp / Readme.txt
1 Since you have the source distribution, you will need to compile the
2 libraries before you can install them.
3
4 UNIX INSTRUCTIONS:
5 ------------------
6
7 Go to the source directory you extracted (here). There is a script you
8 must run which will checks your system for certain features, so that the
9 library can be compiled on a variety of UNIX systems. Run this script
10 by typing "./configure" in that directory. After that, you can look at
11 the Makefile it made if you like, and then you run "make" to create the
12 "libncftp.a" and "libStrn.a" library files.
13
14 Finally, install the libraries and headers, by doing "make install".
15
16 View the libncftp.html file for the rest of the documentation. An easy
17 way to do that is use a URL of file://Localhost/path/to/libncftp.html
18 with your favorite browser.
19
20
21 WINDOWS INSTRUCTIONS:
22 ---------------------
23
24 You will need Visual C++ 6.0 or greater to build the library and sample
25 programs. This version includes two supplementary libraries which you
26 must build and link with your applications: a string utility library
27 (Strn) and a Winsock utility library (sio). Unlike the UNIX version of
28 LibNcFTP, where the library can be built with or without the sio library,
29 the sio library is required for the Windows version.
30
31 Keep the source hierarchy intact, so that the samples and libraries
32 build without problems. Build the Strn library first, then the sio
33 library, and then the LibNcFTP library. To do that, open the appropriate
34 .dsw file within Visual Studio, and then select "Rebuild All" from the
35 "Build" menu. Be sure to build both the Debug and the Release versions
36 for each library.
37
38 When that is complete you should be able to build the sample programs,
39 which are in the libncftp\samples directory.
40
41 View the libncftp.html file for the rest of the documentation. An easy
42 way to do that is use a URL of file://Localhost/path/to/libncftp.html
43 with your favorite browser. Note that there may be UNIX-specific
44 instructions which you should ignore.
45
46 To build your own applications using LibNcFTP, you'll need to make sure
47 you configure your project to find the header files and library files.
48
49 Your application may not use the sio or Strn libraries directly, but
50 you still need to link with them. For example, the "simpleget" sample
51 uses "..\..\Debug,..\..\..\Strn\Debug,..\..\..\sio\Debug" in the
52 project option for additional library paths for the linker, and
53 "kernel32.lib user32.lib gdi32.lib advapi32.lib shell32.lib
54 ws2_32.lib Strn.lib sio.lib libncftp.lib" for the list of libraries
55 to link with. Note that LibNcFTP uses advapi32 and shell32, in
56 addition to the usual "kernel32.lib user32.lib gdi32.lib". Of course,
57 it also needs to link with Winsock (ws2_32.lib).
58
59 Similarly, you'll need to make sure one of your additional include
60 directories points to the LibNcFTP directory containing ncftp.h. The
61 "simpleget" sample uses "..\.." since it is in a subdirectory of the
62 library itself. If you actually use functions from Strn or sio (as
63 some of the samples do), you'll need to have your project look in
64 their directories for their headers as well.
65
66 About Winsock2: This version of the library was designed for use with
67 Winsock version 2. Note that older versions of Windows 95 do not include
68 Winsock version 2, but can be upgraded by getting the updater from
69 Microsoft: http://www.microsoft.com/windows95/downloads/contents/wuadmintools/s_wunetworkingtools/w95sockets2/default.asp
70
71 However, the library should also work with Winsock 1.1. That is left as
72 an exercise to the coder to change the Winsock initialization to use 1.1
73 and to link with the 1.1 library (wsock32.lib).