import HEAD into svn+ssh://svn.samba.org/home/svn/samba/trunk
[metze/old/v3-2-winbind-ndr.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 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 - OSF1 with gcc
16
17
18 It probably won't run on other systems without some porting. If you
19 have a different system then see the file PORTING.
20
21 To use it you need to do this:
22
23 1) build smbwrapper.so using the command "make smbwrapper"
24 3) run smbsh
25
26 You will be asked for a username and password. After that you will be
27 returned to a shell prompt. It is actually a subshell running with
28 smbwrapper enabled. 
29
30 Now try to access /smb/SERVER for some SMB server name and see what
31 happens. If you use the -W option to set your workgroup or have
32 workgroup set in your smb.conf then listing /smb/ should list all SMB
33 servers in your workgroup.
34
35
36 OPTIONS
37 -------
38
39 -U username
40    specify the username and optional password (as user%password)
41
42 -d debug level
43  This is an integer that controls the internal debug level of smbw. It
44  defaults to 0, which means no debug info.
45
46 -l logfile
47  The place where smbw debug logs are put. If this is not set then
48  stderr is used.
49
50 -P prefix
51  The root of the SMB filesystem. This defaults to /smb/ but you can
52  set it to any name you like.
53
54 -W workgroup
55  This is the workgroup used for browsing (ie. listing machines in the
56  /smb/ directory). It defaults to the one set in smb.conf.
57
58 -R resolve order
59  This allows you to override the setting of the name resolve order
60  from smb.conf
61
62
63 ATTRIBUTE MAPPING
64 -----------------
65
66 smbwrapper does an inverse attribute maping to what Samba does. This
67 means that the archive bit appears as the user execute bit, the system
68 bit appears as the group execute bit and the hidden bit appears as the
69 other execute bit. You can control these with chmod. The mapping can
70 be enabled an disabled using the normal smb.conf controls (ie. "map
71 archive", "map system" and "map hidden").
72
73 Read-only files appear as non-writeable by everyone. Writeable files
74 appear as writeable by the current user.
75
76
77 WHAT WORKS
78 ----------
79
80 Things that I have tried and do seem to work include:
81
82   emacs, tar, ls, cmp, cp, rsync, du, cat, rm, mv, less, more, wc, head,
83   tail, bash, tcsh, mkdir, rmdir, vim, xedit, diff
84
85 things that I know don't work:
86  
87  anything executing from the share
88  anything that uses mmap
89  redirection within shells to smbsh files
90
91 If you want to help with the development of this code then join the
92 samba-technical mailing list.
93
94