docs-xml: Update smbget manpage
authorAndreas Schneider <asn@samba.org>
Thu, 30 Mar 2023 11:48:06 +0000 (13:48 +0200)
committerAndrew Bartlett <abartlet@samba.org>
Wed, 5 Apr 2023 01:06:29 +0000 (01:06 +0000)
Signed-off-by: Andreas Schneider <asn@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
docs-xml/manpages/smbget.1.xml

index 9d1db967f96fc347a9b9b27eb443d45d34d2f9ed..d7eac27ddb829c082a71b278609d3701572d2044 100644 (file)
                <command>smbget</command>
                <arg choice="opt">-a, --guest</arg>
                <arg choice="opt">-r, --resume</arg>
-               <arg choice="opt">-R, --recursive</arg>
-               <arg choice="opt">-U, --user=STRING</arg>
-               <arg choice="opt">-w, --workgroup=STRING</arg>
-               <arg choice="opt">-n, --nonprompt</arg>
-               <arg choice="opt">-d, --debuglevel=INT</arg>
+               <arg choice="opt">--recursive</arg>
                <arg choice="opt">-D, --dots</arg>
                <arg choice="opt">-o, --outputfile</arg>
-               <arg choice="opt">-f, --rcfile</arg>
                <arg choice="opt">-q, --quiet</arg>
                <arg choice="opt">-v, --verbose</arg>
                <arg choice="opt">-b, --blocksize</arg>
                <arg choice="opt">-u, --update</arg>
                <arg choice="opt">-e, --encrypt</arg>
                <arg choice="opt">--limit-rate=INT</arg>
-               <arg choice="opt">-?--help</arg>
+               <arg choice="opt">-?|--help</arg>
                <arg choice="opt">--usage</arg>
+               <arg choice="opt">-d|--debuglevel=DEBUGLEVEL</arg>
+               <arg choice="opt">--debug-stdout</arg>
+               <arg choice="opt">-s|--configfile=CONFIGFILE</arg>
+               <arg choice="opt">--option=name=value</arg>
+               <arg choice="opt">-l|--log-basename=LOGFILEBASE</arg>
+               <arg choice="opt">--leak-report</arg>
+               <arg choice="opt">--leak-report-full</arg>
+               <arg choice="opt">-R|--name-resolve=NAME-RESOLVE-ORDER</arg>
+               <arg choice="opt">-O|--socket-options=SOCKETOPTIONS</arg>
+               <arg choice="opt">-m|--max-protocol=MAXPROTOCOL</arg>
+               <arg choice="opt">-n|--netbiosname=NETBIOSNAME</arg>
+               <arg choice="opt">--netbios-scope=SCOPE</arg>
+               <arg choice="opt">-W|--workgroup=WORKGROUP</arg>
+               <arg choice="opt">--realm=REALM</arg>
+               <arg choice="opt">-U|--user=[DOMAIN/]USERNAME%[PASSWORD]</arg>
+               <arg choice="opt">-N|--no-pass</arg>
+               <arg choice="opt">--password=STRING</arg>
+               <arg choice="opt">--pw-nt-hash</arg>
+               <arg choice="opt">-A|--authentication-file=FILE</arg>
+               <arg choice="opt">-P|--machine-pass</arg>
+               <arg choice="opt">--simple-bind-dn=DN</arg>
+               <arg choice="opt">--use-kerberos=desired|required|off</arg>
+               <arg choice="opt">--use-krb5-ccache=CCACHE</arg>
+               <arg choice="opt">--use-winbind-ccache</arg>
+               <arg choice="opt">--client-protection=sign|encrypt|off</arg>
+               <arg choice="opt">-V|--version</arg>
                <arg choice="req">smb://host/share/path/to/file</arg>
                <arg choice="opt">smb://url2/</arg>
                <arg choice="opt">...</arg>
@@ -50,7 +71,7 @@
        <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle>
        <manvolnum>7</manvolnum></citerefentry> suite.</para>
 
-       <para>smbget is a simple utility with wget-like semantics, that can download files from SMB servers. You can specify the files you would like to download on the command-line. 
+       <para>smbget is a simple utility with wget-like semantics, that can download files from SMB servers. You can specify the files you would like to download on the command-line.
        </para>
 
        <para>
        </varlistentry>
 
        <varlistentry>
