Rebuild docs
[tprouty/samba.git] / docs / htmldocs / smbsh.1.html
1 <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.59.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 class="refnamediv"><h2>Name</h2><p>smbsh &#8212; Allows access to Windows NT filesystem 
2         using UNIX commands</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><tt>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">Samba(7)</a> suite.</p><p><b>smbsh</b> allows you to access an NT filesystem 
3         using UNIX commands such as <b>ls</b>, <b>
4         egrep</b>, and <b>rcp</b>. You must use a 
5         shell that is dynamically linked in order for <b>smbsh</b> 
6         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 
7                 workgroup parameter of the <a href="smb.conf.5.html">smb.conf(5)</a> file 
8                 for this session. This may be needed to connect to some 
9                 servers. </p></dd><dt><span class="term">-U username[%pass]</span></dt><dd><p>Sets the SMB username or username and password.
10                 If this option is not specified, the user will be prompted for 
11                 both the username and the password.  If %pass is not specified, 
12                 the user will be prompted for the password.
13                 </p></dd><dt><span class="term">-P prefix</span></dt><dd><p>This option allows
14                 the user to set the directory prefix for SMB access. The 
15                 default value if this option is not specified is 
16                 <span class="emphasis"><em>smb</em></span>.
17                 </p></dd><dt><span class="term">-s &lt;configuration file&gt;</span></dt><dd><p>The file specified contains the 
18 configuration details required by the server.  The 
19 information in this file includes server-specific
20 information such as what printcap file to use, as well 
21 as descriptions of all the services that the server is 
22 to provide. See <a href="smb.conf.5.html" target="_top"><tt>
23 smb.conf(5)</tt></a> for more information.
24 The default configuration file name is determined at 
25 compile time.</p></dd><dt><span class="term">-d|--debug=debuglevel</span></dt><dd><p><i><tt>debuglevel</tt></i> is an integer 
26 from 0 to 10.  The default value if this parameter is 
27 not specified is zero.</p><p>The higher this value, the more detail will be 
28 logged to the log files about the activities of the 
29 server. At level 0, only critical errors and serious 
30 warnings will be logged. Level 1 is a reasonable level for
31 day to day running - it generates a small amount of 
32 information about operations carried out.</p><p>Levels above 1 will generate considerable 
33 amounts of log data, and should only be used when 
34 investigating a problem. Levels above 3 are designed for 
35 use only by developers and generate HUGE amounts of log
36 data, most of which is extremely cryptic.</p><p>Note that specifying this parameter here will 
37 override the <a href="smb.conf.5.html#loglevel" target="_top">log
38 level</a> parameter in the <a href="smb.conf.5.html" target="_top">
39 <tt>smb.conf(5)</tt></a> 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 
40 services and in what order to resolve 
41 host names to IP addresses. The option takes a space-separated 
42 string of different name resolution options.</p><p>The options are: &quot;lmhosts&quot;, &quot;host&quot;, &quot;wins&quot; and &quot;bcast&quot;. 
43 They cause names to be resolved as follows :</p><div class="itemizedlist"><ul type="disc"><li><p><tt>lmhosts</tt>: 
44 Lookup an IP address in the Samba lmhosts file. If the 
45 line in lmhosts has no name type attached to the 
46 NetBIOS name 
47 (see the <a href="lmhosts.5.html">lmhosts(5)</a>        for details) 
48 then any name type matches for lookup.
49 </p></li><li><p><tt>host</tt>: 
50 Do a standard host name to IP address resolution, using
51 the system <tt>/etc/hosts</tt>, NIS, or DNS
52 lookups. This method of name resolution is operating 
53 system dependent, for instance on IRIX or Solaris this 
54 may be controlled by the <tt>/etc/nsswitch.conf
55 </tt> file).  Note that this method is only used 
56 if the NetBIOS name type being queried is the 0x20 
57 (server) name type, otherwise it is ignored.
58 </p></li><li><p><tt>wins</tt>: 
59 Query a name with the IP address listed in the 
60 <i><tt>wins server</tt></i> parameter.  If no 
61 WINS server has been specified this method will be 
62 ignored.
63 </p></li><li><p><tt>bcast</tt>: 
64 Do a broadcast on each of the known local interfaces 
65 listed in the <i><tt>interfaces</tt></i>
66 parameter. This is the least reliable of the name 
67 resolution methods as it depends on the target host 
68 being on a locally connected subnet.
69 </p></li></ul></div><p>If this parameter is not set then the name resolve order 
70 defined in the <a href="smb.conf.5.html">smb.conf(5)</a> file parameter  
71 (<i><tt>name resolve order</tt></i>) will be used. </p><p>The default order is lmhosts, host, wins, bcast. Without 
72 this parameter or any entry in the <i><tt>name resolve order
73 </tt></i> parameter of the <a href="smb.conf.5.html">smb.conf(5)</a> file, the name resolution methods 
74 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 
75                 shared libraries used by <b>smbsh</b>. The default
76                 value is specified at compile time.
77                 </p></dd></dl></div></div><div class="refsect1" lang="en"><h2>EXAMPLES</h2><p>To use the <b>smbsh</b> command, execute <b>
78         smbsh</b> from the prompt and enter the username and password 
79         that authenticates you to the machine running the Windows NT 
80         operating system.
81 </p><pre class="programlisting">
82 <tt>system% </tt><b><tt>smbsh</tt></b>
83 <tt>Username: </tt><b><tt>user</tt></b>
84 <tt>Password: </tt><b><tt>XXXXXXX</tt></b>
85 </pre><p>Any dynamically linked command you execute from 
86         this shell will access the <tt>/smb</tt> directory 
87         using the smb protocol. For example, the command <b>ls /smb
88         </b> will show a list of workgroups. The command 
89         <b>ls /smb/MYGROUP </b> will show all the machines in 
90         the  workgroup MYGROUP. The command 
91         <b>ls /smb/MYGROUP/&lt;machine-name&gt;</b> will show the share 
92         names for that machine. You could then, for example, use the <b>
93         cd</b> command to change directories, <b>vi</b> to 
94         edit files, and <b>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>smbsh</b> works by intercepting the standard 
95         libc calls with the dynamically loaded versions in <tt>
96         smbwrapper.o</tt>. Not all calls have been &quot;wrapped&quot;, so 
97         some programs may not function correctly under <b>smbsh
98         </b>.</p><p>Programs which are not dynamically linked cannot make 
99         use of <b>smbsh</b>'s functionality. Most versions 
100         of UNIX have a <b>file</b> command that will 
101         describe how a program was linked.</p></div><div class="refsect1" lang="en"><h2>SEE ALSO</h2><p><a href="smbd.8.html">smbd(8)</a>, <a href="smb.conf.5.html">smb.conf(5)</a></p></div><div class="refsect1" lang="en"><h2>AUTHOR</h2><p>The original Samba software and related utilities 
102         were created by Andrew Tridgell. Samba is now developed
103         by the Samba Team as an Open Source project similar 
104         to the way the Linux kernel is developed.</p><p>The original Samba man pages were written by Karl Auer. 
105         The man page sources were converted to YODL format (another 
106         excellent piece of Open Source software, available at <a href="ftp://ftp.icce.rug.nl/pub/unix/" target="_top">
107         ftp://ftp.icce.rug.nl/pub/unix/</a>) and updated for the Samba 2.0 
108         release by Jeremy Allison.  The conversion to DocBook for 
109         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
110         for Samba 3.0 was done by Alexander Bokovoy.</p></div></div></body></html>