diff options
Diffstat (limited to 'docs/yodldocs/smbclient.1.yo')
| -rw-r--r-- | docs/yodldocs/smbclient.1.yo | 179 |
1 files changed, 101 insertions, 78 deletions
diff --git a/docs/yodldocs/smbclient.1.yo b/docs/yodldocs/smbclient.1.yo index 41dbfc01fa..fc826db0ef 100644 --- a/docs/yodldocs/smbclient.1.yo +++ b/docs/yodldocs/smbclient.1.yo @@ -2,12 +2,15 @@ mailto(samba-bugs@samba.anu.edu.au) manpage(smbclient)(1)(23 Oct 1998)(Samba)(SAMBA) +label(NAME) manpagename(smbclient)(ftp-like client to access SMB/CIFS resources on servers) +label(SYNOPSIS) manpagesynopsis() bf(smbclient) service [password] [-s smb.conf] [-B IP addr] [-O socket_options][-R name resolve order] [-M NetBIOS name] [-i scope] [-N] [-n NetBIOS name] [-d debuglevel] [-P] [-p port] [-l log basename] [-h] [-I dest IP] [-E] [-U username] [-L NetBIOS name] [-t terminal code] [-m max protocol] [-W workgroup] [-T<c|x>IXFqgbNan] [-D directory] [-c command string] +label(DESCRIPTION) manpagedescription() This program is part of the bf(Samba) suite. @@ -18,6 +21,7 @@ offers an interface similar to that of the ftp program (see bf(ftp to the local machine, putting files from the local machine to the server, retrieving directory information from the server and so on. +label(OPTIONS) manpageoptions() startdit() @@ -66,11 +70,103 @@ dit(bf(-B IP addr)) The IP address to use when sending a broadcast packet. dit(bf(-O socket_options)) TCP socket options to set on the client socket. - DEBUG(0,("\t-R name resolve order use these name resolution services only\n")); - DEBUG(0,("\t-M host send a winpopup message to the host\n")); - DEBUG(0,("\t-i scope use this NetBIOS scope\n")); - DEBUG(0,("\t-N don't ask for a password\n")); - DEBUG(0,("\t-n netbios name. Use this name as my netbios name\n")); +dit(bf(-R name resolve order)) This option allows the user of +smbclient to determine what name resolution services to use when +looking up the NetBIOS name of the host being connected to. + +The options are :"lmhosts", "host", "wins" and "bcast". They cause +names to be resolved as follows : + +startit() + +it() bf(lmhosts) : Lookup an IP address in the Samba lmhosts file. + +it() bf(host) : Do a standard host name to IP address resolution, +using the system /etc/hosts, NIS, or DNS lookups. This method of name +resolution is operating system depended for instance on IRIX or +Solaris this may be controlled by the em(/etc/nsswitch.conf) file). + +it() bf(wins) : Query a name with the IP address listed in the bf(wins +server) parameter in the smb.conf file. If no WINS server has been +specified this method will be ignored. + +it() bf(bcast) : Do a broadcast on each of the known local interfaces +listed in the bf(interfaces) parameter in the smb.conf file. This is +the least reliable of the name resolution methods as it depends on the +target host being on a locally connected subnet. To specify a +particular broadcast address the bf(-B) option may be used. + +endit() + +The default order is lmhosts, host, wins, bcast and without this +parameter the name resolution methods will be attempted in this order. + +dit(bf(-M NetBIOS name)) This options allows you to send messages, +using the "WinPopup" protocol, to another computer. Once a connection +is established you then type your message, pressing ^D (control-D) to +end. + +If the receiving computer is running WinPopup the user will receive +the message and probably a beep. If they are not running WinPopup the +message will be lost, and no error message will occur. + +The message is also automatically truncated if the message is over +1600 bytes, as this is the limit of the protocol. + +One useful trick is to cat the message through bf(smbclient). +For example: + +tt(cat mymessage.txt | smbclient -M FRED) + +will send the message in the file em(mymessage.txt) to the machine FRED. + +You may also find the bf(-U) and bf(-I) options useful, as they allow +you to control the FROM and TO parts of the message. + +See the message command section of bf(smb.conf (5)) for a description +of how to handle incoming WinPopup messages in Samba. + +Note: Copy WinPopup into the startup group on your WfWg PCs if you +want them to always be able to receive messages. + +dit(bf(-i scope)) This specifies a NetBIOS scope that smbclient will use +to communicate with when generating NetBIOS names. For details on the +use of NetBIOS scopes, see rfc1001.txt and rfc1002.txt. NetBIOS scopes +are em(very) rarely used, only set this parameter if you are the +system administrator in charge of all the NetBIOS systems you +communicate with. + +dit(bf(-N)) If specified, this parameter suppresses the normal +password prompt from the client to the user. This is useful when +accessing a service that does not require a password. + +Unless a password is specified on the command line or this parameter +is specified, the client will request a password. + +dit(bf(-n NetBIOS name)) By default, the client will use the local +machine's hostname (in uppercase) as its NetBIOS name. This parameter +allows you to override the host name and use whatever NetBIOS name you +wish. + +dit(bf(-d debuglevel)) debuglevel is an integer from 0 to 10, or the +letter 'A'. + +The default value if this parameter is not specified is zero. + +The higher this value, the more detail will be logged to the log files +about the activities of the client. At level 0, only critical errors +and serious warnings will be logged. Level 1 is a reasonable level for +day to day running - it generates a small amount of information about +operations carried out. + +Levels above 1 will generate considerable amounts of log data, and should +only be used when investigating a problem. Levels above 3 are designed for +use only by developers and generate HUGE amounts of log data, most of which +is extremely cryptic. +.RE + + + DEBUG(0,("\t-d debuglevel set the debuglevel\n")); DEBUG(0,("\t-P connect to service as a printer\n")); DEBUG(0,("\t-p port connect to the specified port\n")); @@ -121,41 +217,7 @@ smbclient -L ftp -I ftp.microsoft.com will list the shares available on Microsoft's public server. .RE -.B \-M - .RS 3 -This options allows you to send messages, using the "WinPopup" -protocol, to another computer. Once a connection is established you -then type your message, pressing ^D (control-D) to end. - -If the receiving computer is running WinPopup the user will receive -the message and probably a beep. If they are not running WinPopup the -message will be lost, and no error message will occur. - -The message is also automatically truncated if the message is over -1600 bytes, as this is the limit of the protocol. - -One useful trick is to cat the message through -.BR smbclient . -For example: - -cat mymessage.txt | smbclient -M FRED - -will send the message in the file "mymessage.txt" to the machine FRED. - -You may also find the -.B \-U -and -.B \-I -options useful, as they allow you to -control the FROM and TO parts of the message. - -See the message command section of -.BR smb.conf (5) -for a description of how to handle incoming WinPopup messages in Samba. - -Note: Copy WinPopup into the startup group on your WfWg PCs if you -want them to always be able to receive messages. .RE .B \-E @@ -185,17 +247,6 @@ There is no default for this parameter. If not supplied, it will be determined automatically by the client as described above. .RE -.B \-N - -.RS 3 -If specified, this parameter suppresses the normal password prompt from the -client to the user. This is useful when accessing a service that does not -require a password. - -Unless a password is specified on the command line or this parameter is -specified, the client will request a password. -.RE - .B \-O .I socket options @@ -278,25 +329,6 @@ rejected by these servers. Be cautious about including passwords in scripts. .RE -.B \-d -.I debuglevel - -.RS 3 -debuglevel is an integer from 0 to 5. - -The default value if this parameter is not specified is zero. - -The higher this value, the more detail will be logged to the log files about -the activities of the client. At level 0, only critical errors and serious -warnings will be logged. Level 1 is a reasonable level for day to day running -- it generates a small amount of information about operations carried out. - -Levels above 1 will generate considerable amounts of log data, and should -only be used when investigating a problem. Levels above 3 are designed for -use only by developers and generate HUGE amounts of log data, most of which -is extremely cryptic. -.RE - .B \-l .I log basename @@ -322,15 +354,6 @@ log.client.out (containing outbound transaction data) The log files generated are never removed by the client. .RE -.B \-n -.I NetBIOS name - -.RS 3 -By default, the client will use the local machine's hostname (in -uppercase) as its NetBIOS name. This parameter allows you to override -the host name and use whatever NetBIOS name you wish. -.RE - .B \-W .I workgroup |