-               <term>-R, --recursive</term>
+               <term>--recursive</term>
                <listitem><para>Recursively download files</para></listitem>
        </varlistentry>
 
-       <varlistentry>
-               <term> -U, --user=<replaceable>username[%password]</replaceable></term>
-               <listitem><para>Username (and password) to use</para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term>-w, --workgroup=STRING</term>
-               <listitem><para>Workgroup to use (optional)</para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term>-n, --nonprompt</term>
-               <listitem><para>Don't ask anything (non-interactive)</para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term>-d, --debuglevel=INT</term>
-               <listitem><para>Debuglevel to use</para></listitem>
-       </varlistentry>
-
        <varlistentry>
                <term>-D, --dots</term>
                <listitem><para>Show dots as progress indication</para></listitem>
        </varlistentry>
 
        <varlistentry>
-               <term>-O, --stdout</term>
+               <term>--stdout</term>
                <listitem><para>Write the file that is being downloaded to standard output.</para></listitem>
        </varlistentry>
 
-       <varlistentry>
-               <term>-f, --rcfile</term>
-               <listitem><para>Use specified rcfile. This will be loaded in the order it was specified - e.g. if you specify any options before this one, they might get overridden by the contents of the rcfile.</para></listitem>
-       </varlistentry>
-
        <varlistentry>
                <term>-q, --quiet</term>
                <listitem><para>Be quiet</para></listitem>
                <listitem><para>Number of bytes to download in a block. Defaults to 64000.</para></listitem>
        </varlistentry>
 
-       <varlistentry>
-               <term>-?, --help</term>
-               <listitem><para>Show help message</para></listitem>
-       </varlistentry>
-
-       <varlistentry>
-               <term>--usage</term>
-               <listitem><para>Display brief usage message</para></listitem>
-       </varlistentry>
-
        <varlistentry>
                <term>-u, --update</term>
                <listitem><para>Download only when remote file is newer than local file or local file is missing.</para></listitem>
                <listitem><para>Limit download rate by this many KB/s.</para></listitem>
        </varlistentry>
 
+               &popt.autohelp;
+               &cmdline.common.samba.client;
+               &cmdline.common.connection;
+               &cmdline.common.credentials;
 </refsect1>
 
 <refsect1>
@@ -180,16 +170,16 @@ smb://name/ means, if <replaceable>name</replaceable> is a workgroup, all the se
 
 <refsect1>
        <title>EXAMPLES</title>
-       
+
 <programlisting>
 # Recursively download 'src' directory
-smbget -R smb://rhonwyn/jelmer/src
+smbget --recursive smb://rhonwyn/jelmer/src
 # Download FreeBSD ISO and enable resuming
-smbget -r smb://rhonwyn/isos/FreeBSD5.1.iso
+smbget --resume smb://rhonwyn/isos/FreeBSD5.1.iso
 # Recursively download all ISOs
-smbget -Rr smb://rhonwyn/isos
+smbget --recursive --resume smb://rhonwyn/isos
 # Backup my data on rhonwyn
-smbget -Rr smb://rhonwyn/
+smbget --recursive -resume smb://rhonwyn/
 </programlisting>
 
 </refsect1>
@@ -197,8 +187,8 @@ smbget -Rr smb://rhonwyn/
 <refsect1>
        <title>BUGS</title>
 
-       <para>Permission denied is returned in some cases where the cause of the error is unknown 
-(such as an illegally formatted smb:// url or trying to get a directory without -
+       <para>Permission denied is returned in some cases where the cause of the error is unknown
+(such as an illegally formatted smb:// url or trying to get a directory without --resursive
 turned on).</para>
 </refsect1>
 
@@ -211,10 +201,10 @@ turned on).</para>
 
 <refsect1>
        <title>AUTHOR</title>
-       
-       <para>The original Samba software and related utilities 
+
+       <para>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 
+       by the Samba Team as an Open Source project similar
        to the way the Linux kernel is developed.</para>
 
        <para>The smbget manpage was written by Jelmer Vernooij.</para>