~ubuntu-branches/ubuntu/gutsy/samba/gutsy-updates

« back to all changes in this revision

Viewing changes to docs/manpages/smbsh.1

  • Committer: Bazaar Package Importer
  • Author(s): Andrew Mitchell
  • Date: 2006-11-28 20:14:37 UTC
  • mfrom: (0.10.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20061128201437-a6x4lzlhempazocp
Tags: 3.0.23d-1ubuntu1
* Merge from debian unstable.
* Drop python2.4-samba, replace with python-samba. Added Conflicts/Replaces
  on python2.4-samba
* Drop track-connection-dos.patch, ubuntu-winbind-panic.patch, 
  ubuntu-fix-ldap.patch, ubuntu-setlocale.patch, ubuntu-setlocale-fixes.patch
* Remaining Ubuntu changes:
  - Revert Debian's installation of mount.cifs and umount.cifs as suid
  - Comment out the default [homes] shares and add more verbose comments to
    explain what they do and how they work (closes: launchpad.net/27608)
  - Add a "valid users = %S" stanza to the commented-out [homes] section, to
    show users how to restrict access to \\server\username to only username.
  - Change the (commented-out) "printer admin" example to use "@lpadmin"
    instead of "@ntadmin", since the lpadmin group is used for spool admin.
  - Alter the panic-action script to encourage users to report their
    bugs in Ubuntu packages to Ubuntu, rather than reporting to Debian.
    Modify text to more closely match the Debian script
  - Munge our init script to deal with the fact that our implementation
    (or lack thereof) of log_daemon_msg and log_progress_msg differs
    from Debian's implementation of the same (Ubuntu #19691)
  - Kept ubuntu-auxsrc.patch: some auxilliary sources (undocumented in 
    previous changelogs)
  - Set default workgroup to MSHOME

Show diffs side-by-side

added added

removed removed

Lines of Context:
18
18
.IP "\\$1" \\$2
19
19
..
20
20
.TH "SMBSH" 1 "" "" ""
21
 
.SH NAME
22
 
smbsh \- Allows access to remote SMB shares using UNIX commands
 
21
.SH "NAME"
 
22
smbsh - Allows access to remote SMB shares using UNIX commands
23
23
.SH "SYNOPSIS"
24
 
.ad l
25
 
.hy 0
26
24
.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
 
 
 
25
\fBsmbsh\fR [-W�workgroup] [-U�username] [-P�prefix] [-R�<name�resolve�order>] [-d�<debug�level>] [-l�logdir] [-L�libdir]
31
26
.SH "DESCRIPTION"
32
 
 
33
 
.PP
34
 
This 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
 
 
 
27
.PP
 
28
This tool is part of the
 
29
\fBsamba\fR(7)
 
30
suite.
 
31
.PP
 
32
\fBsmbsh\fR
 
33
allows you to access an NT filesystem using UNIX commands such as
 
34
\fBls\fR,
 
35
\fB egrep\fR, and
 
36
\fBrcp\fR. You must use a shell that is dynamically linked in order for
 
37
\fBsmbsh\fR
 
38
to work correctly.
39
39
.SH "OPTIONS"
40
 
 
41
 
.TP
42
 
\-W WORKGROUP
43
 
Override 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]
47
 
Sets 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
51
 
This 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>
55
 
The 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
 
 
61
 
The 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
 
 
63
 
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\&.
64
 
 
65
 
Note that specifying this parameter here will override the  parameter in the \fIsmb\&.conf\fR file\&.
66
 
 
67
 
.TP
68
 
\-R <name resolve order>
69
 
This 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
 
 
71
 
The 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
 
40
.TP 3n
 
41
-W WORKGROUP
 
42
Override the default workgroup specified in the workgroup parameter of the
 
43
\fBsmb.conf\fR(5)
 
44
file for this session. This may be needed to connect to some servers.
 
45
.TP 3n
 
46
-U username[%pass]
 
47
Sets 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
.TP 3n
 
49
-P prefix
 
50
This option allows the user to set the directory prefix for SMB access. The default value if this option is not specified is
 
51
\fBsmb\fR.
 
52
.TP 3n
 
53
-s <configuration file>
 
54
The 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
 
55
\fIsmb.conf\fR
 
56
for more information. The default configuration file name is determined at compile time.
 
57
.TP 3n
 
58
-d|--debuglevel=level
 
59
\fIlevel\fR
 
60
is an integer from 0 to 10. The default value if this parameter is not specified is zero.
 
61
.sp
 
62
The 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.
 
63
.sp
 
64
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.
 
65
.sp
 
66
Note that specifying this parameter here will override the
 
67
 
 
68
parameter in the
 
69
\fIsmb.conf\fR
 
70
file.
 
71
.TP 3n
 
72
-R <name resolve order>
 
