]> git.ipfire.org Git - thirdparty/samba.git/commitdiff
manpages:samba-tool: document -H options
authorDouglas Bagnall <douglas.bagnall@catalyst.net.nz>
Sun, 2 Mar 2025 00:54:27 +0000 (13:54 +1300)
committerDouglas Bagnall <dbagnall@samba.org>
Wed, 12 Mar 2025 19:57:34 +0000 (19:57 +0000)
Signed-off-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Reviewed-by: Rowland Penny <rpenny@samba.org>
docs-xml/manpages/samba-tool.8.xml

index c803e5a93263c2f9f4c53b8617d0021d2fc9d85e..4aedadfb17d1af0d9cd29ad77e527c2212151bd2 100644 (file)
 
        &cmdline.common.credentials.authenticationfile;
 
+       <varlistentry>
+         <term>-H URL, --URL=URL</term>
+         <listitem>
+           <para>LDB URL for database or target server.</para>
+           <para>The URL can either be a plain file path, or use one
+           of the schemes listed here. If a plain path is used, it is
+           treated as if 'tdb://' was used.
+           <variablelist>
+             <varlistentry>
+               <term>tdb://PATH</term>
+               <listitem>
+                 <para>
+                   PATH is the location of a TDB database.
+                 </para>
+               </listitem>
+             </varlistentry>
+             <varlistentry>
+               <term>mdb://PATH</term>
+               <listitem>
+                 <para>
+                   PATH is the location of an LMDB database.
+                 </para>
+               </listitem>
+             </varlistentry>
+             <varlistentry>
+               <term>ldb://PATH</term>
+               <listitem>
+                 <para>
+                   PATH is the location of an LDB database, in either
+                   LMDB or TDB format. The formats will be tried one
+                   after another until one succeeds or all fail. It
+                   is safe to use this if you don't know the format
+                   of the file.
+                 </para>
+               </listitem>
+             </varlistentry>
+             <varlistentry>
+               <term>ldap://HOSTNAME, ldaps://HOSTNAME</term>
+               <listitem>
+                 <para>
+                   The LDB backend is the named ldap server. ldaps:// wraps the connection in TLS.
+                 </para>
+               </listitem>
+             </varlistentry>
+             <varlistentry>
+               <term>ldapi://SOCKET</term>
+               <listitem>
+                 <para>
+                   The backend server is a local ldap server using a unix domain socket.
+                 </para>
+               </listitem>
+             </varlistentry>
+
+           </variablelist>
+           </para>
+         </listitem>
+       </varlistentry>
+       <varlistentry>
+         <term>--color=always|never|auto</term>
+         <listitem><para>use colour if available (default: auto)</para></listitem>
+       </varlistentry>
+
+
        <varlistentry>
        <term>--ipaddress=IPADDRESS</term>
        <listitem><para>
        IP address of the server
        </para></listitem>
        </varlistentry>
+       <varlistentry>
+         <term>-s FILE, --configfile=FILE</term>
+         <listitem><para>Use this smb.conf configuration file.</para></listitem>
+       </varlistentry>
 
        <varlistentry>
        <term>--color=always|never|auto</term>