← Back to branch summary

~ubuntu-branches/ubuntu/quantal/recoll/quantal

« back to all changes in this revision

Viewing changes to doc/man/recollq.1

  • Committer: Package Import Robot
  • Author(s): Kartik Mistry
  • Date: 2012-03-27 12:15:51 UTC
  • mfrom: (1.3.8)
  • Revision ID: package-import@ubuntu.com-20120327121551-nmntidzpehudushy
Tags: 1.17.1-1
* New upstream release.
* Enable Python module resulting into new binary: python-recoll.
* debian/control:
  + Updated Build-Deps: libqtwebkit-dev, python-all-dev.
  + Added python-recoll binary.
  + Updated Standards-Version to 3.9.3
* debian/rules:
  + Build Python module by default.
* debian/recoll.menu, debian/python-recoll.install, debian/recoll.install:
  + Changes for new binary package.
* debian/copyright:
  + Updated to copyright-format 1.0
  + Updated upstream and Debian copyright.
  + Fixed unicode.org/copyright.html URL.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/man/recollq.1
25
25
.B \-A
26
26
]
27
27
[
 
28
.B \-e
 
29
]
 
30
[
28
31
.B \-m
29
32
]
30
33
[
31
34
.B \-n
32
 
<cnt>
 
35
<[first-]cnt>
 
36
]
 
37
[
 
38
.B \-Q
33
39
]
34
40
[
35
41
.B \-s
46
52
.B \-i
47
53
<additional index directory>
48
54
]
 
55
[
 
56
.B \-F
 
57
<space separated field name list>
 
58
]
49
59
<query string>
50
60
 
51
61
.B recollq \-P
54
64
The
55
65
.B recollq
56
66
command will execute the Recoll query specified on the command line and
57
 
print the results to the standard output.
 
67
print the results to the standard output. It is primarily designed for
 
68
diagnostics, or piping the data to some other program. The basic format and
 
69
its variations can be useful for command line querying. The -F option
 
70
should exclusively be used for using the output data in another program, as
 
71
it is the only one for which output is guaranteed to be fully parseable.
58
72
.PP
59
73
The 
60
74
.B \-c 
61
75
option specifies the configuration directory name, overriding the
62
76
default or $RECOLL_CONFDIR.
63
77
.PP
64
 
The query string will be interpreted by default as a query language string.
65
 
If
 
78
The query string is built by concatenating all arguments found at the end
 
79
of the command line (after the options). It will be interpreted by default
 
80
as a query language string. Quoting should be used as needed to escape
 
81
characters that might be interpreted by the shell (ie: wildcards).
66
82
.B \-a 
67
83
is specified, the query string will be interpreted as an
68
84
.I all words
100
116
.PP
101
117
.B \-n
102
118
<cnt>
103
 
can be used to set the maximum number of results that should be printed.
 
119
can be used to set the maximum number of results that should be
 
120
printed. The default is 2000. Use a value of 0 for no limit.
104
121
.PP
105
122
.B \-s
106
123
<language>
111
128
<extra dbdir>
112
129
adds the specified Xapian index to the set used for the query. Can be
113
130
specified multiple times.
 
131
.PP 
 
132
.B \-F
 
133
<space separated field list>
 
134
should be used for piping the data to another program. After 2 initial
 
135
lines showing the actual query and the estimated result counts, it will
 
136
print one line for each result document. Each line will have 
 
137
exactly the fields requested on the command line. Fields are encoded in
 
138
base64 and separated by one space character. Empty fields are indicated by
 
139
consecutive space characters. There is one additional space character at
 
140
the end of each line.
114
141
.PP
115
142
.B recollq \-P
116
143
(Period) will print the minimum and maximum modification years for