git.maemo.org Git - samba/blob - docs/manpages/libsmbclient.7

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "LIBSMBCLIENT" 7 "" "" ""
  21 .SH NAME
  22 libsmbclient \- An extension library for browsers and that can be used as a generic browsing API.
  23 .SH "SYNOPSIS"
  24 .ad l
  25 .hy 0
  26 .HP 13
  27 \fBBrowser URL:\fR
  28 .PP
  29 smb://[[[domain:]user[:password@]]server[/share[/path[/file]]]] [?options]
  30
  31 .ad
  32 .hy
  33
  34 .SH "DESCRIPTION"
  35
  36 .PP
  37 This tool is part of the \fBsamba\fR(7) suite\&.
  38
  39 .PP
  40 \fBlibsmbclient\fR is 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's can be manipulated, and so on\&. Of course, its functionality includes all the capabilities commonly called browsing\&.
  41
  42 .PP
  43 \fBlibsmbclient\fR can 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\&.
  44
  45 .SH "OPTIONS"
  46
  47 .PP
  48 What the URLs mean:
  49
  50 .TP
  51 smb://
  52 Shows all workgroups or domains that are visible in the network\&. The behavior matches that of the Microsoft Windows Explorer\&.
  53
  54 The method of locating the list of workgroups (domains also) varies depending on the setting of the context variable (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 querried\&. 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\&.
  55
  56 .TP
  57 smb://name/
  58 This 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\&.
  59
  60 .PP
  61 When libsmbclient is invoked by an application it searches for a directory called\fI\&.smb\fR in the $HOME directory that is specified in the users shell environment\&. It then searches for a file called \fIsmb\&.conf\fR which, if present, will fully over\-ride the system \fI/etc/samba/smb\&.conf\fR file\&. If instead libsmbclient finds a file called \fI~/\&.smb/smb\&.conf\&.append\fR, it will read the system \fI/etc/samba/smb\&.conf\fR and then append the contents of the \fI~/\&.smb/smb\&.conf\&.append\fR to it\&.
  62
  63 .PP
  64 \fBlibsmbclient\fR will check the users shell environment for the USER parameter and will use its value when if the user parameter was not included in the URL\&.
  65
  66 .SH "PROGRAMMERS GUIDE"
  67
  68 .PP
  69 Watch this space for future updates\&.
  70
  71 .SH "VERSION"
  72
  73 .PP
  74 This man page is correct for version 3\&.0 of the Samba suite\&.
  75
  76 .SH "AUTHOR"
  77
  78 .PP
  79 The 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\&.
  80
  81 .PP
  82 The libsmbclient manpage page was written by John H Terpstra\&.
  83