OS Manuals

/usr/bin/wspsearch

Tools to access a server's filespace and printers via SMB

From samba 4.25.1-r1 (os), captured 2026-11-05 by running wspsearch --help (exit 0). permalink

Usage: wspsearch [OPTIONS] //server1/share1
      --limit=default is 500, specifying 0 means unlimited     limit results
      --search=phrase                                          Search phrase
      --kind=kind                                              Kind of thing
                                                               to search for
                                                               [Calendar|Communication|Contact|Document|Email|Feed|Folder|Game|InstantMessage|Journal|Link|Movie|Music|Note|Picture|Program|RecordedTV|SearchFolder|Task|Video|WebHistory]
      --query=query                                            specify a more
                                                               complex query

Help options:
  -?, --help                                                   Show this help
                                                               message
      --usage                                                  Display brief
                                                               usage message

Common Samba options:
  -d, --debuglevel=DEBUGLEVEL                                  Set debug level
      --debug-stdout                                           Send debug
                                                               output to
                                                               standard output
  -s, --configfile=CONFIGFILE                                  Use alternative
                                                               configuration
                                                               file
      --option=name=value                                      Set smb.conf
                                                               option from
                                                               command line
  -l, --log-basename=LOGFILEBASE                               Basename for
                                                               log/debug files
      --leak-report                                            enable talloc
                                                               leak reporting
                                                               on exit
      --leak-report-full                                       enable full
                                                               talloc leak
                                                               reporting on
                                                               exit

Connection options:
  -R, --name-resolve=NAME-RESOLVE-ORDER                        Use these name
                                                               resolution
                                                               services only
  -O, --socket-options=SOCKETOPTIONS                           socket options
                                                               to use
  -m, --max-protocol=MAXPROTOCOL                               Set max
                                                               protocol level
  -n, --netbiosname=NETBIOSNAME                                Primary netbios
                                                               name
      --netbios-scope=SCOPE                                    Use this
                                                               Netbios scope
  -W, --workgroup=WORKGROUP                                    Set the
                                                               workgroup name
      --realm=REALM                                            Set the realm
                                                               name

Credential options:
  -U, --user=[DOMAIN/]USERNAME[%PASSWORD]                      Set the network
                                                               username
  -N, --no-pass                                                Don't ask for a
                                                               password
      --password=STRING                                        Password
      --pw-nt-hash                                             The supplied
                                                               password is the
                                                               NT hash
  -A, --authentication-file=FILE                               Get the
                                                               credentials
                                                               from a file
  -P, --machine-pass                                           Use stored
                                                               machine account
                                                               password
      --simple-bind-dn=DN                                      DN to use for a
                                                               simple bind
      --use-kerberos=desired|required|off                      Use Kerberos
                                                               authentication
      --use-krb5-ccache=CCACHE                                 Credentials
                                                               cache location
                                                               for Kerberos
      --use-winbind-ccache                                     Use the winbind
                                                               ccache for
                                                               authentication
      --client-protection=sign|encrypt|off                     Configure used
                                                               protection for
                                                               client
                                                               connections
Options (31)
OptionDescriptionSource
--limit defaultlimit resultshelp
--search phraseSearch phrasehelp
--kind kindKind of thing to search for [Calendar|Communication|Contact|Document|Email|Feed|Folder|Game|InstantMessage|Journal|Link|Movie|Music|Note|Picture|Program|RecordedTV|SearchFolder|Task|Video|WebHistory]help
--query queryspecify a more complex queryhelp
-?, --helpShow this help messagehelp
--usageDisplay brief usage messagehelp
-d, --debuglevel DEBUGLEVELSet debug levelhelp
--debug-stdoutSend debug output to standard outputhelp
-s, --configfile CONFIGFILEUse alternative configuration filehelp
--option name=valueSet smb.conf option from command linehelp
-l, --log-basename LOGFILEBASEBasename for log/debug fileshelp
--leak-reportenable talloc leak reporting on exithelp
--leak-report-fullenable full talloc leak reporting on exithelp
-R, --name-resolve NAME-RESOLVE-ORDERUse these name resolution services onlyhelp
-O, --socket-options SOCKETOPTIONSsocket options to usehelp
-m, --max-protocol MAXPROTOCOLSet max protocol levelhelp
-n, --netbiosname NETBIOSNAMEPrimary netbios namehelp
--netbios-scope SCOPEUse this Netbios scopehelp
-W, --workgroup WORKGROUPSet the workgroup namehelp
--realm REALMSet the realm namehelp
-U, --user DOMAIN/]USERNAME[%PASSWORDSet the network usernamehelp
-N, --no-passDon't ask for a passwordhelp
--password STRINGPasswordhelp
--pw-nt-hashThe supplied password is the NT hashhelp
-A, --authentication-file FILEGet the credentials from a filehelp
-P, --machine-passUse stored machine account passwordhelp
--simple-bind-dn DNDN to use for a simple bindhelp
--use-kerberos desired|required|offUse Kerberos authenticationhelp
--use-krb5-ccache CCACHECredentials cache location for Kerberoshelp
--use-winbind-ccacheUse the winbind ccache for authenticationhelp
--client-protection sign|encrypt|offConfigure used protection for client connectionshelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.