46adac6b79dc70f48d395af978f5822a9ad833e7
[nivanova/samba-autobuild/.git] / docs / docbook / manpages / smbsh.1.sgml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
2 <refentry id="smbsh">
3
4 <refmeta>
5         <refentrytitle>smbsh</refentrytitle>
6         <manvolnum>1</manvolnum>
7 </refmeta>
8
9
10 <refnamediv>
11         <refname>smbsh</refname>
12         <refpurpose>Allows access to Windows NT filesystem 
13         using UNIX commands</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17         <cmdsynopsis>
18                 <command>smbsh</command>
19         </cmdsynopsis>
20 </refsynopsisdiv>
21
22 <refsect1>
23         <title>DESCRIPTION</title>
24
25         <para>This tool is part of the <ulink url="samba.7.html">
26         Samba</ulink> suite.</para>
27
28         <para><command>smbsh</command> allows you to access an NT filesystem 
29         using UNIX commands such as <command>ls</command>, <command>
30         egrep</command>, and <command>rcp</command>. You must use a 
31         shell that is dynamically linked in order for <command>smbsh</command> 
32         to work correctly.</para>
33
34         <para>To use the <command>smbsh</command> command, execute <command>
35         smbsh</command> from the prompt and enter the username and password 
36         that authenticates you to the machine running the Windows NT 
37         operating system.</para>
38
39         <para><programlisting>
40         <prompt>system% </prompt><userinput>smbsh</userinput>
41         <prompt>Username: </prompt><userinput>user</userinput>
42         <prompt>Password: </prompt><userinput>XXXXXXX</userinput>
43         </programlisting></para>
44
45
46         <para>Any dynamically linked command you execute from 
47         this shell will access the <filename>/smb</filename> directory 
48         using the smb protocol. For example, the command <command>ls /smb
49         </command> will show a list of workgroups. The command 
50         <command>ls /smb/MYGROUP </command> will show all the machines in 
51         the  workgroup MYGROUP. The command 
52         <command>ls /smb/MYGROUP/&lt;machine-name&gt;</command> will show the share 
53         names for that machine. You could then, for example, use the <command>
54         cd</command> command to change directories, <command>vi</command> to 
55         edit files, and <command>rcp</command>  to copy files.</para>
56 </refsect1>
57
58 <refsect1>
59         <title>VERSION</title>
60
61         <para>This man page is correct for version 2.2 of 
62         the Samba suite.</para>
63 </refsect1>
64
65 <refsect1>
66         <title>BUGS</title>
67         
68         <para><command>smbsh</command> works by intercepting the standard 
69         libc calls with the dynamically loaded versions in <filename>
70         smbwrapper.o</filename>. Not all calls have been "wrapped", so 
71         some programs may not function correctly under <command>smbsh
72         </command>.</para>
73
74         <para>Programs which are not dynamically linked cannot make 
75         use of <command>smbsh</command>'s functionality. Most versions 
76         of UNIX have a <command>file</command> command that will 
77         describe how a program was linked.</para>
78 </refsect1>
79
80
81 <refsect1>
82         <title>SEE ALSO</title>
83         <para><ulink url="smbd.8.html"><command>smbd(8)</command></ulink>, 
84         <ulink url="smb.conf.5.html">smb.conf(5)</ulink>
85         </para>
86 </refsect1>
87
88 <refsect1>
89         <title>AUTHOR</title>
90         
91         <para>The original Samba software and related utilities 
92         were created by Andrew Tridgell. Samba is now developed
93         by the Samba Team as an Open Source project similar 
94         to the way the Linux kernel is developed.</para>
95         
96         <para>The original Samba man pages were written by Karl Auer. 
97         The man page sources were converted to YODL format (another 
98         excellent piece of Open Source software, available at
99         <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
100         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0 
101         release by Jeremy Allison.  The conversion to DocBook for 
102         Samba 2.2 was done by Gerald Carter</para>
103 </refsect1>
104
105 </refentry>