MatSpoon::MultiSearch
FileSearch - Copyright (C) 2009-2010 Mathieu Bertin
http://multi-search.sf.net/

=================================== Manual ===================================

FileSearch first reads data from the file "settings.conf".
Here you will find the location of the languages files (in the "lang" directory), the locations of the files "searchTypes.conf", "excludedSites.conf" and "excludedTitles.conf" and of the directory "searchTypes".


** Settings of the file "settings.conf"
== PARAMETER ==             == DEFAULT ==                                    == MEANING ==
configFileLanguage          lang\language.conf;lang\language-${LOCALE}.conf  location of the default language file and the automatically locale detected file
configFileSearchTypes       searchTypes.conf                                 location of the file of search types settings
configFileExcludedSites     excludedSites.conf                               location of the file for excluding site from results
configFileExcludedTitles    excludedTitles.conf                              location of the file for excluding anchor label of specific search sites from results
maxNbResultsTotal           200                                              The maximum number of results for the whole search is limited to 200 unique links
maxNbResultsPerSite         1000                                             The maximum number of results of each search website is limited to 1000 unique links
defaultNbResults            30                                               This is the default number of results wanted
allowEmptySearch            0                                                Allow an empty search (0=false, 1=true)
showFullURL                 0                                                In the results box, shows the full URL link (1=true) or only the URL domain (0=false)
userAgent                   Mozilla/5.0 (Windows; U; Windows NT)             User agent ID sent to web servers
msecBetweenRequests         1000                                             Delay between each search page call (in milliseconds) to avoid the hammering of servers
configSeparator             |                                                Character used in configuration files
exportFilename              %TEMP%\MultiSearch\${SEARCH}.csv                 Default exported CSV file where ${SEARCH} is the user search terms
exportInvalidChars          \/:*?"<>|                                        These characters are removed from the user search terms in order to create for exporting the CSV file
exportSeparator             ;                                                Separator used in CSV file to delimit the columns
resultRow                   ${TITLE} (${URL}) [${SOURCE}/${RANK}]            In the results box, here how to display each result where ${TITLE} is anchor label, ${URL} is the full or domain URL, ${SOURCE} is the search site name and ${RANK} is the rank in the search site
searchTypesDirectory        searchTypes                                      Directory where are stored all search type files
defaultSearch                                                                Default text to search
openAllWithoutWarning       5                                                With clicking on "Open all URL links", allows MultiSearch to open up to 5 URL without warning the end-user
disableMultiThreading       0                                                Disable multi-threaded searches (0=multi-threading enabled when not disabled in search type, 1=multi-threading disabled)
logFile                     global.log                                       Name of the log file. This file can be usefull to check the URL called by the programming for debugging your own search type files.
disableLog                  1                                                Disable the creation of the log file. Can be usefull for your privacy. (0=false : log is created, 1=true, no log file is created). Note that the log file can be usefull to debug the user settings.


** Languages files located in the directory "lang"
Please read the file "translate.txt" for detailled explanations.


** Settings of the file "searchTypes.conf"
Each line starting with a pipe (|) depending of the "settings.conf::configSeparator" parameter value. These lines are ignored.
Each valid line consists in 3 parameters and each parameter is separated with a pipe (|) also.
== PARAMETER ==                 == EXAMPLE ==                   == MEANING ==
search type label               General search (everything)     This is the search type name which appears in the combo box
search type file                general.conf                    Name of the search type settings file located in the directory "searchTypes" (see the parameter "settings.conf::searchTypesDirectory")
optional search parameters      ${SEARCH}                       This is what is inserted in the search site URL. This may be usefull for reusing a common search file settings file with specific additional search terms. For instance, you could used "${SEARCH}+%2Bfree" to add the expression "+free" to the user search terms.


** Settings of the search type files located in the directory "searchTypes" (see the parameter "settings.conf::searchTypesDirectory")
Please read the file "general.conf" for samples and detailled explanations.
Each line starting with a pipe (|) depending of the "settings.conf::configSeparator" parameter value. These lines are ignored.
Each valid line consists in at least 5 parameters and each parameter is separated with a pipe (|) also.
If you have issues using page number calculus parameters (page-number-A and page-number-B), please enabled the log file (see the settings of the file "settings.conf").
You will be able to check the URL search pages called by the program and to fix your settings if required.


** Settings of the file "excludedSites.conf"
Each line starting with a pipe (|) depending of the "settings.conf::configSeparator" parameter value. These lines are ignored.
Each valid line consists in at least 1 parameter and each parameter is separated with a pipe (|) also.
== PARAMETER ==    == EXAMPLE ==      == MEANING ==
part of URL        .bannedsite.net    All links containing this part can be ignored depending on the match method option
match method       0                  Optional parameter. The default match method is "Exclude when the part of URL is contained in the result URL". Please see the file "excludedSites.conf" for detailled explanations.


** Settings of the file "excludedTitles.conf"
Each line starting with a pipe (|) depending of the "settings.conf::configSeparator" parameter value. These lines are ignored.
Each valid line consists in at least 2 parameters and each parameter is separated with a pipe (|) also.
== PARAMETER ==    == EXAMPLE ==      == MEANING ==
part of URL        .yahoo.com         Part of the search website defined in search type files
anchor label       Cached             Label of anchor that are exclured
match method       0                  Optinal parameter. The default match method is "Exclude results when their anchor label exactly matches the 'anchor label'". Please see the file "excludedTitles.conf" for detailled explanations.


Your feedbacks are welcome. Thank you for reading.
** End of manual **
