escape all minus signs

This commit is contained in:
Jean-Francois Dockes 2011-02-15 08:02:05 +01:00
parent 36ce4166d7
commit 7b69a73dd4
4 changed files with 73 additions and 73 deletions

View File

@ -5,23 +5,23 @@ recoll \- user interface for the Recoll full text search system
.SH SYNOPSIS .SH SYNOPSIS
.B recoll .B recoll
[ [
.B -c .B \-c
<configdir> <configdir>
] ]
[ [
.B -o .B \-o
| |
.B -l .B \-l
| |
.B -f .B \-f
| |
.B -a .B \-a
] ]
[ [
.B -t .B \-t
] ]
[ [
.B -q .B \-q
<query> <query>
] ]
.SH DESCRIPTION .SH DESCRIPTION
@ -37,34 +37,34 @@ will create the user configuration which can be customized
before starting the first indexation. before starting the first indexation.
.PP .PP
The The
.B -c .B \-c
option specifies the configuration directory name, overriding the option specifies the configuration directory name, overriding the
default or $RECOLL_CONFDIR. default or $RECOLL_CONFDIR.
.PP .PP
The The
.B -q .B \-q
option can be used to specify an initial query on the command line. This 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. query will be interpreted by default as a query language string.
If If
.B -a .B \-a
is specified, the query string will be interpreted as an is specified, the query string will be interpreted as an
.I all words .I all words
simple search query. If simple search query. If
.B -o .B \-o
is specified, the query string will be interpreted as an is specified, the query string will be interpreted as an
.I any word .I any word
simple search query. If simple search query. If
.B -f .B \-f
is specified, the query string will be interpreted as a is specified, the query string will be interpreted as a
.I file name .I file name
simple search query. If simple search query. If
.B -l .B \-l
is specified, the query string will be interpreted as a is specified, the query string will be interpreted as a
.I query language .I query language
simple search query. simple search query.
.PP .PP
If If
.B -t .B \-t
is specified, the Graphical User Interface will not be started, and results is specified, the Graphical User Interface will not be started, and results
will be printed to the standard output. Additional options understood by will be printed to the standard output. Additional options understood by
the the

View File

