.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "SMBSH" "1" "24 March 2003" "" ""

.SH NAME
smbsh \- Allows access to Windows NT filesystem  using UNIX commands
.SH SYNOPSIS

\fBsmbsh\fR [ \fB-W workgroup\fR ] [ \fB-U username\fR ] [ \fB-P prefix\fR ] [ \fB-R <name resolve order>\fR ] [ \fB-d <debug level>\fR ] [ \fB-l logfile\fR ] [ \fB-L libdir\fR ]

.SH "DESCRIPTION"
.PP
This tool is part of the \fBSamba\fR(7) suite.
.PP
\fBsmbsh\fR allows you to access an NT filesystem 
using UNIX commands such as \fBls\fR, \fB egrep\fR, and \fBrcp\fR. You must use a 
shell that is dynamically linked in order for \fBsmbsh\fR 
to work correctly.
.SH "OPTIONS"
.TP
\fB-W WORKGROUP\fR
Override the default workgroup specified in the 
workgroup parameter of the \fBsmb.conf\fR(5) file 
for this session. This may be needed to connect to some 
servers. 
.TP
\fB-U username[%pass]\fR
Sets 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.
.TP
\fB-P prefix\fR
This option allows
the user to set the directory prefix for SMB access. The 
default value if this option is not specified is 
\fBsmb\fR.
.TP
\fB-R <name resolve order>\fR
This 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.

The options are: "lmhosts", "host", "wins" and "bcast". 
They cause names to be resolved as follows :
.RS
.TP 0.2i
\(bu
lmhosts: 
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 \fBlmhosts\fR(5) for details) 
then any name type matches for lookup.
.TP 0.2i
\(bu
host: 
Do a standard host name to IP address resolution, using
the system \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 \fI/etc/nsswitch.conf
\fR file).  Note that this method is only used 
if the NetBIOS name type being queried is the 0x20 
(server) name type, otherwise it is ignored.
.TP 0.2i
\(bu
wins: 
Query a name with the IP address listed in the 
\fIwins server\fR parameter.  If no 
WINS server has been specified this method will be 
ignored.
.TP 0.2i
\(bu
bcast: 
Do a broadcast on each of the known local interfaces 
listed in the \fIinterfaces\fR
parameter. This is the least reliable of the name 
resolution methods as it depends on the target host 
being on a locally connected subnet.
.RE

If this parameter is not set then the name resolve order 
defined in the \fBsmb.conf\fR(5) file parameter  
(\fIname resolve order\fR) will be used. 

The default order is lmhosts, host, wins, bcast. Without 
this parameter or any entry in the \fIname resolve order
\fR parameter of the \fBsmb.conf\fR(5) file, the name resolution methods 
will be attempted in this order. 
.TP
\fB-d <debug level>\fR
debug level is an integer from 0 to 10.

The default value if this parameter is not specified
is zero.

The higher this value, the more detail will be logged
about the activities of \fBnmblookup\fR(1). At level
0, only critical errors and serious warnings will be logged.
.TP
\fB-l logfilename\fR
If specified causes all debug messages to be
written to the file specified by \fIlogfilename
\fR. If not specified then all messages will be 
written to\fIstderr\fR.
.TP
\fB-L libdir\fR
This parameter specifies the location of the 
shared libraries used by \fBsmbsh\fR. The default
value is specified at compile time.
.SH "EXAMPLES"
.PP
To use the \fBsmbsh\fR command, execute \fB smbsh\fR from the prompt and enter the username and password 
that authenticates you to the machine running the Windows NT 
operating system.

.nf
system% \fBsmbsh\fR
Username: \fBuser\fR
Password: \fBXXXXXXX\fR
.fi
.PP
Any dynamically linked command you execute from 
this shell will access the \fI/smb\fR directory 
using the smb protocol. For example, the command \fBls /smb
\fR will show a list of workgroups. The command 
\fBls /smb/MYGROUP \fR will show all the machines in 
the  workgroup MYGROUP. The command 
\fBls /smb/MYGROUP/<machine-name>\fR will show the share 
names for that machine. You could then, for example, use the \fB cd\fR command to change directories, \fBvi\fR to 
edit files, and \fBrcp\fR  to copy files.
.SH "VERSION"
.PP
This man page is correct for version 3.0 of the Samba suite.
.SH "BUGS"
.PP
\fBsmbsh\fR works by intercepting the standard 
libc calls with the dynamically loaded versions in \fI smbwrapper.o\fR. Not all calls have been "wrapped", so 
some programs may not function correctly under \fBsmbsh
\fR.
.PP
Programs which are not dynamically linked cannot make 
use of \fBsmbsh\fR's functionality. Most versions 
of UNIX have a \fBfile\fR command that will 
describe how a program was linked.
.SH "SEE ALSO"
.PP
\fBsmbd\fR(8), \fBsmb.conf\fR(5)
.SH "AUTHOR"
.PP
The 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.
.PP
The 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  ftp://ftp.icce.rug.nl/pub/unix/ <URL:ftp://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.