diff options
Diffstat (limited to 'docs-xml/manpages/mdsearch.1.xml')
| -rw-r--r-- | docs-xml/manpages/mdsearch.1.xml | 179 |
1 files changed, 179 insertions, 0 deletions
diff --git a/docs-xml/manpages/mdsearch.1.xml b/docs-xml/manpages/mdsearch.1.xml new file mode 100644 index 0000000..e5b443f --- /dev/null +++ b/docs-xml/manpages/mdsearch.1.xml @@ -0,0 +1,179 @@ +<?xml version="1.0" encoding="iso-8859-1"?> +<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc"> +<refentry id="mdsearch.1"> + + <refmeta> + <refentrytitle>mdsearch</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="source">Samba</refmiscinfo> + <refmiscinfo class="manual">User Commands</refmiscinfo> + <refmiscinfo class="version">&doc.version;</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>mdsearch</refname> + <refpurpose>Run Spotlight searches against an SMB server</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>mdfine</command> + <arg choice="req">server</arg> + <arg choice="req">sharename</arg> + <arg choice="req">query</arg> + <arg choice="opt">-p, --path=STRING</arg> + <arg choice="opt">-L, --live</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">--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> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>DESCRIPTION</title> + + <para>This tool is part of the <citerefentry><refentrytitle>samba</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> suite.</para> + + <para>mdsearch is a simple utility to run Spotlight searches against an SMB server + that runs the Spotlight <emphasis>mdssvc</emphasis> RPC service.</para> + </refsect1> + + <refsect1> + <title>OPTIONS</title> + + <variablelist> + <varlistentry> + <term>server</term> + <listitem> + <para>The SMB server name or IP address to connect to.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>sharename</term> + <listitem> + <para>The name of a share on the server.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>query</term> + <listitem> + <para>The query expression syntax is a simplified form of filename + globbing familiar to shell users. Queries have the following + format:</para> + + <para>attribute=="value"</para> + + <para>For queries against a Samba server with Spotlight enabled using + the Elasticsearch backend, the list of supported metadata attributes + is given by the JSON attribute mapping file, typically installed at + <filename>/usr/share/samba/mdssvc/elasticsearch_mappings.json</filename> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-p PATH, --path=PATH</term> + <listitem> + <para>Server side path to search, defaults to + <emphasis>"/"</emphasis></para> + </listitem> + </varlistentry> + + <varlistentry> + <term>-L, --live</term> + <listitem><para>Query remains running.</para></listitem> + </varlistentry> + + &popt.autohelp; + &cmdline.common.samba.client; + &cmdline.common.credentials; + </variablelist> + </refsect1> + + <refsect1> + <title>EXAMPLES</title> + + <para>Search all indexed metadata attributes, exact match:</para> + <programlisting> + '*=="Samba"' + </programlisting> + + <para>Search all indexed metadata attributes, prefix match:</para> + <programlisting> + '*=="Samba*"' + </programlisting> + + <para>Search by filename:</para> + <programlisting> + 'kMDItemFSName=="Samba*"' + </programlisting> + + <para>Search by date:</para> + <programlisting> + 'kMDItemFSContentChangeDate<$time.iso(2018-10-01T10:00:00Z)' + </programlisting> + + <para>Search files's content:</para> + <programlisting> + 'kMDItemTextContent=="Samba*"' + </programlisting> + + <para>Expressions:</para> + <programlisting> + kMDItemFSName=="Samba*"||kMDItemTextContent=="Tango*"' + </programlisting> + </refsect1> + + <refsect1> + <title>SEE ALSO</title> + + <para>File Metadata Search Programming Guide + <ulink url="https://developer.apple.com/library/archive/documentation/Carbon/Conceptual/SpotlightQuery/Concepts/Introduction.html"> + https://developer.apple.com/library/archive/documentation/Carbon/Conceptual/SpotlightQuery/Concepts/Introduction.html</ulink> + </para> + </refsect1> + + <refsect1> + <title>VERSION</title> + + <para>This man page is part of version &doc.version; of the Samba suite.</para> + </refsect1> + + <refsect1> + <title>AUTHOR</title> + + <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 to the way the Linux kernel is developed.</para> + + <para>The mdsearch manpage was written by Ralph Boehme.</para> + </refsect1> +</refentry> |