summaryrefslogtreecommitdiff
path: root/docs/htmldocs/smbsh.1.html
blob: 9cce85da75222166bec5fdbe66fd50712a1650c4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>smbsh</title><link rel="stylesheet" href="samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.60.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="smbsh.1"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>Name</h2><p>smbsh &#8212; Allows access to remote SMB shares
	using UNIX commands</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt class="command">smbsh</tt>  [-W workgroup] [-U username] [-P prefix] [-R &lt;name resolve order&gt;] [-d &lt;debug level&gt;] [-l logfile] [-L libdir]</p></div></div><div class="refsect1" lang="en"><h2>DESCRIPTION</h2><p>This tool is part of the <a href="Samba.7.html"><span class="citerefentry"><span class="refentrytitle">Samba</span>(7)</span></a> suite.</p><p><b class="command">smbsh</b> allows you to access an NT filesystem 
	using UNIX commands such as <b class="command">ls</b>, <b class="command">
	egrep</b>, and <b class="command">rcp</b>. You must use a 
	shell that is dynamically linked in order for <b class="command">smbsh</b> 
	to work correctly.</p></div><div class="refsect1" lang="en"><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-W WORKGROUP</span></dt><dd><p>Override the default workgroup specified in the 
		workgroup parameter of the <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a> file 
		for this session. This may be needed to connect to some 
		servers. </p></dd><dt><span class="term">-U username[%pass]</span></dt><dd><p>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.
		</p></dd><dt><span class="term">-P prefix</span></dt><dd><p>This option allows
		the user to set the directory prefix for SMB access. The 
		default value if this option is not specified is 
		<span class="emphasis"><em>smb</em></span>.
		</p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The 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 <tt class="filename">smb.conf</tt> for more information.
The default configuration file name is determined at 
compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i class="replaceable"><tt>debuglevel</tt></i> is an integer 
from 0 to 10.  The default value if this parameter is 
not specified is zero.</p><p>The 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.</p><p>Levels 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.</p><p>Note that specifying this parameter here will 
override the <a class="indexterm" name="id2802215"></a><i class="parameter"><tt>log level</tt></i> parameter
in the <tt class="filename">smb.conf</tt> file.</p></dd><dt><span class="term">-R &lt;name resolve order&gt;</span></dt><dd><p>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.</p><p>The options are: "lmhosts", "host", "wins" and "bcast". 
They cause names to be resolved as follows :</p><div class="itemizedlist"><ul type="disc"><li><p><tt class="constant">lmhosts</tt>: 
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 <a href="lmhosts.5.html"><span class="citerefentry"><span class="refentrytitle">lmhosts</span>(5)</span></a>	for details) 
then any name type matches for lookup.
</p></li><li><p><tt class="constant">host</tt>: 
Do a standard host name to IP address resolution, using
the system <tt class="filename">/etc/hosts</tt>, 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 <tt class="filename">/etc/nsswitch.conf
</tt> 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.
</p></li><li><p><tt class="constant">wins</tt>: 
Query a name with the IP address listed in the 
<i class="parameter"><tt>wins server</tt></i> parameter.  If no 
WINS server has been specified this method will be 
ignored.
</p></li><li><p><tt class="constant">bcast</tt>: 
Do a broadcast on each of the known local interfaces 
listed in the <i class="parameter"><tt>interfaces</tt></i>
parameter. This is the least reliable of the name 
resolution methods as it depends on the target host 
being on a locally connected subnet.
</p></li></ul></div><p>If this parameter is not set then the name resolve order 
defined in the <tt class="filename">smb.conf</tt> file parameter  
(<a class="indexterm" name="id2796281"></a><i class="parameter"><tt>name resolve order</tt></i>) will be used.
</p><p>The default order is lmhosts, host, wins, bcast. Without 
this parameter or any entry in the <a class="indexterm" name="id2796300"></a><i class="parameter"><tt>name resolve order</tt></i> parameter of the <tt class="filename">smb.conf</tt> file, the name 
resolution methods will be attempted in this order. </p></dd><dt><span class="term">-L libdir</span></dt><dd><p>This parameter specifies the location of the 
		shared libraries used by <b class="command">smbsh</b>. The default
		value is specified at compile time.
		</p></dd></dl></div></div><div class="refsect1" lang="en"><h2>EXAMPLES</h2><p>To use the <b class="command">smbsh</b> command, execute <b class="command">
	smbsh</b> from the prompt and enter the username and password 
	that authenticates you to the machine running the Windows NT 
	operating system.
</p><pre class="programlisting">
<tt class="prompt">system% </tt><b class="userinput"><tt>smbsh</tt></b>
<tt class="prompt">Username: </tt><b class="userinput"><tt>user</tt></b>
<tt class="prompt">Password: </tt><b class="userinput"><tt>XXXXXXX</tt></b>
</pre><p>Any dynamically linked command you execute from 
	this shell will access the <tt class="filename">/smb</tt> directory 
	using the smb protocol. For example, the command <b class="command">ls /smb
	</b> will show a list of workgroups. The command 
	<b class="command">ls /smb/MYGROUP </b> will show all the machines in 
	the  workgroup MYGROUP. The command 
	<b class="command">ls /smb/MYGROUP/&lt;machine-name&gt;</b> will show the share 
	names for that machine. You could then, for example, use the <b class="command">
	cd</b> command to change directories, <b class="command">vi</b> to 
	edit files, and <b class="command">rcp</b>  to copy files.</p></div><div class="refsect1" lang="en"><h2>VERSION</h2><p>This man page is correct for version 3.0 of the Samba suite.</p></div><div class="refsect1" lang="en"><h2>BUGS</h2><p><b class="command">smbsh</b> works by intercepting the standard 
	libc calls with the dynamically loaded versions in <tt class="filename">
	smbwrapper.o</tt>. Not all calls have been "wrapped", so 
	some programs may not function correctly under <b class="command">smbsh
	</b>.</p><p>Programs which are not dynamically linked cannot make 
	use of <b class="command">smbsh</b>'s functionality. Most versions 
	of UNIX have a <b class="command">file</b> command that will 
	describe how a program was linked.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="smbd.8.html"><span class="citerefentry"><span class="refentrytitle">smbd</span>(8)</span></a>, <a href="smb.conf.5.html"><span class="citerefentry"><span class="refentrytitle">smb.conf</span>(5)</span></a></p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>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.</p><p>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 <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
	ftp://ftp.icce.rug.nl/pub/unix/</a>) 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.</p></div></div></body></html>