~ubuntu-branches/ubuntu/trusty/hyperestraier/trusty

« back to all changes in this revision

Viewing changes to man/estcall.1

  • Committer: Bazaar Package Importer
  • Author(s): Steve Langasek
  • Date: 2006-11-14 05:28:32 UTC
  • mfrom: (2.1.4 feisty)
  • Revision ID: james.westby@ubuntu.com-20061114052832-0lzqzcefn8mt4yqe
Tags: 1.4.9-1.1
* Non-maintainer upload.
* High-urgency upload for RC bugfix.
* Set HOME=$(CURDIR)/junkhome when building, otherwise the package build
  will incorrectly look for headers there -- and fail when the directory
  exists and is unreadable, as happens sometimes on sudo-using
  autobuilders!

Show diffs side-by-side

added added

removed removed

Lines of Context:
6
6
.SH SYNOPSIS
7
7
.PP
8
8
.B estcall put [\-proxy host port] [\-tout num] [\-auth user pass] nurl [file]
9
 
.br
 
9
.PP
10
10
.B estcall out [\-proxy host port] [\-tout num] [\-auth user pass] nurl expr
11
 
.br
 
11
.PP
12
12
.B estcall edit [\-proxy host port] [\-tout num] [\-auth user pass] nurl expr name [value]
13
 
.br
 
13
.PP
14
14
.B estcall get [\-proxy host port] [\-tout num] [\-auth user pass] nurl expr [attr]
15
 
.br
 
15
.PP
16
16
.B estcall etch [\-proxy host port] [\-tout num] [\-auth user pass] nurl expr
17
 
.br
 
17
.PP
18
18
.B estcall uriid [\-proxy host port] [\-tout num] [\-auth user pass] nurl uri
19
 
.br
20
 
.B estcall inform [\-proxy host port] [\-tout num] [\-auth user pass] nurl
21
 
.br
22
 
.B estcall search [\-proxy host port] [\-tout num] [\-auth user pass] [\-vx] [\-kw] [\-ec] [\-sf] [\-attr expr] [\-ord expr] [\-max num] [\-dpt num] nurl [phrase]
23
 
.br
 
19
.PP
 
20
.B estcall inform [\-proxy host port] [\-tout num] [\-auth user pass] [\-ia|\-iu|\-il] nurl
 
21
.PP
 
22
.B estcall sync [\-proxy host port] [\-tout num] [\-auth user pass] nurl
 
23
.PP
 
24
.B estcall optimize [\-proxy host port] [\-tout num] [\-auth user pass] nurl
 
25
.PP
 
26
.B estcall search [\-proxy host port] [\-tout num] [\-auth user pass] [\-vx] [\-kw] [\-ec] [\-sf] [\-attr expr] [\-ord expr] [\-max num] [\-sk num] [\-aux num] [\-dis name] [\-dpt num] [\-mask num] nurl [phrase]
 
27
.PP
24
28
.B estcall setuser [\-proxy host port] [\-tout num] [\-auth user pass] nurl name mode
25
 
.br
 
29
.PP
26
30
.B estcall setlink [\-proxy host port] [\-tout num] [\-auth user pass] nurl url label credit
27
 
.br
 
31
.PP
28
32
.B estcall raw [\-proxy host port] [\-tout num] [\-auth user pass] [\-np] [\-eh expr] url [file]
29
33
 
30
34
.SH DESCRIPTION
31
35
.PP
32
 
estcall is an aggregation of sub commands.  The name of a sub command is specified by the first argument.  Other arguments are parsed according to each sub command.  The argument
 
36
.B estcall
 
37
is an aggregation of sub commands.  The name of a sub command is specified by the first argument.  Other arguments are parsed according to each sub command.  The argument
33
38
.I nurl
34
39
specifies the URL of a node.  The option
35
40
.B \-proxy
41
46
.TP
42
47
.B estcall put [\-proxy host port] [\-tout num] [\-auth user pass] nurl [file]
43
48
Register a document of document draft to a node.
 
49
.br
44
50
.I file
45
51
specifies a target file.  If it is omitted, the standard input is read.
46
52
.TP
47
53
.B estcall out [\-proxy host port] [\-tout num] [\-auth user pass] nurl expr
48
54
Remove information of a document from a node.
 
55
.br
49
56
.I expr
50
57
specifies the ID number or the URI of a document.
51
58
.TP
52
59
.B estcall edit [\-proxy host port] [\-tout num] [\-auth user pass] nurl expr name [value]
53
60
Edit an attribute of a document in a node.
 
61
.br
54
62
.I expr
55
63
specifies the ID number or the URI of a document.
 
64
.br
56
65
.I name
57
66
specifies the name of an attribute.
 
67
.br
58
68
.I value
59
69
specifies the value of the attribute.  If it is omitted, the attribute is removed.
60
70
.TP
61
71
.B estcall get [\-proxy host port] [\-tout num] [\-auth user pass] nurl expr [attr]
62
72
Output document draft of a document in a node.
 
73
.br
63
74
.I expr
64
75
specifies the ID number or the URI of a document.
 
76
.br
65
77
If
66
78
.I attr
67
79
is specified, only the value of the attribute is output.
68
80
.TP
69
81
.B estcall etch [\-proxy host port] [\-tout num] [\-auth user pass] nurl expr
70
82
Output TSV of keywords and their scores of a document in a node.
 
