docs/manpages-3/smbgetrc.5.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="smbgetrc.5">
   4
   5 <refmeta>
   6         <refentrytitle>smbgetrc</refentrytitle>
   7         <manvolnum>5</manvolnum>
   8 </refmeta>
   9
  10
  11 <refnamediv>
  12         <refname>smbgetrc</refname>
  13         <refpurpose>configuration file for smbget</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17         <para><filename>smbgetrc</filename></para>
  18 </refsynopsisdiv>
  19
  20 <refsect1>
  21         <title>DESCRIPTION</title>
  22
  23         <para>
  24                 This manual page documents the format and options of the <emphasis>smbgetrc</emphasis>
  25                 file. This is the configuration file used by the <citerefentry><refentrytitle>smbget</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  26                 utility. The file contains of key-value pairs, one pair on each line. The key
  27                         and value should be separated by a space.
  28         </para>
  29
  30         <para>By default, smbget reads its configuration from <emphasis>$HOME/.smbgetrc</emphasis>, though
  31                 other locations can be specified using the command-line options.</para>
  32 </refsect1>
  33
  34 <refsect1>
  35         <title>OPTIONS</title>
  36
  37         <para>
  38         The following keys can be set:
  39 </para>
  40
  41         <variablelist>
  42                 <varlistentry><term>resume on|off</term>
  43                         <listitem><para>
  44                         Whether aborted downloads should be automatically resumed.
  45                         </para></listitem>
  46                 </varlistentry>
  47
  48                 <varlistentry>
  49                         <term>recursive on|off</term>
  50                         <listitem><para>Whether directories should be downloaded recursively</para></listitem>
  51                 </varlistentry>
  52
  53                 <varlistentry><term>username <replaceable>name</replaceable></term>
  54                         <listitem><para>Username to use when logging in to the remote server. Use an empty string for anonymous access.
  55                         </para></listitem>
  56                 </varlistentry>
  57
  58                 <varlistentry><term>password <replaceable>pass</replaceable></term>
  59                         <listitem><para>Password to use when logging in.</para></listitem>
  60                 </varlistentry>
  61
  62                 <varlistentry><term>workgroup <replaceable>wg</replaceable></term>
  63                         <listitem><para>Workgroup to use when logging in</para></listitem>
  64                 </varlistentry>
  65
  66                 <varlistentry><term>nonprompt on|off</term>
  67                         <listitem><para>Turns off asking for username and password. Useful for scripts.</para></listitem>
  68                 </varlistentry>
  69
  70                 <varlistentry><term>debuglevel <replaceable>int</replaceable></term>
  71                         <listitem><para>(Samba) debuglevel to run at. Useful for tracking down protocol level problems.</para></listitem>
  72                 </varlistentry>
  73
  74                 <varlistentry><term>dots on|off</term>
  75                         <listitem><para>Whether a single dot should be printed for each block that has been downloaded, instead of the default progress indicator.</para></listitem>
  76                 </varlistentry>
  77
  78                 <varlistentry><term>blocksize <replaceable>int</replaceable></term>
  79                         <listitem><para>Number of bytes to put in a block. </para></listitem>
  80                 </varlistentry>
  81         </variablelist>
  82 </refsect1>
  83
  84 <refsect1>
  85         <title>VERSION</title>
  86
  87         <para>This man page is correct for version 3.0 of
  88         the Samba suite.</para>
  89 </refsect1>
  90
  91 <refsect1>
  92         <title>SEE ALSO</title>
  93         <para><citerefentry><refentrytitle>smbget</refentrytitle>
  94         <manvolnum>1</manvolnum></citerefentry> and <citerefentry><refentrytitle>Samba</refentrytitle>
  95         <manvolnum>7</manvolnum></citerefentry>.
  96         </para>
  97 </refsect1>
  98
  99 <refsect1>
 100         <title>AUTHOR</title>
 101
 102         <para>The original Samba software and related utilities
 103         were created by Andrew Tridgell. Samba is now developed
 104         by the Samba Team as an Open Source project similar
 105         to the way the Linux kernel is developed.</para>
 106
 107         <para>This manual page was written by Jelmer Vernooij</para>
 108
 109 </refsect1>
 110
 111 </refentry>
 112
 113