1<?xml version="1.0" encoding="iso-8859-1"?> 2<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc"> 3<refentry id="libsmbclient.7"> 4 5<refmeta> 6 <refentrytitle>libsmbclient</refentrytitle> 7 <manvolnum>7</manvolnum> 8 <refmiscinfo class="source">Samba</refmiscinfo> 9 <refmiscinfo class="manual">7</refmiscinfo> 10 <refmiscinfo class="version">3.5</refmiscinfo> 11</refmeta> 12 13 14<refnamediv> 15 <refname>libsmbclient</refname> 16 <refpurpose>An extension library for browsers and that can be used as a generic browsing API.</refpurpose> 17</refnamediv> 18 19<refsynopsisdiv> 20 <cmdsynopsis> 21 <para> 22 Browser URL: 23 <command moreinfo="none">smb://[[[domain:]user[:password@]]server[/share[/path[/file]]]] [?options] 24 </command> 25 </para> 26 </cmdsynopsis> 27</refsynopsisdiv> 28 29 30<refsect1> 31 <title>DESCRIPTION</title> 32 33 <para> 34 This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle> 35 <manvolnum>7</manvolnum></citerefentry> suite. 36 </para> 37 38 <para> 39 <command>libsmbclient</command> is a library toolset that permits applications to manipulate CIFS/SMB network 40 resources using many of the standards POSIX functions available for manipulating local UNIX/Linux files. It 41 permits much more than just browsing, files can be opened and read or written, permissions changed, file times 42 modified, attributes and ACL's can be manipulated, and so on. Of course, its functionality includes all the 43 capabilities commonly called browsing. 44 </para> 45 46 <para> 47 <command>libsmbclient</command> can not be used directly from the command line, instead it provides an 48 extension of the capabilities of tools such as file managers and browsers. This man page describes the 49 configuration options for this tool so that the user may obtain greatest utility of use. 50 </para> 51</refsect1> 52 53<refsect1> 54 <title>OPTIONS</title> 55 56 <para> 57 What the URLs mean: 58 </para> 59 60 <variablelist> 61 <varlistentry> 62 <term>smb://</term> 63 <listitem><para> 64 Shows all workgroups or domains that are visible in the network. The behavior matches 65 that of the Microsoft Windows Explorer. 66 </para> 67 68 <para> 69 The method of locating the list of workgroups (domains also) varies depending on the setting of 70 the context variable <literal>(context->options.browse_max_lmb_count)</literal>. It is the 71 responsibility of the application that calls this library to set this to a sensible value. This 72 is a compile-time option. This value determines the maximum number of local master browsers to 73 query for the list of workgroups. In order to ensure that the list is complete for those present 74 on the network, all master browsers must be querried. If there are a large number of workgroups 75 on the network, the time spent querying will be significant. For small networks (just a few 76 workgroups), it is suggested to set this value to 0, instructing libsmbclient to query all local 77 master browsers. In an environment that has many workgroups a more reasonable setting may be around 3. 78 </para></listitem> 79 </varlistentry> 80 81 <varlistentry> 82 <term>smb://name/</term> 83 <listitem><para> 84 This command causes libsmbclient to perform a name look-up. If the NAME<1D> or 85 NAME<1B> exists (workgroup name), libsmbclient will list all servers in the 86 workgroup (or domain). Otherwise, a name look-up for the NAME<20> (machine name) 87 will be performed, and the list of shared resources on the server will be displayed. 88 </para></listitem> 89 </varlistentry> 90 </variablelist> 91 92 <para> 93 When libsmbclient is invoked by an application it searches for a directory called 94 <filename>.smb</filename> in the $HOME directory that is specified in the users shell 95 environment. It then searches for a file called <filename>smb.conf</filename> which, 96 if present, will fully over-ride the system <filename>/etc/samba/smb.conf</filename> file. If 97 instead libsmbclient finds a file called <filename>~/.smb/smb.conf.append</filename>, 98 it will read the system <filename>/etc/samba/smb.conf</filename> and then append the 99 contents of the <filename>~/.smb/smb.conf.append</filename> to it. 100 </para> 101 102 <para> 103 <command>libsmbclient</command> will check the users shell environment for the <literal>USER</literal> 104 parameter and will use its value when if the <literal>user</literal> parameter was not included 105 in the URL. 106 </para> 107 108</refsect1> 109 110<refsect1> 111 <title>PROGRAMMERS GUIDE</title> 112 113 <para> 114 Watch this space for future updates. 115 </para> 116 117</refsect1> 118 119<refsect1> 120 <title>VERSION</title> 121 122 <para> 123 This man page is correct for version 3 of the Samba suite. 124 </para> 125</refsect1> 126 127<refsect1> 128 <title>AUTHOR</title> 129 130 <para> 131 The original Samba software and related utilities were created by Andrew Tridgell. 132 Samba is now developed by the Samba Team as an Open Source project similar to the way 133 the Linux kernel is developed. 134 </para> 135 136 <para> 137 The libsmbclient manpage page was written by John H Terpstra. 138 </para> 139</refsect1> 140 141</refentry> 142