83
.br
71
84
.I expr
72
85
specifies the ID number or the URI of a document.
73
86
.TP
74
87
.B estcall uriid [\-proxy host port] [\-tout num] [\-auth user pass] nurl uri
75
88
Output the ID number of a document specified by URI.
 
89
.br
76
90
.I uri
77
91
specifies the URI of a document.
78
92
.TP
79
 
.B estcall inform [\-proxy host port] [\-tout num] [\-auth user pass] nurl
80
 
Output the name, the label, the number of documents, and the number of unique words of a node.
81
 
.TP
82
 
.B estcall search [\-proxy host port] [\-tout num] [\-auth user pass] [\-vx] [\-kw] [\-ec] [\-sf] [\-attr expr] [\-ord expr] [\-max num] [\-dpt num] nurl [phrase]
 
93
.B estcall inform [\-proxy host port] [\-tout num] [\-auth user pass] [\-ia|\-iu|\-il] nurl
 
94
Output the name, the label, the number of documents, the number of unique words, and the cache usage of a node.
 
95
.br
 
96
If
 
97
.B \-ia
 
98
is specified, names of administrators are output.
 
99
.br
 
100
If
 
101
.B \-iu
 
102
is specified, names of users are output.
 
103
.br
 
104
If
 
105
.B \-il
 
106
is specified, expressions of links are output.
 
107
.TP
 
108
.B estcall sync [\-proxy host port] [\-tout num] [\-auth user pass] nurl
 
109
Synchronize updating contents of the database of a node.
 
110
.TP
 
111
.B estcall optimize [\-proxy host port] [\-tout num] [\-auth user pass] nurl
 
112
Optimize the database of a node.
 
113
.TP
 
114
.B estcall search [\-proxy host port] [\-tout num] [\-auth user pass] [\-vx] [\-kw] [\-ec] [\-sf] [\-attr expr] [\-ord expr] [\-max num] [\-sk num] [\-aux num] [\-dis name] [\-dpt num] [\-mask num] nurl [phrase]
83
115
Search a node for documents.
 
116
.br
84
117
.I phrase
85
118
specifies the search phrase.
 
119
.br
86
120
If
87
121
.B \-vx
88
122
is specified, XML including including attributes and snippets is output.
 
123
.br
89
124
If
90
125
.B \-kw
91
126
is specified, keyword vectors are retrieved.
 
127
.br
92
128
.B \-ec
93
129
specifies lower limit of similarity eclipse.
 
130
.br
94
131
If
95
132
.B \-sf
96
133
is specified, the phrase is treated as a simplified form.
 
134
.br
97
135
.B \-attr
98
136
specifies an attribute search condition.  This option can be specified multiple times.
 
137
.br
99
138
.B \-ord
100
139
specifies the order expression.  By default, it is descending by score.
 
140
.br
101
141
.B \-max
102
142
specifies the maximum number of show documents.  Negative means unlimited.  By default, it is 10.
 
143
.br
 
144
.B \-sk
 
145
specifies the number of documents to be skipped.  By default, it is 0.
 
146
.br
 
147
.B \-aux
 
148
specifies permission to adopt result of the auxiliary index.  If it is not more than 0, the auxiliary index is not used.  By default, it is 32.
 
149
.br
 
150
.B -dis
 
151
specifies the name of the distinct attribute.
 
152
.br
103
153
.B \-dpt
104
 
specifies depth of meta search.  by default it is 0.
 
154
specifies the depth of meta search.  by default it is 0.
 
155
.br
 
156
.B \-mask
 
157
specifies the mask of meta search.  by default it is 0.
105
158
.TP
106
159
.B estcall setuser [\-proxy host port] [\-tout num] [\-auth user pass] nurl name mode
107
160
Set permission of a user.
 
161
.br
108
162
.I name
109
163
specifies the name of a user.
 
164
.br
110
165
.I mode
111
166
specifies operation mode.  1 means to set the user as an administrator, 2 means to set the user as a guest, and 0 means to revoke the user account.
112
167
.TP
113
168
.B estcall setlink [\-proxy host port] [\-tout num] [\-auth user pass] nurl url label credit
114
169
Set a link to another node.
 
170
.br
115
171
.I url
116
172
specifies the URL of a destination node.
 
173
.br
117
174
.I label
118
175
specifies the label of the link.
 
176
.br
119
177
.I credit
120
178
specifies the credit of the link.  If the value is negative, the link is removed.
121
179
.TP
122
180
.B estcall raw [\-proxy host port] [\-tout num] [\-auth user pass] [\-np] [\-eh expr] url [file]
123
181
Output response of an HTTP request.
 
182
.br
124
183
.I url
125
184
specifies the URL of a target.
 
185
.br
126
186
If
127
187
.I file
128
188
is specified, the content is sent by POST method.  If not, GET method is used.  If "\-" is specified, the standard input is read.
 
189
.br
129
190
If
130
191
.B \-np
131
192
is specified, output response headers also.
 
193
.br
132
194
.B \-eh
133
195
specifies an additional HTTP header.  By default, "Host", "Connection", "User\-Agent", and "Content\-Length" is added.
134
196
.PP
139
201
.BR estconfig (1),
140
202
.BR estcmd (1),
141
203
.BR estmaster (1),
142
 
.BR estraier (3)
 
204
.BR estwaver (1),
 
205
.BR estraier (3),
 
206
.BR estnode (3)
143
207
.PP
144
208
Please see
145
209
.B http://hyperestraier.sourceforge.net/nguide-en.html