source: trunk-3.0/docs/manpages/smbsh.1@ 101

Last change on this file since 101 was 44, checked in by Paul Smedley, 18 years ago

Update source to 3.0.25b

File size: 6.4 KB
Line 
1.\"Generated by db2man.xsl. Don't modify this, modify the source.
2.de Sh \" Subsection
3.br
4.if t .Sp
5.ne 5
6.PP
7\fB\\$1\fR
8.PP
9..
10.de Sp \" Vertical space (when we can't use .PP)
11.if t .sp .5v
12.if n .sp
13..
14.de Ip \" List item
15.br
16.ie \\n(.$>=3 .ne \\$3
17.el .ne 3
18.IP "\\$1" \\$2
19..
20.TH "SMBSH" 1 "" "" ""
21.SH "NAME"
22smbsh - Allows access to remote SMB shares using UNIX commands
23.SH "SYNOPSIS"
24.HP 1
25smbsh [-W workgroup] [-U username] [-P prefix] [-R <name resolve order>] [-d <debug level>] [-l logdir] [-L libdir]
26.SH "DESCRIPTION"
27.PP
28This tool is part of the
29\fBsamba\fR(7)
30suite.
31.PP
32smbsh
33allows you to access an NT filesystem using UNIX commands such as
34ls,
35egrep, and
36rcp. You must use a shell that is dynamically linked in order for
37smbsh
38to work correctly.
39.SH "OPTIONS"
40.PP
41-W WORKGROUP
42.RS 3n
43Override the default workgroup specified in the workgroup parameter of the
44\fBsmb.conf\fR(5)
45file for this session. This may be needed to connect to some servers.
46.RE
47.PP
48-U username[%pass]
49.RS 3n
50Sets the SMB username or username and password. If this option is not specified, the user will be prompted for both the username and the password. If %pass is not specified, the user will be prompted for the password.
51.RE
52.PP
53-P prefix
54.RS 3n
55This option allows the user to set the directory prefix for SMB access. The default value if this option is not specified is
56\fBsmb\fR.
57.RE
58.PP
59-s <configuration file>
60.RS 3n
61The file specified contains the configuration details required by the server. The information in this file includes server-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide. See
62\fIsmb.conf\fR
63for more information. The default configuration file name is determined at compile time.
64.RE
65.PP
66-d|--debuglevel=level
67.RS 3n
68\fIlevel\fR
69is an integer from 0 to 10. The default value if this parameter is not specified is zero.
70.sp
71The higher this value, the more detail will be logged to the log files about the activities of the server. At level 0, only critical errors and serious warnings will be logged. Level 1 is a reasonable level for day-to-day running - it generates a small amount of information about operations carried out.
72.sp
73Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic.
74.sp
75Note that specifying this parameter here will override the
76
77parameter in the
78\fIsmb.conf\fR
79file.
80.RE
81.PP
82-R <name resolve order>
83.RS 3n
84This option is used to determine what naming services and in what order to resolve host names to IP addresses. The option takes a space-separated string of different name resolution options.
85.sp
86The options are: "lmhosts", "host", "wins" and "bcast". They cause names to be resolved as follows :
87.RS 3n
88.TP 3n
89\(bu
90\fBlmhosts\fR: Lookup an IP address in the Samba lmhosts file. If the line in lmhosts has no name type attached to the NetBIOS name (see the
91\fBlmhosts\fR(5)
92for details) then any name type matches for lookup.
93.TP 3n
94\(bu
95\fBhost\fR: Do a standard host name to IP address resolution, using the system
96\fI/etc/hosts\fR, NIS, or DNS lookups. This method of name resolution is operating system dependent, for instance on IRIX or Solaris this may be controlled by the
97\fI/etc/nsswitch.conf \fR
98file). Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored.
99.TP 3n
100\(bu
101\fBwins\fR: Query a name with the IP address listed in the
102\fIwins server\fR
103parameter. If no WINS server has been specified this method will be ignored.
104.TP 3n
105\(bu
106\fBbcast\fR: Do a broadcast on each of the known local interfaces listed in the
107\fIinterfaces\fR
108parameter. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet.
109.RE
110.IP "" 3n
111If this parameter is not set then the name resolve order defined in the
112\fIsmb.conf\fR
113file parameter () will be used.
114.sp
115The default order is lmhosts, host, wins, bcast. Without this parameter or any entry in the
116
117parameter of the
118\fIsmb.conf\fR
119file, the name resolution methods will be attempted in this order.
120.RE
121.PP
122-L libdir
123.RS 3n
124This parameter specifies the location of the shared libraries used by
125smbsh. The default value is specified at compile time.
126.RE
127.SH "EXAMPLES"
128.PP
129To use the
130smbsh
131command, execute
132smbsh
133from the prompt and enter the username and password that authenticates you to the machine running the Windows NT operating system.
134
135.sp
136
137.nf
138
139system% \fBsmbsh\fR
140Username: \fBuser\fR
141Password: \fBXXXXXXX\fR
142
143.fi
144
145.PP
146Any dynamically linked command you execute from this shell will access the
147\fI/smb\fR
148directory using the smb protocol. For example, the command
149ls /smb
150will show a list of workgroups. The command
151ls /smb/MYGROUP
152will show all the machines in the workgroup MYGROUP. The command
153ls /smb/MYGROUP/<machine-name>
154will show the share names for that machine. You could then, for example, use the
155cd
156command to change directories,
157vi
158to edit files, and
159rcp
160to copy files.
161.SH "VERSION"
162.PP
163This man page is correct for version 3.0 of the Samba suite.
164.SH "BUGS"
165.PP
166smbsh
167works by intercepting the standard libc calls with the dynamically loaded versions in
168\fI smbwrapper.o\fR. Not all calls have been "wrapped", so some programs may not function correctly under
169smbsh.
170.PP
171Programs which are not dynamically linked cannot make use of
172smbsh's functionality. Most versions of UNIX have a
173file
174command that will describe how a program was linked.
175.SH "SEE ALSO"
176.PP
177\fBsmbd\fR(8),
178\fBsmb.conf\fR(5)
179.SH "AUTHOR"
180.PP
181The original Samba software and related utilities were created by Andrew Tridgell. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed.
182.PP
183The original Samba man pages were written by Karl Auer. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at
184ftp://ftp.icce.rug.nl/pub/unix/) and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.
185
Note: See TracBrowser for help on using the repository browser.