diff --git a/src/doc/man/recoll.1 b/src/doc/man/recoll.1 index 1f3cd40c..88b80492 100644 --- a/src/doc/man/recoll.1 +++ b/src/doc/man/recoll.1 @@ -5,23 +5,23 @@ recoll \- user interface for the Recoll full text search system .SH SYNOPSIS .B recoll [ -.B -c +.B \-c ] [ -.B -o +.B \-o | -.B -l +.B \-l | -.B -f +.B \-f | -.B -a +.B \-a ] [ -.B -t +.B \-t ] [ -.B -q +.B \-q ] .SH DESCRIPTION @@ -37,34 +37,34 @@ will create the user configuration which can be customized before starting the first indexation. .PP The -.B -c +.B \-c option specifies the configuration directory name, overriding the default or $RECOLL_CONFDIR. .PP The -.B -q +.B \-q option can be used to specify an initial query on the command line. This query will be interpreted by default as a query language string. If -.B -a +.B \-a is specified, the query string will be interpreted as an .I all words simple search query. If -.B -o +.B \-o is specified, the query string will be interpreted as an .I any word simple search query. If -.B -f +.B \-f is specified, the query string will be interpreted as a .I file name simple search query. If -.B -l +.B \-l is specified, the query string will be interpreted as a .I query language simple search query. .PP If -.B -t +.B \-t is specified, the Graphical User Interface will not be started, and results will be printed to the standard output. Additional options understood by the diff --git a/src/doc/man/recoll.conf.5 b/src/doc/man/recoll.conf.5 index b18fa7a2..872b1f9a 100644 --- a/src/doc/man/recoll.conf.5 +++ b/src/doc/man/recoll.conf.5 @@ -146,7 +146,7 @@ probably not be used. .TP .BI "usesystemfilecommand = " boolean Decide if we use the -.B "file -i" +.B "file \-i" system command as a final step for determining the mime type for a file (the main procedure uses suffix associations as defined in the .B mimemap diff --git a/src/doc/man/recollindex.1 b/src/doc/man/recollindex.1 index 175d52ca..fb5ef69b 100644 --- a/src/doc/man/recollindex.1 +++ b/src/doc/man/recollindex.1 @@ -3,67 +3,67 @@ .SH NAME recollindex \- indexing command for the Recoll full text search system .SH SYNOPSIS -.B recollindex -h +.B recollindex \-h .br .B recollindex [ -.B -c +.B \-c ] [ -.B -z +.B \-z ] [ -.B -m +.B \-m ] [ -.B -w +.B \-w ] [ -.B -D +.B \-D ] [ -.B -x +.B \-x ] .br .B recollindex [ -.B -c +.B \-c ] -.B -i +.B \-i [] .br .B recollindex [ -.B -c +.B \-c ] -.B -e +.B \-e [] .br .B recollindex [ -.B -c +.B \-c ] -.B -l +.B \-l .br .B recollindex [ -.B -c +.B \-c ] -.B -s +.B \-s .br .B recollindex [ -.B -c +.B \-c ] -.B -S +.B \-S .SH DESCRIPTION The @@ -72,7 +72,7 @@ utility allows you to perform indexing operations for the Recoll text search system. .PP The -.B -c +.B \-c option specifies the configuration directory name, overriding the default or $RECOLL_CONFDIR. .PP @@ -83,7 +83,7 @@ file .B recoll.conf. This will incrementally update the database with files that changed since the last run. If option -.B -z +.B \-z is given, the database will be erased before starting. .PP If option @@ -108,44 +108,44 @@ Option disables this X11 session monitoring (daemon will stay alive even if it cannot connect to the X11 server). .PP -.B recollindex -l +.B recollindex \-l will list the names of available language stemmers. .PP The other modes are useful mainly for testing. .PP -.B recollindex -i +.B recollindex \-i will index individual files into the database. The stem expansion databases will not be updated. .PP -.B recollindex -e +.B recollindex \-e will erase data for individual files from the database. The stem expansion databases will not be updated. .PP With options -.B -i +.B \-i or -.B -e +.B \-e , if no file names are given on the command line, they will be read from stdin, so that you could for example run: .PP -find /path/to/dir \-print | recollindex -e +find /path/to/dir \-print | recollindex \-e .PP followed by .PP -find /path/to/dir \-print | recollindex -i +find /path/to/dir \-print | recollindex \-i .PP to force the reindexing of a directory tree (which has to exist inside the file system area defined by .I topdirs in recoll.conf). .PP -.B recollindex -s +.B recollindex \-s will build the stem expansion database for a given language, which may or may not be part of the list in the configuration file. If the language is not part of the configuration, the stem expansion database will be deleted at the end of the next normal indexing run. You can get the list of stemmer names from the -.B recollindex -l +.B recollindex \-l command. Note that this is mostly for experimental use, the normal way to add a stemming language is to set it in the configuration, either by editing "recoll.conf" or by using the GUI indexing configuration dialog. @@ -181,7 +181,7 @@ spanish .IP \(bu swedish .PP -.B recollindex -S +.B recollindex \-S will rebuild the phonetic/orthographic index. This feature uses the .B aspell package, which must be installed on the system. diff --git a/src/doc/man/recollq.1 b/src/doc/man/recollq.1 index 6b835d93..4634bc61 100644 --- a/src/doc/man/recollq.1 +++ b/src/doc/man/recollq.1 @@ -5,50 +5,50 @@ recollq \- command line / standard output Recoll query command. .SH SYNOPSIS .B recollq [ -.B -c +.B \-c ] [ -.B -o +.B \-o | -.B -f +.B \-f | -.B -a +.B \-a ] [ -.B -b +.B \-b ] [ -.B -d +.B \-d ] [ -.B -A +.B \-A ] [ -.B -m +.B \-m ] [ -.B -n +.B \-n ] [ -.B -s +.B \-s ] [ -.B -S +.B \-S ] [ -.B -D +.B \-D ] [ -.B -i +.B \-i ] -.B recollq -P +.B recollq \-P .SH DESCRIPTION The @@ -57,62 +57,62 @@ command will execute the Recoll query specified on the command line and print the results to the standard output. .PP The -.B -c +.B \-c option specifies the configuration directory name, overriding the default or $RECOLL_CONFDIR. .PP The query string will be interpreted by default as a query language string. If -.B -a +.B \-a is specified, the query string will be interpreted as an .I all words simple search query. If -.B -o +.B \-o is specified, the query string will be interpreted as an .I any word simple search query. If -.B -f +.B \-f is specified, the query string will be interpreted as a .I file name simple search query. .PP -.B -b +.B \-b (basic) can be specified to only print the result urls in the output stream. .PP If -.B -d +.B \-d is set, the text for the result files contents will be dumped to stdout. .PP If -.B -m +.B \-m is set, the whole metadata array will be dumped for each document. .PP If -.B -A +.B \-A is set, the document abstracts will be printed. .PP -.B -S +.B \-S sorts the results according to the specified field. Use -.B -D +.B \-D for descending order. .PP -.B -n +.B \-n can be used to set the maximum number of results that should be printed. .PP -.B -s +.B \-s selects the word stemming language. The value should match an existing -stemming database (as set in the configuration or added with recollindex -s). +stemming database (as set in the configuration or added with recollindex \-s). .PP -.B -i +.B \-i adds the specified Xapian index to the set used for the query. Can be specified multiple times. .PP -.B recollq -P +.B recollq \-P (Period) will print the minimum and maximum modification years for documents in the index.