Debian Codegraph @

upstream/opensuse-tumbleweed/man1/wspsearch.1

raw
1 '\" t
2 .\" Title: wspsearch
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: User Commands
7 .\" Source: Samba 4.23.8-git.477.f78166bceedSUSE-oS16.9-x86_64
8 .\" Language: English
9 .\"
10 .TH "WSPSEARCH" "1" "05/26/2026" "Samba 4\&.23\&.8\-git\&.477\&.f78166bcee" "User Commands"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 wspsearch \- Run Windows Search Protocol searches against a SMB server
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 wspsearch {//server/share} [\-\-limit=results] [\-\-search=phrase] [\-\-kind=KIND] [\-\-query=QUERY] [\-?|\-\-help] [\-\-usage] [\-d|\-\-debuglevel=DEBUGLEVEL] [\-\-debug\-stdout] [\-s|\-\-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]
35 .SH "DESCRIPTION"
36 .PP
37 This tool is part of the
38 \fBsamba\fR(1)
39 suite\&.
40 .PP
41 wspsearch is a simple utility to run Windows Search Protocol searches against a SMB server that has the WSP service enabled\&.
42 .SH "OPTIONS"
43 .PP
44 server
45 .RS 4
46 The SMB server name or IP address to connect to\&.
47 .RE
48 .PP
49 sharename
50 .RS 4
51 The name of a share on the server\&.
52 .RE
53 .PP
54 \-\-query
55 .RS 4
56 A query specified in simplified AQS\-like (Advanced query syntax)\&.
57 .sp
58 Basic (AQS) syntax is supported (See
59 \fISEE ALSO\fR)\&. A query consists of a sequence of queries connected by AND, OR and NOT boolean operators\&. The query elements are essentially restrictions defined by a property\&. There are some limitations on the operators supported and some types of properties like enumerated ranges are not supported at all\&. Additionally syntactically range values are not delimited as specified by AQS (ranges are instead specified as value\-value)\&. Some special cases that you see in the windows search UI (for example sizes like \*(Aqtiny\*(Aq, \*(Aqsmall\*(Aq, \*(Aqlarge\*(Aq etc\&.) are exceptions which are handled more or less as keywords\&. See
60 \fIEXAMPLES\fR\&.
61 .RE
62 .PP
63 \-\-search=phrase
64 .RS 4
65 A simple phrase that is searched across the index
66 .RE
67 .PP
68 \-\-kind=KIND
69 .RS 4
70 kind one of;
71 .RS
72 .sp
73 .RS 4
74 .ie n \{\
75 \h'-04'\(bu\h'+03'\c
76 .\}
77 .el \{\
78 .sp -1
79 .IP \(bu 2.3
80 .\}
81 \fICalendar\fR
82 .RE
83 .sp
84 .RS 4
85 .ie n \{\
86 \h'-04'\(bu\h'+03'\c
87 .\}
88 .el \{\
89 .sp -1
90 .IP \(bu 2.3
91 .\}
92 \fICommunication\fR
93 .RE
94 .sp
95 .RS 4
96 .ie n \{\
97 \h'-04'\(bu\h'+03'\c
98 .\}
99 .el \{\
100 .sp -1
101 .IP \(bu 2.3
102 .\}
103 \fIContact\fR
104 .RE
105 .sp
106 .RS 4
107 .ie n \{\
108 \h'-04'\(bu\h'+03'\c
109 .\}
110 .el \{\
111 .sp -1
112 .IP \(bu 2.3
113 .\}
114 \fIDocument\fR
115 .RE
116 .sp
117 .RS 4
118 .ie n \{\
119 \h'-04'\(bu\h'+03'\c
120 .\}
121 .el \{\
122 .sp -1
123 .IP \(bu 2.3
124 .\}
125 \fIEmail\fR
126 .RE
127 .sp
128 .RS 4
129 .ie n \{\
130 \h'-04'\(bu\h'+03'\c
131 .\}
132 .el \{\
133 .sp -1
134 .IP \(bu 2.3
135 .\}
136 \fIFeed\fR
137 .RE
138 .sp
139 .RS 4
140 .ie n \{\
141 \h'-04'\(bu\h'+03'\c
142 .\}
143 .el \{\
144 .sp -1
145 .IP \(bu 2.3
146 .\}
147 \fIFolder\fR
148 .RE
149 .sp
150 .RS 4
151 .ie n \{\
152 \h'-04'\(bu\h'+03'\c
153 .\}
154 .el \{\
155 .sp -1
156 .IP \(bu 2.3
157 .\}
158 \fIGame\fR
159 .RE
160 .sp
161 .RS 4
162 .ie n \{\
163 \h'-04'\(bu\h'+03'\c
164 .\}
165 .el \{\
166 .sp -1
167 .IP \(bu 2.3
168 .\}
169 \fIInstantMessage\fR
170 .RE
171 .sp
172 .RS 4
173 .ie n \{\
174 \h'-04'\(bu\h'+03'\c
175 .\}
176 .el \{\
177 .sp -1
178 .IP \(bu 2.3
179 .\}
180 \fIJournal\fR
181 .RE
182 .sp
183 .RS 4
184 .ie n \{\
185 \h'-04'\(bu\h'+03'\c
186 .\}
187 .el \{\
188 .sp -1
189 .IP \(bu 2.3
190 .\}
191 \fIMovie\fR
192 .RE
193 .sp
194 .RS 4
195 .ie n \{\
196 \h'-04'\(bu\h'+03'\c
197 .\}
198 .el \{\
199 .sp -1
200 .IP \(bu 2.3
201 .\}
202 \fIMusic\fR
203 .RE
204 .sp
205 .RS 4
206 .ie n \{\
207 \h'-04'\(bu\h'+03'\c
208 .\}
209 .el \{\
210 .sp -1
211 .IP \(bu 2.3
212 .\}
213 \fILink\fR
214 .RE
215 .sp
216 .RS 4
217 .ie n \{\
218 \h'-04'\(bu\h'+03'\c
219 .\}
220 .el \{\
221 .sp -1
222 .IP \(bu 2.3
223 .\}
224 \fINote\fR
225 .RE
226 .sp
227 .RS 4
228 .ie n \{\
229 \h'-04'\(bu\h'+03'\c
230 .\}
231 .el \{\
232 .sp -1
233 .IP \(bu 2.3
234 .\}
235 \fIPicture\fR
236 .RE
237 .sp
238 .RS 4
239 .ie n \{\
240 \h'-04'\(bu\h'+03'\c
241 .\}
242 .el \{\
243 .sp -1
244 .IP \(bu 2.3
245 .\}
246 \fIProgram\fR
247 .RE
248 .sp
249 .RS 4
250 .ie n \{\
251 \h'-04'\(bu\h'+03'\c
252 .\}
253 .el \{\
254 .sp -1
255 .IP \(bu 2.3
256 .\}
257 \fIRecordedTV\fR
258 .RE
259 .sp
260 .RS 4
261 .ie n \{\
262 \h'-04'\(bu\h'+03'\c
263 .\}
264 .el \{\
265 .sp -1
266 .IP \(bu 2.3
267 .\}
268 \fISearchFolder\fR
269 .RE
270 .sp
271 .RS 4
272 .ie n \{\
273 \h'-04'\(bu\h'+03'\c
274 .\}
275 .el \{\
276 .sp -1
277 .IP \(bu 2.3
278 .\}
279 \fITask\fR
280 .RE
281 .sp
282 .RS 4
283 .ie n \{\
284 \h'-04'\(bu\h'+03'\c
285 .\}
286 .el \{\
287 .sp -1
288 .IP \(bu 2.3
289 .\}
290 \fIVideo\fR
291 .RE
292 .sp
293 .RS 4
294 .ie n \{\
295 \h'-04'\(bu\h'+03'\c
296 .\}
297 .el \{\
298 .sp -1
299 .IP \(bu 2.3
300 .\}
301 \fIWebHistory\fR
302 .RE
303 .sp
304 .RE
305 .RE
306 .PP
307 \-\-limit
308 .RS 4
309 A limit on the number of results returned, by default there is a limit of 500 results, a limit of 0 indicates no limit and all results will be returned\&.
310 .RE
311 .PP
312 \-?|\-\-help
313 .RS 4
314 Print a summary of command line options\&.
315 .RE
316 .PP
317 \-\-usage
318 .RS 4
319 Display brief usage message\&.
320 .RE
321 .PP
322 \-d|\-\-debuglevel=level
323 .RS 4
324 \fIlevel\fR
325 is an integer from 0 to 10\&. The default value if this parameter is not specified is 1 for client applications\&.
326 .sp
327 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\&.
328 .sp
329 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\&.
330 .sp
331 Note that specifying this parameter here will override the
332 \m[blue]\fBlog level\fR\m[]
333 parameter in the
334 /etc/samba/smb\&.conf
335 file\&.
336 .RE
337 .PP
338 \-\-debug\-stdout
339 .RS 4
340 This will redirect debug output to STDOUT\&. By default all clients are logging to STDERR\&.
341 .RE
342 .PP
343 \-\-configfile=<configuration file>
344 .RS 4
345 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
346 \m[blue]\fBclient smb encrypt\fR\m[]\&. See
347 /etc/samba/smb\&.conf
348 for more information\&. The default configuration file name is determined at compile time\&.
349 .RE
350 .PP
351 \-\-option=<name>=<value>
352 .RS 4
353 Set the
354 \fBsmb.conf\fR(5)
355 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\&.
356 .RE
357 .PP
358 \-l|\-\-log\-basename=logdirectory
359 .RS 4
360 Base directory name for log/debug files\&. The extension
361 \fB"\&.progname"\fR
362 will be appended (e\&.g\&. log\&.smbclient, log\&.smbd, etc\&.\&.\&.)\&. The log file is never removed by the client\&.
363 .RE
364 .PP
365 \-\-leak\-report
366 .RS 4
367 Enable talloc leak reporting on exit\&.
368 .RE
369 .PP
370 \-\-leak\-report\-full
371 .RS 4
372 Enable full talloc leak reporting on exit\&.
373 .RE
374 .PP
375 \-V|\-\-version
376 .RS 4
377 Prints the program version number\&.
378 .RE
379 .PP
380 \-U|\-\-user=[DOMAIN\e]USERNAME[%PASSWORD]
381 .RS 4
382 Sets the SMB username or username and password\&.
383 .sp
384 If %PASSWORD is not specified, the user will be prompted\&. The client will first check the
385 \fBUSER\fR
386 environment variable (which is also permitted to also contain the password separated by a %), then the
387 \fBLOGNAME\fR
388 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\&.
389 .sp
390 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
391 \fI\-A\fR
392 for more details\&.
393 .sp
394 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
395 kinit\&.
396 .sp
397 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\&.
398 .RE
399 .PP
400 \-N|\-\-no\-pass
401 .RS 4
402 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\&.
403 .sp
404 Unless a password is specified on the command line or this parameter is specified, the client will request a password\&.
405 .sp
406 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\&.
407 .RE
408 .PP
409 \-\-password
410 .RS 4
411 Specify the password on the commandline\&.
412 .sp
413 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
414 kinit\&.
415 .sp
416 If \-\-password is not specified, the tool will check the
417 \fBPASSWD\fR
418 environment variable, followed by
419 \fBPASSWD_FD\fR
420 which is expected to contain an open file descriptor (FD) number\&.
421 .sp
422 Finally it will check
423 \fBPASSWD_FILE\fR
424 (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!
425 .sp
426 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\&.
427 .RE
428 .PP
429 \-\-pw\-nt\-hash
430 .RS 4
431 The supplied password is the NT hash\&.
432 .RE
433 .PP
434 \-A|\-\-authentication\-file=filename
435 .RS 4
436 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:
437 .sp
438 .if n \{\
439 .RS 4
440 .\}
441 .nf
442 username = <value>
443 password = <value>
444 domain = <value>
445
446 .fi
447 .if n \{\
448 .RE
449 .\}
450 .sp
451 Make certain that the permissions on the file restrict access from unwanted users!
452 .RE
453 .PP
454 \-P|\-\-machine\-pass
455 .RS 4
456 Use stored machine account password\&.
457 .RE
458 .PP
459 \-\-simple\-bind\-dn=DN
460 .RS 4
461 DN to use for a simple bind\&.
462 .RE
463 .PP
464 \-\-use\-kerberos=desired|required|off
465 .RS 4
466 This parameter determines whether Samba client tools will try to authenticate using Kerberos\&. For Kerberos authentication you should use DNS names instead of IP addresses when connecting to a service\&. By default Samba client tools will try to use the default Kerberos credential cache (ccache)\&. In case the ccache does not exist or \-U|\-\-user option was specified, clients will ask to enter a password and will obtain a Kerberos ticket (kinit) for you\&. If you want to use an alternative Kerberos credentical cache, use the \-\-use\-krb5\-ccache option\&.
467 .sp
468 Note that specifying this parameter here will override the
469 \m[blue]\fBclient use kerberos\fR\m[]
470 parameter in the
471 /etc/samba/smb\&.conf
472 file\&.
473 .RE
474 .PP
475 \-\-use\-krb5\-ccache=CCACHE
476 .RS 4
477 Specifies the credential cache location for Kerberos authentication\&.
478 .sp
479 This will enforce \-\-use\-kerberos=required\&.
480 .RE
481 .PP
482 \-\-use\-winbind\-ccache
483 .RS 4
484 Try to use the credential cache by winbind\&.
485 .RE
486 .PP
487 \-\-client\-protection=sign|encrypt|off
488 .RS 4
489 Sets the connection protection the client tool should use\&.
490 .sp
491 Note that specifying this parameter here will override the
492 \m[blue]\fBclient protection\fR\m[]
493 parameter in the
494 /etc/samba/smb\&.conf
495 file\&.
496 .sp
497 In case you need more fine grained control you can use:
498 \-\-option=clientsmbencrypt=OPTION,
499 \-\-option=clientipcsigning=OPTION,
500 \-\-option=clientsigning=OPTION\&.
501 .RE
502 .SH "EXAMPLES"
503 .PP
504 Search using a basic phrase:
505 .sp
506 .if n \{\
507 .RS 4
508 .\}
509 .nf
510 \*(Aqwspsearch \-Usomeuser%password //server/share \-\-phrase="cats"\*(Aq
511 .fi
512 .if n \{\
513 .RE
514 .\}
515 .PP
516 Search using an AQS like query for a picture whose name starts with p403 or p404:
517 .sp
518 .if n \{\
519 .RS 4
520 .\}
521 .nf
522 \*(Aqwspsearch \-Usomeuser%password //server/share \-\-query="ALL:$<p403 OR ALL:$<p404 AND System\&.Kind:picture"\*(Aq
523 .fi
524 .if n \{\
525 .RE
526 .\}
527 .SH "SEE ALSO"
528 .PP
529 Adanced Query Syntax
530 https://learn\&.microsoft\&.com/en\-gb/windows/win32/search/\-search\-3x\-advancedquerysyntax
531 .SH "VERSION"
532 .PP
533 This man page is part of version 4\&.23\&.8\-git\&.477\&.f78166bceedSUSE\-oS16\&.9\-x86_64 of the Samba suite\&.
534 .SH "AUTHOR"
535 .PP
536 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\&.
537 .PP
538 The wspsearch manpage was written by Noel Power\&.