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