source: trunk/samba-3.0.25pre1/docs/manpages/smbsh.1@ 7

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

Initial code import

File size: 6.4 KB
Line 
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 "SMBSH" 1 "" "" ""
21.SH NAME
22smbsh \- Allows access to remote SMB shares using UNIX commands
23.SH "SYNOPSIS"
24.ad l
25.hy 0
26.HP 6
27\fBsmbsh\fR [\-W\ workgroup] [\-U\ username] [\-P\ prefix] [\-R\ <name\ resolve\ order>] [\-d\ <debug\ level>] [\-l\ logdir] [\-L\ libdir]
28.ad
29.hy
30
31.SH "DESCRIPTION"
32
33.PP
34This tool is part of the \fBsamba\fR(7) suite\&.
35
36.PP
37\fBsmbsh\fR allows you to access an NT filesystem using UNIX commands such as \fBls\fR, \fB egrep\fR, and \fBrcp\fR\&. You must use a shell that is dynamically linked in order for \fBsmbsh\fR to work correctly\&.
38
39.SH "OPTIONS"
40
41.TP
42\-W WORKGROUP
43Override the default workgroup specified in the workgroup parameter of the \fBsmb\&.conf\fR(5) file for this session\&. This may be needed to connect to some servers\&.
44
45.TP
46\-U username[%pass]
47Sets the SMB username or username and password\&. If this option is not specified, the user will be prompted for both the username and the password\&. If %pass is not specified, the user will be prompted for the password\&.
48
49.TP
50\-P prefix
51This option allows the user to set the directory prefix for SMB access\&. The default value if this option is not specified is\fBsmb\fR\&.
52
53.TP
54\-s <configuration file>
55The file specified contains the configuration details required by the server\&. The information in this file includes server\-specific information such as what printcap file to use, as well as descriptions of all the services that the server is to provide\&. See \fIsmb\&.conf\fR for more information\&. The default configuration file name is determined at compile time\&.
56
57.TP
58\-d|\-\-debuglevel=level
59\fIlevel\fR is an integer from 0 to 10\&. The default value if this parameter is not specified is zero\&.
60
61The higher this value, the more detail will be logged to the log files about the activities of the server\&. 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\&.
62
63Levels 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\&.
64
65Note that specifying this parameter here will override the parameter in the \fIsmb\&.conf\fR file\&.
66
67.TP
68\-R <name resolve order>
69This option is used to determine what naming services and in what order to resolve host names to IP addresses\&. The option takes a space\-separated string of different name resolution options\&.
70
71The options are: "lmhosts", "host", "wins" and "bcast"\&. They cause names to be resolved as follows :
72
73
74.RS
75.TP 3
76\(bu
77\fBlmhosts\fR: Lookup an IP address in the Samba lmhosts file\&. If the line in lmhosts has no name type attached to the NetBIOS name (see the \fBlmhosts\fR(5)for details) then any name type matches for lookup\&.
78.TP
79\(bu
80\fBhost\fR: Do a standard host name to IP address resolution, using the system \fI/etc/hosts\fR, NIS, or DNS lookups\&. This method of name resolution is operating system dependent, for instance on IRIX or Solaris this may be controlled by the \fI/etc/nsswitch\&.conf \fR file)\&. Note that this method is only used if the NetBIOS name type being queried is the 0x20 (server) name type, otherwise it is ignored\&.
81.TP
82\(bu
83\fBwins\fR: Query a name with the IP address listed in the \fIwins server\fR parameter\&. If no WINS server has been specified this method will be ignored\&.
84.TP
85\(bu
86\fBbcast\fR: Do a broadcast on each of the known local interfaces listed in the \fIinterfaces\fR parameter\&. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet\&.
87.LP
88.RE
89.IP
90If this parameter is not set then the name resolve order defined in the \fIsmb\&.conf\fR file parameter () will be used\&.
91
92The default order is lmhosts, host, wins, bcast\&. Without this parameter or any entry in the parameter of the \fIsmb\&.conf\fR file, the name resolution methods will be attempted in this order\&.
93
94.TP
95\-L libdir
96This parameter specifies the location of the shared libraries used by \fBsmbsh\fR\&. The default value is specified at compile time\&.
97
98.SH "EXAMPLES"
99
100.PP
101To use the \fBsmbsh\fR command, execute \fB smbsh\fR from the prompt and enter the username and password that authenticates you to the machine running the Windows NT operating system\&.
102
103.nf
104
105system% \fBsmbsh\fR
106Username: \fBuser\fR
107Password: \fBXXXXXXX\fR
108
109.fi
110
111
112.PP
113Any dynamically linked command you execute from this shell will access the \fI/smb\fR directory using the smb protocol\&. For example, the command \fBls /smb \fR will show a list of workgroups\&. The command\fBls /smb/MYGROUP \fR will show all the machines in the workgroup MYGROUP\&. The command\fBls /smb/MYGROUP/<machine\-name>\fR will show the share names for that machine\&. You could then, for example, use the \fB cd\fR command to change directories, \fBvi\fR to edit files, and \fBrcp\fR to copy files\&.
114
115.SH "VERSION"
116
117.PP
118This man page is correct for version 3\&.0 of the Samba suite\&.
119
120.SH "BUGS"
121
122.PP
123\fBsmbsh\fR works by intercepting the standard libc calls with the dynamically loaded versions in \fI smbwrapper\&.o\fR\&. Not all calls have been "wrapped", so some programs may not function correctly under \fBsmbsh \fR\&.
124
125.PP
126Programs which are not dynamically linked cannot make use of \fBsmbsh\fR's functionality\&. Most versions of UNIX have a \fBfile\fR command that will describe how a program was linked\&.
127
128.SH "SEE ALSO"
129
130.PP
131\fBsmbd\fR(8), \fBsmb\&.conf\fR(5)
132
133.SH "AUTHOR"
134
135.PP
136The 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\&.
137
138.PP
139The original Samba man pages were written by Karl Auer\&. The man page sources were converted to YODL format (another excellent piece of Open Source software, available at ftp://ftp\&.icce\&.rug\&.nl/pub/unix/) and updated for the Samba 2\&.0 release by Jeremy Allison\&. The conversion to DocBook for Samba 2\&.2 was done by Gerald Carter\&. The conversion to DocBook XML 4\&.2 for Samba 3\&.0 was done by Alexander Bokovoy\&.
140
Note: See TracBrowser for help on using the repository browser.