| 1 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>libsmbclient</title><link rel="stylesheet" href="../samba.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="libsmbclient.7"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>libsmbclient — An extension library for browsers and that can be used as a generic browsing API.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><p>
|
|---|
| 2 | Browser URL:
|
|---|
| 3 | <code class="literal">smb://[[[domain:]user[:password@]]server[/share[/path[/file]]]] [?options]
|
|---|
| 4 | </code>
|
|---|
| 5 | </p></p></div></div><div class="refsect1" lang="en"><a name="id2522909"></a><h2>DESCRIPTION</h2><p>
|
|---|
| 6 | 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.
|
|---|
| 7 | </p><p>
|
|---|
| 8 | <code class="literal">libsmbclient</code> is a library toolset that permits applications to manipulate CIFS/SMB network
|
|---|
| 9 | resources using many of the standards POSIX functions available for manipulating local UNIX/Linux files. It
|
|---|
| 10 | permits much more than just browsing, files can be opened and read or written, permissions changed, file times
|
|---|
| 11 | modified, attributes and ACL's can be manipulated, and so on. Of course, its functionality includes all the
|
|---|
| 12 | capabilities commonly called browsing.
|
|---|
| 13 | </p><p>
|
|---|
| 14 | <code class="literal">libsmbclient</code> can not be used directly from the command line, instead it provides an
|
|---|
| 15 | extension of the capabilities of tools such as file managers and browsers. This man page describes the
|
|---|
| 16 | configuration options for this tool so that the user may obtain greatest utility of use.
|
|---|
| 17 | </p></div><div class="refsect1" lang="en"><a name="id2483328"></a><h2>OPTIONS</h2><p>
|
|---|
| 18 | What the URLs mean:
|
|---|
| 19 | </p><div class="variablelist"><dl><dt><span class="term">smb://</span></dt><dd><p>
|
|---|
| 20 | Shows all workgroups or domains that are visible in the network. The behavior matches
|
|---|
| 21 | that of the Microsoft Windows Explorer.
|
|---|
| 22 | </p><p>
|
|---|
| 23 | The method of locating the list of workgroups (domains also) varies depending on the setting of
|
|---|
| 24 | the context variable <code class="literal">(context->options.browse_max_lmb_count)</code>. It is the
|
|---|
| 25 | responsibility of the application that calls this library to set this to a sensible value. This
|
|---|
| 26 | is a compile-time option. This value determines the maximum number of local master browsers to
|
|---|
| 27 | query for the list of workgroups. In order to ensure that the list is complete for those present
|
|---|
| 28 | on the network, all master browsers must be querried. If there are a large number of workgroups
|
|---|
| 29 | on the network, the time spent querying will be significant. For small networks (just a few
|
|---|
| 30 | workgroups), it is suggested to set this value to 0, instructing libsmbclient to query all local
|
|---|
| 31 | master browsers. In an environment that has many workgroups a more reasonable setting may be around 3.
|
|---|
| 32 | </p></dd><dt><span class="term">smb://name/</span></dt><dd><p>
|
|---|
| 33 | This command causes libsmbclient to perform a name look-up. If the NAME<1D> or
|
|---|
| 34 | NAME<1B> exists (workgroup name), libsmbclient will list all servers in the
|
|---|
| 35 | workgroup (or domain). Otherwise, a name look-up for the NAME<20> (machine name)
|
|---|
| 36 | will be performed, and the list of shared resources on the server will be displayed.
|
|---|
| 37 | </p></dd></dl></div><p>
|
|---|
| 38 | When libsmbclient is invoked by an application it searches for a directory called
|
|---|
| 39 | <code class="filename">.smb</code> in the $HOME directory that is specified in the users shell
|
|---|
| 40 | environment. It then searches for a file called <code class="filename">smb.conf</code> which,
|
|---|
| 41 | if present, will fully over-ride the system <code class="filename">/etc/samba/smb.conf</code> file. If
|
|---|
| 42 | instead libsmbclient finds a file called <code class="filename">~/.smb/smb.conf.append</code>,
|
|---|
| 43 | it will read the system <code class="filename">/etc/samba/smb.conf</code> and then append the
|
|---|
| 44 | contents of the <code class="filename">~/.smb/smb.conf.append</code> to it.
|
|---|
| 45 | </p><p>
|
|---|
| 46 | <code class="literal">libsmbclient</code> will check the users shell environment for the <code class="literal">USER</code>
|
|---|
| 47 | parameter and will use its value when if the <code class="literal">user</code> parameter was not included
|
|---|
| 48 | in the URL.
|
|---|
| 49 | </p></div><div class="refsect1" lang="en"><a name="id2483594"></a><h2>PROGRAMMERS GUIDE</h2><p>
|
|---|
| 50 | Watch this space for future updates.
|
|---|
| 51 | </p></div><div class="refsect1" lang="en"><a name="id2483605"></a><h2>VERSION</h2><p>
|
|---|
| 52 | This man page is correct for version 3 of the Samba suite.
|
|---|
| 53 | </p></div><div class="refsect1" lang="en"><a name="id2483616"></a><h2>AUTHOR</h2><p>
|
|---|
| 54 | The original Samba software and related utilities were created by Andrew Tridgell.
|
|---|
| 55 | Samba is now developed by the Samba Team as an Open Source project similar to the way
|
|---|
| 56 | the Linux kernel is developed.
|
|---|
| 57 | </p><p>
|
|---|
| 58 | The libsmbclient manpage page was written by John H Terpstra.
|
|---|
| 59 | </p></div></div></body></html>
|
|---|