@ -146,7 +146,7 @@ probably not be used.
.TP .TP
.BI "usesystemfilecommand = " boolean .BI "usesystemfilecommand = " boolean
Decide if we use the 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 system command as a final step for determining the mime type for a file
(the main procedure uses suffix associations as defined in the (the main procedure uses suffix associations as defined in the
.B mimemap .B mimemap

View File

@ -3,67 +3,67 @@
.SH NAME .SH NAME
recollindex \- indexing command for the Recoll full text search system recollindex \- indexing command for the Recoll full text search system
.SH SYNOPSIS .SH SYNOPSIS
.B recollindex -h .B recollindex \-h
.br .br
.B recollindex .B recollindex
[ [
.B -c .B \-c
<configdir> <configdir>
] ]
[ [
.B -z .B \-z
] ]
[ [
.B -m .B \-m
] ]
[ [
.B -w .B \-w
<seconds> <seconds>
] ]
[ [
.B -D .B \-D
] ]
[ [
.B -x .B \-x
] ]
.br .br
.B recollindex .B recollindex
[ [
.B -c .B \-c
<configdir> <configdir>
] ]
.B -i .B \-i
[<filename [filename ...]>] [<filename [filename ...]>]
.br .br
.B recollindex .B recollindex
[ [
.B -c .B \-c
<configdir> <configdir>
] ]
.B -e .B \-e
[<filename [filename ...]>] [<filename [filename ...]>]
.br .br
.B recollindex .B recollindex
[ [
.B -c .B \-c
<configdir> <configdir>
] ]
.B -l .B \-l
.br .br
.B recollindex .B recollindex
[ [
.B -c .B \-c
<configdir> <configdir>
] ]
.B -s .B \-s
<lang> <lang>
.br .br
.B recollindex .B recollindex
[ [
.B -c .B \-c
<configdir> <configdir>
] ]
.B -S .B \-S
.SH DESCRIPTION .SH DESCRIPTION
The The
@ -72,7 +72,7 @@ utility allows you to perform indexing operations for the Recoll text
search system. search system.
.PP .PP
The The
.B -c .B \-c
option specifies the configuration directory name, overriding the option specifies the configuration directory name, overriding the
default or $RECOLL_CONFDIR. default or $RECOLL_CONFDIR.
.PP .PP
@ -83,7 +83,7 @@ file
.B recoll.conf. .B recoll.conf.
This will incrementally update the database with files that changed since This will incrementally update the database with files that changed since
the last run. If option the last run. If option
.B -z .B \-z
is given, the database will be erased before starting. is given, the database will be erased before starting.
.PP .PP
If option If option
@ -108,44 +108,44 @@ Option
disables this X11 session monitoring (daemon will stay alive even if it disables this X11 session monitoring (daemon will stay alive even if it
cannot connect to the X11 server). cannot connect to the X11 server).
.PP .PP
.B recollindex -l .B recollindex \-l
will list the names of available language stemmers. will list the names of available language stemmers.
.PP .PP
The other modes are useful mainly for testing. The other modes are useful mainly for testing.
.PP .PP
.B recollindex -i .B recollindex \-i
will index individual files into the database. The stem expansion databases will index individual files into the database. The stem expansion databases
will not be updated. will not be updated.
.PP .PP
.B recollindex -e .B recollindex \-e
will erase data for individual files from the database. The stem expansion will erase data for individual files from the database. The stem expansion
databases will not be updated. databases will not be updated.
.PP .PP
With options With options
.B -i .B \-i
or or
.B -e .B \-e
, if no file names are given on the command line, they , if no file names are given on the command line, they
will be read from stdin, so that you could for example run: will be read from stdin, so that you could for example run:
.PP .PP
find /path/to/dir \-print | recollindex -e find /path/to/dir \-print | recollindex \-e
.PP .PP
followed by followed by
.PP .PP
find /path/to/dir \-print | recollindex -i find /path/to/dir \-print | recollindex \-i
.PP .PP
to force the reindexing of a directory tree (which has to exist inside the to force the reindexing of a directory tree (which has to exist inside the
file system area defined by file system area defined by
.I topdirs .I topdirs
in recoll.conf). in recoll.conf).
.PP .PP
.B recollindex -s .B recollindex \-s
will build the stem expansion database for a given language, which may or 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 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 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 at the end of the next normal indexing run. You can get the list of stemmer
names from the names from the
.B recollindex -l .B recollindex \-l
command. Note that this is mostly for experimental use, the normal way to 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 add a stemming language is to set it in the configuration, either by
editing "recoll.conf" or by using the GUI indexing configuration dialog. editing "recoll.conf" or by using the GUI indexing configuration dialog.
@ -181,7 +181,7 @@ spanish
.IP \(bu .IP \(bu
swedish swedish
.PP .PP
.B recollindex -S .B recollindex \-S
will rebuild the phonetic/orthographic index. This feature uses the will rebuild the phonetic/orthographic index. This feature uses the
.B aspell .B aspell
package, which must be installed on the system. package, which must be installed on the system.

View File

@ -5,50 +5,50 @@ recollq \- command line / standard output Recoll query command.
.SH SYNOPSIS .SH SYNOPSIS
.B recollq .B recollq
[ [
.B -c .B \-c
<configdir> <configdir>
] ]
[ [
.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
<cnt> <cnt>
] ]
[ [
.B -s .B \-s
<stemming language> <stemming language>
] ]
[ [
.B -S .B \-S
<fldname> <fldname>
] ]
[ [
.B -D .B \-D
] ]
[ [
.B -i .B \-i
<additional index directory> <additional index directory>
] ]
<query string> <query string>
.B recollq -P .B recollq \-P
.SH DESCRIPTION .SH DESCRIPTION
The The
@ -57,62 +57,62 @@ command will execute the Recoll query specified on the command line and
print the results to the standard output. print the results to the standard output.
.PP .PP
The The
.B -c .B \-c
option specifies the configuration directory name, overriding the option specifies the configuration directory name, overriding the
default or $RECOLL_CONFDIR. default or $RECOLL_CONFDIR.
.PP .PP
The query string will be interpreted by default as a query language string. The query string will be interpreted by default as a query language string.
If If
.B -a .B \-a
is specified, the query string will be interpreted as an is specified, the query string will be interpreted as an
.I all words .I all words
simple search query. If simple search query. If
.B -o .B \-o
is specified, the query string will be interpreted as an is specified, the query string will be interpreted as an
.I any word .I any word
simple search query. If simple search query. If
.B -f .B \-f
is specified, the query string will be interpreted as a is specified, the query string will be interpreted as a
.I file name .I file name
simple search query. simple search query.
.PP .PP
.B -b .B \-b
(basic) can be specified to only print the result urls in the output (basic) can be specified to only print the result urls in the output
stream. stream.
.PP .PP
If If
.B -d .B \-d
is set, the text for the result files contents will be dumped to stdout. is set, the text for the result files contents will be dumped to stdout.
.PP .PP
If If
.B -m .B \-m
is set, the whole metadata array will be dumped for each document. is set, the whole metadata array will be dumped for each document.
.PP .PP
If If
.B -A .B \-A
is set, the document abstracts will be printed. is set, the document abstracts will be printed.
.PP .PP
.B -S .B \-S
<fieldname> <fieldname>
sorts the results according to the specified field. Use sorts the results according to the specified field. Use
.B -D .B \-D
for descending order. for descending order.
.PP .PP
.B -n .B \-n
<cnt> <cnt>
can be used to set the maximum number of results that should be printed. can be used to set the maximum number of results that should be printed.
.PP .PP
.B -s .B \-s
<language> <language>
selects the word stemming language. The value should match an existing 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 .PP
.B -i .B \-i
<extra dbdir> <extra dbdir>
adds the specified Xapian index to the set used for the query. Can be adds the specified Xapian index to the set used for the query. Can be
specified multiple times. specified multiple times.
.PP .PP
.B recollq -P .B recollq \-P
(Period) will print the minimum and maximum modification years for (Period) will print the minimum and maximum modification years for
documents in the index. documents in the index.