source: branches/client-2.2/src/help/readme.txt@ 1036

Last change on this file since 1036 was 554, checked in by Silvan Scherrer, 15 years ago

Samba Client 2.1: fixes in textfiles

File size: 6.7 KB
Line 
1#include <nversion.h>
2 Samba Client Plugin for <$OS>
3 Version <$NDPSMB_VERSION>
4 Build <$NDPSMB_BUILD>
5 __________________________________
6
7CONTENTS
8________
9
10 1. Introduction
11 2. License
12 3. Installation
13 3.1 <$ND>
14 3.2 EVFS
15 3.3 Uninstallation
16 4. NDPSMB.DLL usage
17 4.1 <$ND>
18 4.2 EVFS
19 5. Debugging
20 6. Changelog
21
22
231. Introduction
24_______________
25
26Samba is a SMB/CIFS protocols file and print sharing server/client suite
27originally made for the UNIX world to cooperate with corresponding Windows and
28<$OS> servers or clients. <$OS> has a native implementation of SMB/CIFS
29server/client set - IBM LAN Manager and IBM Peer. These products haven't been
30updated for a long time and have some compatibility problems with modern
31Windows SMB/CIFS implementations.
32
33This package is the <$OS> port of Samba client made as the plugin for
34
35- <$ND> for <$OS> - a well known virtual file system for <$OS> or
36- EVFS - the eComStation Virtual Filesystem for SMB.
37
38<$OS> Samba client provides seamless access to SMB/CIFS file shares over
39your network using TCP/IP as the underlying transport protocol.
40
41The <$OS> Samba client consists of one module:
42 ndpsmb.dll - the <$ND>/EVFS plugin itself.
43
44Releases prior to version 1.5.0 had a second module which is now deprecated:
45 smbcd.exe - the Samba client daemon, which actually processes the requests
46 from ndpsmb.dll
47
482. License
49__________
50
51Samba is freely available under the GNU General Public License. You can get
52the full sourcecode from our SVN repository, please refer to the Samba for
53<$OS> Homepage for details about downloading the source.
54
55The <$ND> plugin is also available with full sourcecode.
56
57So if you are using our plugin we kindly ask you to support netlabs.org.
58Please refer to the Samba for <$OS> Homepage to learn how you can do
59that!
60
61
62Links:
63
64Samba for <$OS> Homepage: http://samba.netlabs.org/
65<$ND> Homepage: http://www.blueprintsoftwareworks.com/netdrive/
66Samba Homepage: http://www.samba.org/
67
68
693. Installation
70_______________
71
72The plugin needs the klibc runtime named libc06*.dll (the innotek gcc runtime
73DLL) somewhere in your LIBPATH, if it is not there already (It comes with any
74recent eComStation release).
75The plugin needs the 32 bit TCP/IP stack. This stack comes with all eComStation
76releases. If you have still the 16 bit stack, please search the net for the
7732 bit stack.
78
793.1 <$ND>
80____________
81
82You must have <$ND> 2.2.1 or newer installed prior to installation of this
83package. If you want to use 64bit file API, you should install 2.3 or newer
84version of <$ND>. The installation is semi-automatic and consists of the
85following:
86
87 - ndpsmb.dll installation :
88 Run instpl.cmd from this package. It will place all files to the <$ND>
89 plugin directory.
90
913.2 EVFS
92________
93
94 - ndpsmb.dll installation :
95 Put ndpsmb.dll into x:\ecs\dll (where x: is your bootdrive)
96
973.3 Uninstallation
98__________________
99
100Run the uninstpl.cmd script in order to deinstall the plugin again.
101This will work for both EVFS and <$ND>.
102
1034. NDPSMB.DLL
104_____________
105
106
1074.1. Usage with <$ND>
108______________________
109
110<$ND> Samba plugin is used according to general <$ND> usage rules. Read
111the <$ND> documentation for more information. The SMB/CIFS resources could
112be mounted either using command line nd.exe utility or WPS ndpm.exe utility
113of <$ND>.
114
115The <$ND> Samba plugin parameters are:
116
117 workgroup - the name of workgroup to connect to.
118 server - the name of server to connect to.
119 share - the name of server resource (share) to connect to.
120 user - the name of user to login under.
121 password - the password of selected user.
122 master - the name of 'master' server or workgroup, used to get the
123 list of workgroups when the concrete workgroup and server
124 not specified.
125 masterttype - 0 if 'master' is the name of master server, 1 if 'master'
126 is the name of master workgroup.
127 cache timeout - the time in seconds for which the cache is valid. If the
128 time is over the client rereads the directory again. For a
129 directory with many files it may be better to increase the
130 timeout. (rule of thumb: per 500-800 files 10 seconds).
131 Default: 10 seconds
132 cache listings- the amount of directories the cache should hold. Be aware:
133 the higher the value the more memory is used.
134 Default: 32 listings
135 easupport - 1 to support <$OS> Extended Attributes, 0 to not support it
136 r/w - define whether the resource should be read-only (r) or
137 writeable (w)
138
139To mount the exact server's share one need to specify both 'server' and
140'share' parameters, the other parameters are optional. The root path of
141server's share will be mounted to the mounting path.
142
143If one want to access all server shares, then only the 'server', not the
144'share' parameter, should be specified,the other parameters are optional.
145The list of server shares will be mounted to the mounting path.
146
147If one want to access all servers within the workgroup, then only the
148'workgroup', not the 'server' parameter, should be specified, the other
149parameters are optional. The list of servers within the specified workgroup
150will be mounted to the mounting path.
151
152If one want to access all available workgroups within one master browser
153within the network, then only the 'master', not the 'workgroup' nor the
154'server' parameter, should be specified, the other parameters are optional.
155The list of workgroups will be mounted to the mounting path. The 'master'
156workgroup can be any known workgroup in the net. The 'master' server should
157be the master browser for workgroup[s].
158
159By default the 'guest' user with blank password is used to access selected
160resources. If you get access denied errors, try to specify another user
161and password combination.
162
1634.2 Usage with EVFS
164___________________
165
166eComStation comes with a GUI program named EVFSGUI which is even more feature
167rich than the <$ND> GUI. EFVSGUI can also be used together with <$ND>.
168Refer to the documentaion that comes with eCS.
169
1705. Debugging
171____________
172
173To produce a logfile please add an empty file called ndpsmb.dbg into the
174root drive.
175
176The logfile is placed to your LOGFILES env path, if available. If the
177LOGFILES environment variable is missing, the logfile is placed into the
178<$ND> directory. The logfile is called log.ndpsmb for the <$ND> part
179and log.smbc for the Samba part.
180
181
1826. Changelog
183____________
184
185#include <changelog.txt>
Note: See TracBrowser for help on using the repository browser.