source: trunk/samba/docs/htmldocs/manpages/libsmbclient.7.html @ 26

Last change on this file since 26 was 1, checked in by Paul Smedley, 14 years ago

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