mirror of
https://git.freebsd.org/ports.git
synced 2025-04-28 01:26:39 -04:00
b0a4fa4a12
Many thanks to Joshua Kinard, Siva Mahadevan, Yasuhiro Kimura, Andrew Walker, and Peter Eriksson for their patches. PR: 270383
357 lines
11 KiB
Groff
357 lines
11 KiB
Groff
'\" t
|
|
.\" Title: mdsearch
|
|
.\" Author: [see the "AUTHOR" section]
|
|
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
|
|
.\" Date: 08/09/2022
|
|
.\" Manual: User Commands
|
|
.\" Source: Samba 4.16.4
|
|
.\" Language: English
|
|
.\"
|
|
.TH "MDSEARCH" "1" "08/09/2022" "Samba 4\&.16\&.4" "User Commands"
|
|
.\" -----------------------------------------------------------------
|
|
.\" * Define some portability stuff
|
|
.\" -----------------------------------------------------------------
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.\" http://bugs.debian.org/507673
|
|
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
|
|
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.\" -----------------------------------------------------------------
|
|
.\" * set default formatting
|
|
.\" -----------------------------------------------------------------
|
|
.\" disable hyphenation
|
|
.nh
|
|
.\" disable justification (adjust text to left margin only)
|
|
.ad l
|
|
.\" -----------------------------------------------------------------
|
|
.\" * MAIN CONTENT STARTS HERE *
|
|
.\" -----------------------------------------------------------------
|
|
.SH "NAME"
|
|
mdsearch \- Run Spotlight searches against an SMB server
|
|
.SH "SYNOPSIS"
|
|
.HP \w'\ 'u
|
|
mdfine {server} {sharename} {query} [\-p,\ \-\-path=STRING] [\-L,\ \-\-live] [\-?|\-\-help] [\-\-usage] [\-d|\-\-debuglevel=DEBUGLEVEL] [\-\-debug\-stdout] [\-\-configfile=CONFIGFILE] [\-\-option=name=value] [\-l|\-\-log\-basename=LOGFILEBASE] [\-\-leak\-report] [\-\-leak\-report\-full] [\-R|\-\-name\-resolve=NAME\-RESOLVE\-ORDER] [\-O|\-\-socket\-options=SOCKETOPTIONS] [\-m|\-\-max\-protocol=MAXPROTOCOL] [\-n|\-\-netbiosname=NETBIOSNAME] [\-\-netbios\-scope=SCOPE] [\-W|\-\-workgroup=WORKGROUP] [\-\-realm=REALM] [\-U|\-\-user=[DOMAIN/]USERNAME[%PASSWORD]] [\-N|\-\-no\-pass] [\-\-password=STRING] [\-\-pw\-nt\-hash] [\-A|\-\-authentication\-file=FILE] [\-P|\-\-machine\-pass] [\-\-simple\-bind\-dn=DN] [\-\-use\-kerberos=desired|required|off] [\-\-use\-krb5\-ccache=CCACHE] [\-\-use\-winbind\-ccache] [\-\-client\-protection=sign|encrypt|off] [\-V|\-\-version]
|
|
.SH "DESCRIPTION"
|
|
.PP
|
|
This tool is part of the
|
|
\fBsamba\fR(1)
|
|
suite\&.
|
|
.PP
|
|
mdsearch is a simple utility to run Spotlight searches against an SMB server that runs the Spotlight
|
|
\fImdssvc\fR
|
|
RPC service\&.
|
|
.SH "OPTIONS"
|
|
.PP
|
|
server
|
|
.RS 4
|
|
The SMB server name or IP address to connect to\&.
|
|
.RE
|
|
.PP
|
|
sharename
|
|
.RS 4
|
|
The name of a share on the server\&.
|
|
.RE
|
|
.PP
|
|
query
|
|
.RS 4
|
|
The query expression syntax is a simplified form of filename globbing familiar to shell users\&. Queries have the following format:
|
|
.sp
|
|
attribute=="value"
|
|
.sp
|
|
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
|
|
/usr/share/samba/mdssvc/elasticsearch_mappings\&.json
|
|
.RE
|
|
.PP
|
|
\-p PATH, \-\-path=PATH
|
|
.RS 4
|
|
Server side path to search, defaults to
|
|
\fI"/"\fR
|
|
.RE
|
|
.PP
|
|
\-L, \-\-live
|
|
.RS 4
|
|
Query remains running\&.
|
|
.RE
|
|
.PP
|
|
\-?|\-\-help
|
|
.RS 4
|
|
Print a summary of command line options\&.
|
|
.RE
|
|
.PP
|
|
\-\-usage
|
|
.RS 4
|
|
Display brief usage message\&.
|
|
.RE
|
|
.PP
|
|
\-d|\-\-debuglevel=DEBUGLEVEL
|
|
.RS 4
|
|
\fIlevel\fR
|
|
is an integer from 0 to 10\&. The default value if this parameter is not specified is 1 for client applications\&.
|
|
.sp
|
|
The higher this value, the more detail will be logged to the log files about the activities of the server\&. At level 0, only critical errors and serious warnings will be logged\&. Level 1 is a reasonable level for day\-to\-day running \- it generates a small amount of information about operations carried out\&.
|
|
.sp
|
|
Levels above 1 will generate considerable amounts of log data, and should only be used when investigating a problem\&. Levels above 3 are designed for use only by developers and generate HUGE amounts of log data, most of which is extremely cryptic\&.
|
|
.sp
|
|
Note that specifying this parameter here will override the
|
|
\m[blue]\fBlog level\fR\m[]
|
|
parameter in the
|
|
smb\&.conf
|
|
file\&.
|
|
.RE
|
|
.PP
|
|
\-\-debug\-stdout
|
|
.RS 4
|
|
This will redirect debug output to STDOUT\&. By default all clients are logging to STDERR\&.
|
|
.RE
|
|
.PP
|
|
\-\-configfile=<configuration file>
|
|
.RS 4
|
|
The file specified contains the configuration details required by the client\&. The information in this file can be general for client and server or only provide client specific like options such as
|
|
\m[blue]\fBclient smb encrypt\fR\m[]\&. See
|
|
smb\&.conf
|
|
for more information\&. The default configuration file name is determined at compile time\&.
|
|
.RE
|
|
.PP
|
|
\-\-option=<name>=<value>
|
|
.RS 4
|
|
Set the
|
|
\fBsmb.conf\fR(5)
|
|
option "<name>" to value "<value>" from the command line\&. This overrides compiled\-in defaults and options read from the configuration file\&. If a name or a value includes a space, wrap whole \-\-option=name=value into quotes\&.
|
|
.RE
|
|
.PP
|
|
\-l|\-\-log\-basename=logdirectory
|
|
.RS 4
|
|
Base directory name for log/debug files\&. The extension
|
|
\fB"\&.progname"\fR
|
|
will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
|
|
.RE
|
|
.PP
|
|
\-\-leak\-report
|
|
.RS 4
|
|
Enable talloc leak reporting on exit\&.
|
|
.RE
|
|
.PP
|
|
\-\-leak\-report\-full
|
|
.RS 4
|
|
Enable full talloc leak reporting on exit\&.
|
|
.RE
|
|
.PP
|
|
\-V|\-\-version
|
|
.RS 4
|
|
Prints the program version number\&.
|
|
.RE
|
|
.PP
|
|
\-U|\-\-user=[DOMAIN\e]USERNAME[%PASSWORD]
|
|
.RS 4
|
|
Sets the SMB username or username and password\&.
|
|
.sp
|
|
If %PASSWORD is not specified, the user will be prompted\&. The client will first check the
|
|
\fBUSER\fR
|
|
environment variable (which is also permitted to also contain the password seperated by a %), then the
|
|
\fBLOGNAME\fR
|
|
variable (which is not permitted to contain a password) and if either exists, the value is used\&. If these environmental variables are not found, the username found in a Kerberos Credentials cache may be used\&.
|
|
.sp
|
|
A third option is to use a credentials file which contains the plaintext of the username and password\&. This option is mainly provided for scripts where the admin does not wish to pass the credentials on the command line or via environment variables\&. If this method is used, make certain that the permissions on the file restrict access from unwanted users\&. See the
|
|
\fI\-A\fR
|
|
for more details\&.
|
|
.sp
|
|
Be cautious about including passwords in scripts or passing user\-supplied values onto the command line\&. For security it is better to let the Samba client tool ask for the password if needed, or obtain the password once with
|
|
kinit\&.
|
|
.sp
|
|
While Samba will attempt to scrub the password from the process title (as seen in ps), this is after startup and so is subject to a race\&.
|
|
.RE
|
|
.PP
|
|
\-N|\-\-no\-pass
|
|
.RS 4
|
|
If specified, this parameter suppresses the normal password prompt from the client to the user\&. This is useful when accessing a service that does not require a password\&.
|
|
.sp
|
|
Unless a password is specified on the command line or this parameter is specified, the client will request a password\&.
|
|
.sp
|
|
If a password is specified on the command line and this option is also defined the password on the command line will be silently ignored and no password will be used\&.
|
|
.RE
|
|
.PP
|
|
\-\-password
|
|
.RS 4
|
|
Specify the password on the commandline\&.
|
|
.sp
|
|
Be cautious about including passwords in scripts or passing user\-supplied values onto the command line\&. For security it is better to let the Samba client tool ask for the password if needed, or obtain the password once with
|
|
kinit\&.
|
|
.sp
|
|
If \-\-password is not specified, the tool will check the
|
|
\fBPASSWD\fR
|
|
environment variable, followed by
|
|
\fBPASSWD_FD\fR
|
|
which is expected to contain an open file descriptor (FD) number\&.
|
|
.sp
|
|
Finally it will check
|
|
\fBPASSWD_FILE\fR
|
|
(containing a file path to be opened)\&. The file should only contain the password\&. Make certain that the permissions on the file restrict access from unwanted users!
|
|
.sp
|
|
While Samba will attempt to scrub the password from the process title (as seen in ps), this is after startup and so is subject to a race\&.
|
|
.RE
|
|
.PP
|
|
\-\-pw\-nt\-hash
|
|
.RS 4
|
|
The supplied password is the NT hash\&.
|
|
.RE
|
|
.PP
|
|
\-A|\-\-authentication\-file=filename
|
|
.RS 4
|
|
This option allows you to specify a file from which to read the username and password used in the connection\&. The format of the file is:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
username = <value>
|
|
password = <value>
|
|
domain = <value>
|
|
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.sp
|
|
Make certain that the permissions on the file restrict access from unwanted users!
|
|
.RE
|
|
.PP
|
|
\-P|\-\-machine\-pass
|
|
.RS 4
|
|
Use stored machine account password\&.
|
|
.RE
|
|
.PP
|
|
\-\-simple\-bind\-dn=DN
|
|
.RS 4
|
|
DN to use for a simple bind\&.
|
|
.RE
|
|
.PP
|
|
\-\-use\-kerberos=desired|required|off
|
|
.RS 4
|
|
This parameter determines whether Samba client tools will try to authenticate using Kerberos\&. For Kerberos authentication you need to use dns names instead of IP addresses when connnecting to a service\&.
|
|
.sp
|
|
Note that specifying this parameter here will override the
|
|
\m[blue]\fBclient use kerberos\fR\m[]
|
|
parameter in the
|
|
smb\&.conf
|
|
file\&.
|
|
.RE
|
|
.PP
|
|
\-\-use\-krb5\-ccache=CCACHE
|
|
.RS 4
|
|
Specifies the credential cache location for Kerberos authentication\&.
|
|
.sp
|
|
This will set \-\-use\-kerberos=required too\&.
|
|
.RE
|
|
.PP
|
|
\-\-use\-winbind\-ccache
|
|
.RS 4
|
|
Try to use the credential cache by winbind\&.
|
|
.RE
|
|
.PP
|
|
\-\-client\-protection=sign|encrypt|off
|
|
.RS 4
|
|
Sets the connection protection the client tool should use\&.
|
|
.sp
|
|
Note that specifying this parameter here will override the
|
|
\m[blue]\fBclient protection\fR\m[]
|
|
parameter in the
|
|
smb\&.conf
|
|
file\&.
|
|
.sp
|
|
In case you need more fine grained control you can use:
|
|
\-\-option=clientsmbencrypt=OPTION,
|
|
\-\-option=clientipcsigning=OPTION,
|
|
\-\-option=clientsigning=OPTION\&.
|
|
.RE
|
|
.SH "EXAMPLES"
|
|
.PP
|
|
Search all indexed metadata attributes, exact match:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
\*(Aq*=="Samba"\*(Aq
|
|
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
Search all indexed metadata attributes, prefix match:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
\*(Aq*=="Samba*"\*(Aq
|
|
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
Search by filename:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
\*(AqkMDItemFSName=="Samba*"\*(Aq
|
|
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
Search by date:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
\*(AqkMDItemFSContentChangeDate<$time\&.iso(2018\-10\-01T10:00:00Z)\*(Aq
|
|
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
Search files\*(Aqs content:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
\*(AqkMDItemTextContent=="Samba*"\*(Aq
|
|
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.PP
|
|
Expressions:
|
|
.sp
|
|
.if n \{\
|
|
.RS 4
|
|
.\}
|
|
.nf
|
|
kMDItemFSName=="Samba*"||kMDItemTextContent=="Tango*"\*(Aq
|
|
|
|
.fi
|
|
.if n \{\
|
|
.RE
|
|
.\}
|
|
.SH "SEE ALSO"
|
|
.PP
|
|
File Metadata Search Programming Guide
|
|
https://developer\&.apple\&.com/library/archive/documentation/Carbon/Conceptual/SpotlightQuery/Concepts/Introduction\&.html
|
|
.SH "VERSION"
|
|
.PP
|
|
This man page is part of version 4\&.16\&.4 of the Samba suite\&.
|
|
.SH "AUTHOR"
|
|
.PP
|
|
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\&.
|
|
.PP
|
|
The mdsearch manpage was written by Ralph Boehme\&.
|