Switch to unified view

a/src/doc/man/recollq.1 b/src/doc/man/recollq.1
...
...
3
.SH NAME
3
.SH NAME
4
recollq \- command line / standard output Recoll query command.
4
recollq \- command line / standard output Recoll query command.
5
.SH SYNOPSIS
5
.SH SYNOPSIS
6
.B recollq
6
.B recollq
7
[
7
[
8
.B -c
8
.B \-c
9
<configdir>
9
<configdir>
10
]
10
]
11
[
11
[
12
.B -o
12
.B \-o
13
|
13
|
14
.B -f
14
.B \-f
15
|
15
|
16
.B -a
16
.B \-a
17
]
17
]
18
[
18
[
19
.B -b
19
.B \-b
20
]
20
]
21
[
21
[
22
.B -d
22
.B \-d
23
]
23
]
24
[
24
[
25
.B -A
25
.B \-A
26
]
26
]
27
[
27
[
28
.B -m
28
.B \-m
29
]
29
]
30
[
30
[
31
.B -n
31
.B \-n
32
<cnt>
32
<cnt>
33
]
33
]
34
[
34
[
35
.B -s
35
.B \-s
36
<stemming language>
36
<stemming language>
37
]
37
]
38
[
38
[
39
.B -S
39
.B \-S
40
<fldname>
40
<fldname>
41
]
41
]
42
[
42
[
43
.B -D
43
.B \-D
44
]
44
]
45
[
45
[
46
.B -i
46
.B \-i
47
<additional index directory>
47
<additional index directory>
48
]
48
]
49
<query string>
49
<query string>
50
50
51
.B recollq -P
51
.B recollq \-P
52
52
53
.SH DESCRIPTION
53
.SH DESCRIPTION
54
The
54
The
55
.B recollq
55
.B recollq
56
command will execute the Recoll query specified on the command line and
56
command will execute the Recoll query specified on the command line and
57
print the results to the standard output.
57
print the results to the standard output.
58
.PP
58
.PP
59
The 
59
The 
60
.B -c 
60
.B \-c 
61
option specifies the configuration directory name, overriding the
61
option specifies the configuration directory name, overriding the
62
default or $RECOLL_CONFDIR.
62
default or $RECOLL_CONFDIR.
63
.PP
63
.PP
64
The query string will be interpreted by default as a query language string.
64
The query string will be interpreted by default as a query language string.
65
If
65
If
66
.B -a 
66
.B \-a 
67
is specified, the query string will be interpreted as an
67
is specified, the query string will be interpreted as an
68
.I all words
68
.I all words
69
simple search query. If 
69
simple search query. If 
70
.B -o 
70
.B \-o 
71
is specified, the query string will be interpreted as an
71
is specified, the query string will be interpreted as an
72
.I any word
72
.I any word
73
simple search query. If 
73
simple search query. If 
74
.B -f
74
.B \-f
75
is specified, the query string will be interpreted as a
75
is specified, the query string will be interpreted as a
76
.I file name
76
.I file name
77
simple search query. 
77
simple search query. 
78
.PP
78
.PP
79
.B -b
79
.B \-b
80
(basic) can be specified to only print the result urls in the output
80
(basic) can be specified to only print the result urls in the output
81
stream.
81
stream.
82
.PP
82
.PP
83
If 
83
If 
84
.B -d
84
.B \-d
85
is set, the text for the result files contents will be dumped to stdout.
85
is set, the text for the result files contents will be dumped to stdout.
86
.PP
86
.PP
87
If 
87
If 
88
.B -m
88
.B \-m
89
is set, the whole metadata array will be dumped for each document.
89
is set, the whole metadata array will be dumped for each document.
90
.PP
90
.PP
91
If 
91
If 
92
.B -A
92
.B \-A
93
is set, the document abstracts will be printed.
93
is set, the document abstracts will be printed.
94
.PP
94
.PP
95
.B -S
95
.B \-S
96
<fieldname>
96
<fieldname>
97
sorts the results according to the specified field. Use 
97
sorts the results according to the specified field. Use 
98
.B -D 
98
.B \-D 
99
for descending order.
99
for descending order.
100
.PP
100
.PP
101
.B -n
101
.B \-n
102
<cnt>
102
<cnt>
103
can be used to set the maximum number of results that should be printed.
103
can be used to set the maximum number of results that should be printed.
104
.PP
104
.PP
105
.B -s
105
.B \-s
106
<language>
106
<language>
107
selects the word stemming language. The value should match an existing
107
selects the word stemming language. The value should match an existing
108
stemming database (as set in the configuration or added with recollindex -s).
108
stemming database (as set in the configuration or added with recollindex \-s).
109
.PP
109
.PP
110
.B -i
110
.B \-i
111
<extra dbdir>
111
<extra dbdir>
112
adds the specified Xapian index to the set used for the query. Can be
112
adds the specified Xapian index to the set used for the query. Can be
113
specified multiple times.
113
specified multiple times.
114
.PP
114
.PP
115
.B recollq -P
115
.B recollq \-P
116
(Period) will print the minimum and maximum modification years for
116
(Period) will print the minimum and maximum modification years for
117
documents in the index.
117
documents in the index.
118
118
119
.SH SEE ALSO
119
.SH SEE ALSO
120
.PP 
120
.PP