docs/manpages-3/smbsh.1.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="smbsh.1">
   4
   5 <refmeta>
   6         <refentrytitle>smbsh</refentrytitle>
   7         <manvolnum>1</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>smbsh</refname>
  13         <refpurpose>Allows access to remote SMB shares
  14         using UNIX commands</refpurpose>
  15 </refnamediv>
  16
  17 <refsynopsisdiv>
  18         <cmdsynopsis>
  19                 <command>smbsh</command>
  20                 <arg choice="opt">-W workgroup</arg>
  21                 <arg choice="opt">-U username</arg>
  22                 <arg choice="opt">-P prefix</arg>
  23                 <arg choice="opt">-R &lt;name resolve order&gt;</arg>
  24                 <arg choice="opt">-d &lt;debug level&gt;</arg>
  25                 <arg choice="opt">-l logdir</arg>
  26                 <arg choice="opt">-L libdir</arg>
  27         </cmdsynopsis>
  28 </refsynopsisdiv>
  29
  30 <refsect1>
  31         <title>DESCRIPTION</title>
  32
  33         <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
  34         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  35
  36         <para><command>smbsh</command> allows you to access an NT filesystem
  37         using UNIX commands such as <command>ls</command>, <command>
  38         egrep</command>, and <command>rcp</command>. You must use a
  39         shell that is dynamically linked in order for <command>smbsh</command>
  40         to work correctly.</para>
  41 </refsect1>
  42
  43 <refsect1>
  44         <title>OPTIONS</title>
  45
  46         <variablelist>
  47             <varlistentry>
  48                 <term>-W WORKGROUP</term>
  49                 <listitem><para>Override the default workgroup specified in the
  50                 workgroup parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
  51                 <manvolnum>5</manvolnum></citerefentry> file
  52                 for this session. This may be needed to connect to some
  53                 servers. </para></listitem>
  54             </varlistentry>
  55
  56             <varlistentry>
  57                 <term>-U username[%pass]</term>
  58                 <listitem><para>Sets the SMB username or username and password.
  59                 If this option is not specified, the user will be prompted for
  60                 both the username and the password.  If %pass is not specified,
  61                 the user will be prompted for the password.
  62                 </para></listitem>
  63             </varlistentry>
  64
  65             <varlistentry>
  66                 <term>-P prefix</term>
  67                 <listitem><para>This option allows
  68                 the user to set the directory prefix for SMB access. The
  69                 default value if this option is not specified is
  70                 <emphasis>smb</emphasis>.
  71                 </para></listitem>
  72             </varlistentry>
  73
  74                 &stdarg.configfile;
  75                 &stdarg.debug;
  76                 &stdarg.resolve.order;
  77
  78             <varlistentry>
  79                 <term>-L libdir</term>
  80                 <listitem><para>This parameter specifies the location of the
  81                 shared libraries used by <command>smbsh</command>. The default
  82                 value is specified at compile time.
  83                 </para></listitem>
  84             </varlistentry>
  85
  86         </variablelist>
  87 </refsect1>
  88
  89 <refsect1>
  90         <title>EXAMPLES</title>
  91
  92         <para>To use the <command>smbsh</command> command, execute <command>
  93         smbsh</command> from the prompt and enter the username and password
  94         that authenticates you to the machine running the Windows NT
  95         operating system.
  96 <programlisting>
  97 <prompt>system% </prompt><userinput>smbsh</userinput>
  98 <prompt>Username: </prompt><userinput>user</userinput>
  99 <prompt>Password: </prompt><userinput>XXXXXXX</userinput>
 100 </programlisting></para>
 101
 102
 103         <para>Any dynamically linked command you execute from
 104         this shell will access the <filename>/smb</filename> directory
 105         using the smb protocol. For example, the command <command>ls /smb
 106         </command> will show a list of workgroups. The command
 107         <command>ls /smb/MYGROUP </command> will show all the machines in
 108         the  workgroup MYGROUP. The command
 109         <command>ls /smb/MYGROUP/&lt;machine-name&gt;</command> will show the share
 110         names for that machine. You could then, for example, use the <command>
 111         cd</command> command to change directories, <command>vi</command> to
 112         edit files, and <command>rcp</command>  to copy files.</para>
 113 </refsect1>
 114
 115 <refsect1>
 116         <title>VERSION</title>
 117
 118         <para>This man page is correct for version 3.0 of the Samba suite.</para>
 119 </refsect1>
 120
 121 <refsect1>
 122         <title>BUGS</title>
 123
 124         <para><command>smbsh</command> works by intercepting the standard
 125         libc calls with the dynamically loaded versions in <filename>
 126         smbwrapper.o</filename>. Not all calls have been "wrapped", so
 127         some programs may not function correctly under <command>smbsh
 128         </command>.</para>
 129
 130         <para>Programs which are not dynamically linked cannot make
 131         use of <command>smbsh</command>'s functionality. Most versions
 132         of UNIX have a <command>file</command> command that will
 133         describe how a program was linked.</para>
 134 </refsect1>
 135
 136
 137 <refsect1>
 138         <title>SEE ALSO</title>
 139         <para><citerefentry><refentrytitle>smbd</refentrytitle>
 140         <manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
 141         <manvolnum>5</manvolnum></citerefentry></para>
 142 </refsect1>
 143
 144 <refsect1>
 145         <title>AUTHOR</title>
 146
 147         <para>The original Samba software and related utilities
 148         were created by Andrew Tridgell. Samba is now developed
 149         by the Samba Team as an Open Source project similar
 150         to the way the Linux kernel is developed.</para>
 151
 152         <para>The original Samba man pages were written by Karl Auer.
 153         The man page sources were converted to YODL format (another
 154         excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
 155         ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
 156         release by Jeremy Allison.  The conversion to DocBook for
 157         Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
 158         for Samba 3.0 was done by Alexander Bokovoy.</para>
 159 </refsect1>
 160
 161 </refentry>