source: trunk/client/src/help/readme.txt@ 544

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

Samba Client 2.1: doc changes

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