1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
2 <title>Xmlrpc User Manual</title>
5 <p><b>xmlrpc</b> makes an XML-RPC remote procedure call (RPC) and displays
6 the response. <b>xmlrpc</b> runs an XML-RPC client.
8 <p>This program is mainly useful for debugging and learning about
9 XML-RPC servers. XML-RPC is such that the RPCs normally need to be made
10 by a program rather than a person to be of use.
12 <p>A similar tool done as a web form is at <a
13 href="http://gggeek.damacom.it/debugger/">
14 http://gggeek.damacom.it/debugger/</a>
20 $ xmlrpc http://localhost:8080/RPC2 sample.add i/3 i/5
28 $ xmlrpc localhost:8080 sample.add i/3 i/5
37 $ xmlrpc http://xmlrpc.server.net/~bryanh echostring \
38 "s/This is a string"
40 String: This is a string
47 $ xmlrpc http://xmlrpc.server.net/~bryanh echostring \
48 "This is a string in shortcut syntax"
50 String: This is a string in shortcut syntax
56 $ xmlrpc http://xmlrpc.server.net sample.add i/3 i/5 \
57 transport=curl -curlinterface=eth1 -username=bryanh -password=passw0rd
70 [<b>-transport=</b><i>transportname</i>]
71 [<b>-username=</b><i>username</i> <b>-password=</b><i>password</i>]
72 [<b>-curlinterface</b>={<i>interface</i>|<i>host</i>}]
73 [<b>-curlnoverifypeer</b>]
74 [<b>-curlnoverifyhost</b>]
79 <b>i/</b><i>integer</i> |
80 <b>s/</b><i>string</i> |
81 <b>b/</b>{<b>true</b>|<b>false</b>|<b>t</b>|<b>f</b>} |
82 <b>d/</b><i>realnum</i> |
87 <P>Minimum unique abbreviation of option is acceptable. You may use double
88 hyphens instead of single hyphen to denote options. You may use white
89 space in place of the equals sign to separate an option name from its value.
97 <dd>This is the URL of the XML-RPC server. As XML-RPC uses HTTP, this
98 must be an HTTP url. However, if you don't specify a type ("http:")
99 in the URL, <b>xmlrpc</b> assumes an "http://" prefix and a
100 "/RPC2" suffix. <b>RPC2</b> is the conventional file name for
101 an XML-RPC responder.
103 <dt><i>methodName</i>
105 <dd>The name of the XML-RPC method you want to invoke.
107 <dt><i>parameter</i> ...
109 <dd>The list of parameters for the RPC. <b>xmlrpc</b> turns each of these
110 arguments into an XML-RPC parameter, in the order given. You may specify
111 no parameters if you like.
113 <p>You specify the data type of the parameter with a prefix ending in
114 a slash. Example: <b>i/5</b>. Here, the "i" signifies an
115 integer data type. "5" is the value.
117 <p><b>xmlrpc</b> is capable of only a subset of the
118 possible XML-RPC types, as follows by prefix:
122 <dd>integer (<int4>)
125 <dd>string (<string>)
128 <dd>boolean (<boolean>)
131 <dd>double (<double>) (i.e. real number)
134 <dd>nil (<nil>)
138 <p>As a shortcut, if you don't specify a prefix (i.e. your argument does
139 not contain a slash), <b>xmlrpc</b> assumes string data type.
147 <dt><b>-transport=</b><i>transportname</i>
149 <dd>This selects the XML transport facility (e.g. libwww) that
150 <b>xmlrpc</b> uses to perform the RPC.
152 <p>The name <i>transportname</i> is one that the Xmlrpc-c programming
153 library recognizes. This is typically <b>libwww</b>, <b>curl</b>, and
156 <p>By default, <b>xmlrpc</b> lets the Xmlrpc-c library choose.
158 <dt><b>-username=</b><i>username</i>
159 <dt><b>-password=</b><i>password</i>
161 <dd>These options, which must be used together, cause the client to
162 authenticate itself to the server, if the server requires it, using
163 HTTP Basic Authentication and the specified username and password.
165 <dt><b>-curlinterface</b>={<i>interface</i>|<i>host</i>}
168 This option gives the "interface" option for a Curl XML transport.
170 <p>The exact meaning of this option is up to the Curl library, and the
171 best documentation for it is the manual for the 'curl' program that comes
172 with the Curl library.
174 <p>But essentially, it chooses the local network interface through which
175 to send the RPC. It causes the Curl library to perform a
176 "bind" operation on the socket it uses for the
177 communication. It can be the name of a network interface (e.g. on
178 Linux, "eth1") or an IP address of the interface or a host
179 name that resolves to the IP address of the interface. Unfortunately,
180 you can't explicitly state which form you're specifying, so there's
194 -interface=64.171.19.66
199 -interface=giraffe.giraffe-data.com
204 <p>This option causes <b>xmlrpc</b> to default to using the Curl
205 XML transport. You may not specify any other transport.
207 <dt><b>-curlnoverifypeer</b>
210 This option gives the "no_ssl_verifypeer" option for the Curl
211 XML transport, which is essentially the CURLOPT_SSL_VERIFYPEER option
214 <p>See the <b>curl_easy_setopt()</b> man page for details on this, but
215 essentially it means that the client does not authenticate the server's
216 certificate of identity -- it just believes whatever the server says.
218 <p>You may want to use <b>-curlnoverifyhost</b> as well. Since you're
219 not authenticating the server's identity, there's not much sense in
222 <p>This option causes <b>xmlrpc</b> to default to using the Curl
223 XML transport. You may not specify any other transport.
226 <dt><b>-curlnoverifyhost</b>
229 This option gives the "no_ssl_verifyhost" option for the Curl
230 XML transport, which is essentially the CURLOPT_SSL_VERIFYHOST option
233 <p>See the <b>curl_easy_setopt()</b> man page for details on this, but
234 essentially it means that the client does not verify the server's
235 identity. It just assumes that if the server answers the IP address
236 of the server as indicated by the URL (probably via host name), then
237 it's the intended server.
239 <p>You may want to use <b>-curlnoverifypeer</b> as well. As long as
240 you don't care who the server says it is, there's no point in
241 authenticating its identity.
243 <p>This option causes <b>xmlrpc</b> to default to using the Curl
244 XML transport. You may not specify any other transport.