source: vendor/3.6.23/docs/manpages/libsmbclient.7

Last change on this file was 860, checked in by Silvan Scherrer, 11 years ago

Samba 3.6: updated vendor to latest version

File size: 4.6 KB
Line 
1'\" t
2.\" Title: libsmbclient
3.\" Author: [see the "AUTHOR" section]
4.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5.\" Date: 09/18/2013
6.\" Manual: 7
7.\" Source: Samba 3.6
8.\" Language: English
9.\"
10.TH "LIBSMBCLIENT" "7" "09/18/2013" "Samba 3\&.6" "7"
11.\" -----------------------------------------------------------------
12.\" * Define some portability stuff
13.\" -----------------------------------------------------------------
14.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15.\" http://bugs.debian.org/507673
16.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18.ie \n(.g .ds Aq \(aq
19.el .ds Aq '
20.\" -----------------------------------------------------------------
21.\" * set default formatting
22.\" -----------------------------------------------------------------
23.\" disable hyphenation
24.nh
25.\" disable justification (adjust text to left margin only)
26.ad l
27.\" -----------------------------------------------------------------
28.\" * MAIN CONTENT STARTS HERE *
29.\" -----------------------------------------------------------------
30.SH "NAME"
31libsmbclient \- An extension library for browsers and that can be used as a generic browsing API\&.
32.SH "SYNOPSIS"
33.HP \w'\ 'u
34.PP
35Browser URL:
36smb://[[[domain:]user[:password@]]server[/share[/path[/file]]]] [?options]
37.SH "DESCRIPTION"
38.PP
39This tool is part of the
40\fBsamba\fR(7)
41suite\&.
42.PP
43
44libsmbclient
45is a library toolset that permits applications to manipulate CIFS/SMB network resources using many of the standards POSIX functions available for manipulating local UNIX/Linux files\&. It permits much more than just browsing, files can be opened and read or written, permissions changed, file times modified, attributes and ACL\*(Aqs can be manipulated, and so on\&. Of course, its functionality includes all the capabilities commonly called browsing\&.
46.PP
47
48libsmbclient
49can not be used directly from the command line, instead it provides an extension of the capabilities of tools such as file managers and browsers\&. This man page describes the configuration options for this tool so that the user may obtain greatest utility of use\&.
50.SH "OPTIONS"
51.PP
52What the URLs mean:
53.PP
54smb://
55.RS 4
56Shows all workgroups or domains that are visible in the network\&. The behavior matches that of the Microsoft Windows Explorer\&.
57.sp
58The method of locating the list of workgroups (domains also) varies depending on the setting of the context variable
59(context\->options\&.browse_max_lmb_count)\&. It is the responsibility of the application that calls this library to set this to a sensible value\&. This is a compile\-time option\&. This value determines the maximum number of local master browsers to query for the list of workgroups\&. In order to ensure that the list is complete for those present on the network, all master browsers must be queried\&. If there are a large number of workgroups on the network, the time spent querying will be significant\&. For small networks (just a few workgroups), it is suggested to set this value to 0, instructing libsmbclient to query all local master browsers\&. In an environment that has many workgroups a more reasonable setting may be around 3\&.
60.RE
61.PP
62smb://name/
63.RS 4
64This command causes libsmbclient to perform a name look\-up\&. If the NAME<1D> or NAME<1B> exists (workgroup name), libsmbclient will list all servers in the workgroup (or domain)\&. Otherwise, a name look\-up for the NAME<20> (machine name) will be performed, and the list of shared resources on the server will be displayed\&.
65.RE
66.PP
67When libsmbclient is invoked by an application it searches for a directory called
68\&.smb
69in the $HOME directory that is specified in the users shell environment\&. It then searches for a file called
70smb\&.conf
71which, if present, will fully over\-ride the system
72/etc/samba/smb\&.conf
73file\&. If instead libsmbclient finds a file called
74~/\&.smb/smb\&.conf\&.append, it will read the system
75/etc/samba/smb\&.conf
76and then append the contents of the
77~/\&.smb/smb\&.conf\&.append
78to it\&.
79.PP
80
81libsmbclient
82will check the users shell environment for the
83USER
84parameter and will use its value when if the
85user
86parameter was not included in the URL\&.
87.SH "PROGRAMMERS GUIDE"
88.PP
89Watch this space for future updates\&.
90.SH "VERSION"
91.PP
92This man page is correct for version 3 of the Samba suite\&.
93.SH "AUTHOR"
94.PP
95The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.
96.PP
97The libsmbclient manpage page was written by John H Terpstra\&.
Note: See TracBrowser for help on using the repository browser.