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

Last change on this file since 963 was 962, checked in by Herwig Bauernfeind, 9 years ago

Samba Client 2.3: More changes to helpfiles and readme (DE,EN)

File size: 6.9 KB
Line 
1#include <nversion.h>
2 Samba Client Plugin for <$OS>
3 Version <$NDPSMB_VERSION> Build <$NDPSMB_BUILD>
4 _______________________________________________
5
6CONTENTS
7________
8
9 1. Introduction
10 2. License
11 3. Installation
12 3.1 <$ND>
13 3.2 EVFS
14 3.3 Uninstallation
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 either
57bww bitwise works or netlabs.org.
58Please refer to the Samba for <$OS> Homepage to learn how you can do that!
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) in your LIBPATH, it might be there already, as it comes with any
73eComStation release.
74The plugin requires the 32 bit TCP/IP stack. This stack comes with all
75eComStation releases. If you have still the 16 bit stack, please search the
76net for the 32 bit stack.
77
783.1 <$ND>
79____________
80
81You must have <$ND> 2.2.1 or newer installed prior to installation of this
82package. If you want to use 64bit file API, you should install 2.3 or newer
83version of <$ND>. The installation is semi-automatic and consists of the
84following:
85
86 - ndpsmb.dll installation :
87 Run instpl.cmd from this package. It will place all files to the <$ND>
88 plugin directory.
89
903.2 EVFS
91________
92
93 - ndpsmb.dll installation :
94 Put ndpsmb.dll into x:\ecs\dll (where x: is your bootdrive)
95
963.3 Uninstallation
97__________________
98
99Run the uninstpl.cmd script in order to deinstall the plugin again.
100This will work for both EVFS and <$ND>.
101
102
1034. NDPSMB.DLL
104_____________
105
1064.1. Usage with <$ND>
107______________________
108
109<$ND> Samba plugin is used according to general <$ND> usage rules. Read
110the <$ND> documentation for more information. The SMB/CIFS resources could
111be mounted either using command line nd.exe utility or WPS ndpm.exe utility
112of <$ND>.
113
114The <$ND> Samba plugin parameters are:
115
116 workgroup - the name of workgroup to connect to.
117 server - the name of server to connect to.
118 share - the name of server resource (share) to connect to.
119 user - the name of user to login under.
120 password - the password of selected user.
121 master - the name of 'master' server or workgroup, used to get the
122 list of workgroups when the concrete workgroup and server
123 not specified.
124 masterttype - 0 if 'master' is the name of master server, 1 if 'master'
125 is the name of master workgroup.
126 cache timeout - the time in seconds for which the cache is valid. If the
127 time is over the client rereads the directory again. For a
128 directory with many files it may be better to increase the
129 timeout. (rule of thumb: per 500-800 files 10 seconds).
130 Default: 10 seconds
131 cache listings- the amount of directories the cache should hold. Be aware:
132 the higher the value the more memory is used.
133 Default: 32 listings
134 easupport - 1 to support <$OS> Extended Attributes, 0 to not support it
135 r/w - define whether the resource should be read-only (r) or
136 writeable (w)
137 loglevel - determines the ammount of information writte into a logfile
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
173In order to produce a logfile, choose the appropriate loglevel in the login
174dialogue.
175
1760 = do not log 2 = log a little 5 = log quite some stuff 10 = log everything.
177
178The logfile is placed into your LOGFILES env path, if available. If the
179LOGFILES environment variable is missing, the logfile is placed into the
180<$ND> directory. The logfile is called log.ndpsmb.SHARE for the <$ND> part
181and log.smbc.SHARE for the Samba part. SHARE is the name of the connected share.
182
183
1846. Changelog
185____________
186
187#include <changelog.txt>
Note: See TracBrowser for help on using the repository browser.