1ESTCALL(1)                      Hyper Estraier                      ESTCALL(1)
2
3
4

NAME

6       estcall - command line interface of the node API
7
8

SYNOPSIS

10       estcall  put  [-proxy  host  port]  [-tout  num] [-auth user pass] nurl
11       [file]
12
13       estcall out [-proxy host port] [-tout num] [-auth user pass] nurl expr
14
15       estcall edit [-proxy host port] [-tout num] [-auth user pass] nurl expr
16       name [value]
17
18       estcall  get [-proxy host port] [-tout num] [-auth user pass] nurl expr
19       [attr]
20
21       estcall etch [-proxy host port] [-tout num] [-auth user pass] nurl expr
22
23       estcall uriid [-proxy host port] [-tout num] [-auth user pass] nurl uri
24
25       estcall inform  [-proxy  host  port]  [-tout  num]  [-auth  user  pass]
26       [-ia|-iu|-il] nurl
27
28       estcall sync [-proxy host port] [-tout num] [-auth user pass] nurl
29
30       estcall optimize [-proxy host port] [-tout num] [-auth user pass] nurl
31
32       estcall  search  [-proxy host port] [-tout num] [-auth user pass] [-vx]
33       [-kw] [-ec] [-sf] [-attr expr] [-ord expr] [-max num] [-sk  num]  [-aux
34       num] [-dis name] [-dpt num] [-mask num] nurl [phrase]
35
36       estcall  setuser  [-proxy host port] [-tout num] [-auth user pass] nurl
37       name mode
38
39       estcall setlink [-proxy host port] [-tout num] [-auth user  pass]  nurl
40       url label credit
41
42       estcall raw [-proxy host port] [-tout num] [-auth user pass] [-np] [-eh
43       expr] url [file]
44
45

DESCRIPTION

47       estcall is an aggregation of sub commands.  The name of a  sub  command
48       is specified by the first argument.  Other arguments are parsed accord‐
49       ing to each sub command.  The argument nurl  specifies  the  URL  of  a
50       node.  The option -proxy specifies the host name and the port number of
51       a proxy server.  The option -tout specifies timeout  in  seconds.   The
52       option -auth specifies the user name and the password of authentication
53       information.
54
55       estcall put [-proxy host port]  [-tout  num]  [-auth  user  pass]  nurl
56       [file]
57              Register a document of document draft to a node.
58              file  specifies  a  target file.  If it is omitted, the standard
59              input is read.
60
61       estcall out [-proxy host port] [-tout num] [-auth user pass] nurl expr
62              Remove information of a document from a node.
63              expr specifies the ID number or the URI of a document.
64
65       estcall edit [-proxy host port] [-tout num] [-auth user pass] nurl expr
66       name [value]
67              Edit an attribute of a document in a node.
68              expr specifies the ID number or the URI of a document.
69              name specifies the name of an attribute.
70              value  specifies  the value of the attribute.  If it is omitted,
71              the attribute is removed.
72
73       estcall get [-proxy host port] [-tout num] [-auth user pass] nurl  expr
74       [attr]
75              Output document draft of a document in a node.
76              expr specifies the ID number or the URI of a document.
77              If attr is specified, only the value of the attribute is output.
78
79       estcall etch [-proxy host port] [-tout num] [-auth user pass] nurl expr
80              Output TSV of keywords and their scores of a document in a node.
81              expr specifies the ID number or the URI of a document.
82
83       estcall uriid [-proxy host port] [-tout num] [-auth user pass] nurl uri
84              Output the ID number of a document specified by URI.
85              uri specifies the URI of a document.
86
87       estcall  inform  [-proxy  host  port]  [-tout  num]  [-auth  user pass]
88       [-ia|-iu|-il] nurl
89              Output the name, the label, the number of documents, the  number
90              of unique words, and the cache usage of a node.
91              If -ia is specified, names of administrators are output.
92              If -iu is specified, names of users are output.
93              If -il is specified, expressions of links are output.
94
95       estcall sync [-proxy host port] [-tout num] [-auth user pass] nurl
96              Synchronize updating contents of the database of a node.
97
98       estcall optimize [-proxy host port] [-tout num] [-auth user pass] nurl
99              Optimize the database of a node.
100
101       estcall  search  [-proxy host port] [-tout num] [-auth user pass] [-vx]
102       [-kw] [-ec] [-sf] [-attr expr] [-ord expr] [-max num] [-sk  num]  [-aux
103       num] [-dis name] [-dpt num] [-mask num] nurl [phrase]
104              Search a node for documents.
105              phrase specifies the search phrase.
106              If  -vx  is  specified,  XML  including including attributes and
107              snippets is output.
108              If -kw is specified, keyword vectors are retrieved.
109              -ec specifies lower limit of similarity eclipse.
110              If -sf is specified, the phrase is treated as a simplified form.
111              -attr specifies an attribute search condition.  This option  can
112              be specified multiple times.
113              -ord specifies the order expression.  By default, it is descend‐
114              ing by score.
115              -max specifies the maximum number of show  documents.   Negative
116              means unlimited.  By default, it is 10.
117              -sk  specifies  the  number  of  documents  to  be  skipped.  By
118              default, it is 0.
119              -aux specifies permission  to  adopt  result  of  the  auxiliary
120              index.   If  it  is  not more than 0, the auxiliary index is not
121              used.  By default, it is 32.
122              -dis specifies the name of the distinct attribute.
123              -dpt specifies the depth of meta search.  by default it is 0.
124              -mask specifies the mask of meta search.  by default it is 0.
125
126       estcall setuser [-proxy host port] [-tout num] [-auth user  pass]  nurl
127       name mode
128              Set permission of a user.
129              name specifies the name of a user.
130              mode  specifies  operation  mode.  1 means to set the user as an
131              administrator, 2 means to set the user as a guest, and  0  means
132              to revoke the user account.
133
134       estcall  setlink  [-proxy host port] [-tout num] [-auth user pass] nurl
135       url label credit
136              Set a link to another node.
137              url specifies the URL of a destination node.
138              label specifies the label of the link.
139              credit specifies the credit of the link.  If the value is  nega‐
140              tive, the link is removed.
141
142       estcall raw [-proxy host port] [-tout num] [-auth user pass] [-np] [-eh
143       expr] url [file]
144              Output response of an HTTP request.
145              url specifies the URL of a target.
146              If file is specified, the content is sent by  POST  method.   If
147              not,  GET  method  is  used.   If "-" is specified, the standard
148              input is read.
149              If -np is specified, output response headers also.
150              -eh specifies an additional HTTP header.   By  default,  "Host",
151              "Connection", "User-Agent", and "Content-Length" is added.
152
153       All sub commands return 0 if the operation is success, else return 1.
154
155

SEE ALSO

157       estconfig(1),  estcmd(1), estmaster(1), estwaver(1), estraier(3), estn‐
158       ode(3)
159
160       Please  see   http://hyperestraier.sourceforge.net/nguide-en.html   for
161       detail.
162
163
164
165Man Page                          2007-03-06                        ESTCALL(1)
Impressum