73
This 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.
 
74
.sp
 
75
The options are: "lmhosts", "host", "wins" and "bcast". They cause names to be resolved as follows :
 
76
.RS 3n
 
77
.TP 3n
 
78
&#8226;
 
79
\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
 
80
\fBlmhosts\fR(5)
 
81
for details) then any name type matches for lookup.
 
82
.TP 3n
 
83
&#8226;
 
84
\fBhost\fR: Do a standard host name to IP address resolution, using the system
 
85
\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
 
86
\fI/etc/nsswitch.conf \fR
 
87
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.
 
88
.TP 3n
 
89
&#8226;
 
90
\fBwins\fR: Query a name with the IP address listed in the
 
91
\fIwins server\fR
 
92
parameter. If no WINS server has been specified this method will be ignored.
 
93
.TP 3n
 
94
&#8226;
 
95
\fBbcast\fR: Do a broadcast on each of the known local interfaces listed in the
 
96
\fIinterfaces\fR
 
97
parameter. This is the least reliable of the name resolution methods as it depends on the target host being on a locally connected subnet.
88
98
.RE
89
 
.IP
90
 
If this parameter is not set then the name resolve order defined in the \fIsmb\&.conf\fR file parameter () will be used\&.
91
 
 
92
 
The 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
96
 
This parameter specifies the location of the shared libraries used by \fBsmbsh\fR\&. The default value is specified at compile time\&.
97
 
 
 
99
.IP "" 3n
 
100
If this parameter is not set then the name resolve order defined in the
 
101
\fIsmb.conf\fR
 
102
file parameter () will be used.
 
103
.sp
 
104
The default order is lmhosts, host, wins, bcast. Without this parameter or any entry in the
 
105
 
 
106
parameter of the
 
107
\fIsmb.conf\fR
 
108
file, the name resolution methods will be attempted in this order.
 
109
.TP 3n
 
110
-L libdir
 
111
This parameter specifies the location of the shared libraries used by
 
112
\fBsmbsh\fR. The default value is specified at compile time.
98
113
.SH "EXAMPLES"
 
114
.PP
 
115
To use the
 
116
\fBsmbsh\fR
 
117
command, execute
 
118
\fB smbsh\fR
 
119
from the prompt and enter the username and password that authenticates you to the machine running the Windows NT operating system.
99
120
 
100
 
.PP
101
 
To 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\&. 
 
121
.sp
102
122
.nf
103
123
 
104
124
system% \fBsmbsh\fR
106
126
Password: \fBXXXXXXX\fR
107
127
.fi
108
128
 
109
 
 
110
129
.PP
111
 
Any 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\&.
112
 
 
 
130
Any dynamically linked command you execute from this shell will access the
 
131
\fI/smb\fR
 
132
directory using the smb protocol. For example, the command
 
133
\fBls /smb \fR
 
134
will show a list of workgroups. The command
 
135
\fBls /smb/MYGROUP \fR
 
136
will show all the machines in the workgroup MYGROUP. The command
 
137
\fBls /smb/MYGROUP/<machine-name>\fR
 
138
will show the share names for that machine. You could then, for example, use the
 
139
\fB cd\fR
 
140
command to change directories,
 
141
\fBvi\fR
 
142
to edit files, and
 
143
\fBrcp\fR
 
144
to copy files.
113
145
.SH "VERSION"
114
 
 
115
146
.PP
116
 
This man page is correct for version 3\&.0 of the Samba suite\&.
117
 
 
 
147
This man page is correct for version 3.0 of the Samba suite.
118
148
.SH "BUGS"
119
 
 
120
 
.PP
121
 
\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\&.
122
 
 
123
 
.PP
124
 
Programs 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\&.
125
 
 
 
149
.PP
 
150
\fBsmbsh\fR
 
151
works by intercepting the standard libc calls with the dynamically loaded versions in
 
152
\fI smbwrapper.o\fR. Not all calls have been "wrapped", so some programs may not function correctly under
 
153
\fBsmbsh \fR.
 
154
.PP
 
155
Programs which are not dynamically linked cannot make use of
 
156
\fBsmbsh\fR's functionality. Most versions of UNIX have a
 
157
\fBfile\fR
 
158
command that will describe how a program was linked.
126
159
.SH "SEE ALSO"
127
 
 
128
160
.PP
129
 
\fBsmbd\fR(8), \fBsmb\&.conf\fR(5)
130
 
 
 
161
\fBsmbd\fR(8),
 
162
\fBsmb.conf\fR(5)
131
163
.SH "AUTHOR"
132
 
 
133
 
.PP
134
 
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\&.
135
 
 
136
 
.PP
137
 
The 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\&.
 
164
.PP
 
165
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.
 
166
.PP
 
167
The 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
 
168
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.
138
169