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