e9a52fb2473676756e034ce16cf2999ea0856da2
[tprouty/samba.git] / source / smbwrapper / README
1 This is a prelodable shared library that provides SMB client services
2 for existing executables. Using this you can simulate a smb
3 filesystem.
4
5 *** This is code under development. Some things don't work yet ***
6
7 Currently this code has only been tested on:
8
9 - Linux 2.0 with glibc2 (RH5.1)
10 - Linux 2.1 with glibc2
11 - Solaris 2.5.1 with gcc
12 - Solaris 2.6 with gcc
13 - SunOS 4.1.3 with gcc
14 - IRIX 6.4 with cc
15
16 It probably won't run on other systems without some porting.
17
18 To use it you need to do this:
19
20 1) build smbwrapper.so using the command "make smbwrapper"
21 3) run smbsh
22
23 You will be asked for a username and password. After that you will be
24 returned to a shell prompt. It is actually a subshell running with
25 smbwrapper enabled. You can confirm this by checking if the SMBW_USER
26 environment variable is defined.
27
28 Now try to access /smb/SERVER for some SMB server name and see what
29 happens. If you set SMBW_WORKGROUP to your workgroup or have workgroup
30 set in yoru smb.conf then listing /smb/ should list all SMB servers in
31 your workgroup.
32
33 Environment variables
34 ---------------------
35
36 SMBW_USER
37  This is usually set by smbsh but you can set it manually. It
38  specifies the username you will connect to servers with.
39
40 SMBW_PASSWORD
41  This is usually set by smbsh but you can set it manually. It
42  specifies the password used to connect to smb servers.
43
44 SMBW_DEBUG
45  This is an integer that controls the internal debug level of smbw. It
46  defaults to 0, which means no debug info.
47
48 SMBW_LOGFILE
49  The place where smbw debug logs are put. If this is not set then
50  stderr is used.
51
52 SMBW_PREFIX
53  The root of the SMB filesystem. This defaults to /smb/ but you can
54  set it to any name you like.
55
56 SMBW_WORKGROUP
57  This is the workgroup used for browsing (ie. listing machines in the
58  /smb/ directory). It defaults to the one set in smb.conf.
59
60
61 Things that I have tried and do seem to work include:
62
63   emacs, tar, ls, cmp, cp, rsync, du, cat, rm, mv, less, more, wc, head,
64   tail, bash, tcsh, mkdir, rmdir, vim, xedit, diff
65
66 things that I know don't work:
67  
68  anything executing from the share
69  anything that uses mmap
70  redirection within shells to smbsh files
71
72 If you want to help with the development of this code then join the
73 samba-technical mailing list.