1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
.\" Text automatically generated by txt2man
.TH xmlrpc 1 "19 Jun 2020" "xmlrpc-1.33.14" "xmlrpc Manual"
.SH NAME
\fBxmlrpc \fP- makes an XML-RPC remote procedure call and displays the response
\fB
.SH SYNOPSIS
.nf
.fam C
\fBxmlrpc\fP \fIurl\fP \fImethod\fP \fIparameters\fP [\fB-transport\fP=transportname]
[\fB-username\fP=username \fB-password\fP=passwd]
[\fB-curlinterface\fP={interface|host}]
[\fB-curlnoverifypeer\fP]
[\fB-curlnoverifyhost\fP]
.fam T
.fi
.fam T
.fi
.SH DESCRIPTION
This program is used to execute Remote Procedure Calls (RPC) using a XML-RPC
client. Its main purpose is debugging and learning since RPC are usually
embedded in source code of other programs.
.SH ARGUMENTS
.TP
.B
\fIurl\fP
This is the URL of the XML-RPC server. As XML-RPC uses HTTP, this must
be an HTTP \fIurl\fP. However, if you don't specify a type ("http:") in the
URL, \fBxmlrpc\fP assumes an "http://" prefix and a "/RPC2" suffix. RPC2 is
the conventional file name for an XML-RPC responder.
.TP
.B
\fImethod\fP
The name of the XML-RPC \fImethod\fP you want to invoke.
.TP
.B
\fIparameters\fP
List of \fIparameters\fP for the RPC. \fBxmlrpc\fP turns each of these arguments
into an XML-RPC parameter, in the order given. You may specify no
\fIparameters\fP if you like.
.RS
.PP
You specify the data type of the parameter with a prefix ending in a
slash. Example: i/5. Here, the "i" signifies an integer data type. "5"
is the value.
.PP
\fBxmlrpc\fP is capable of only a subset of the possible XML-RPC types, as
follows by prefix:
.PP
i/ integer (<i4>) (32 bit).
.PP
s/ string (<string>).
.PP
h/ byte string (<base64>). Specify the value in hexadecimal.
.PP
b/ boolean (<boolean>). Specify the value as "true" or "t" for
true; "false" or "f" for false.
.PP
d/ double (<double>) - i.e. real number.
.PP
n/ nil (<nil>).
.PP
I/ 64 bit integer (<i8>).
.SH OPTIONS
.TP
.B
\fB-transport\fP=transportname
This selects the XML transport facility (e.g. libwww)
that \fBxmlrpc\fP uses to perform the RPC. The name transportname is one that the
Xmlrpc-c programming library recognizes. This is typically libwww, curl, and
wininet. By default, \fBxmlrpc\fP lets the Xmlrpc-c library choose.
.PP
\fB-username\fP=username
.TP
.B
\fB-password\fP=passwd
These two options, which must be used together, cause
the client to authenticate itself to the server, if the server requires it,
using HTTP Basic Authentication and the specified username and password.
.TP
.B
\fB-curlinterface\fP={interface|host}
This option gives the "interface" option
for a Curl XML transport. The exact meaning of this option is up to the
Curl library, and the best documentation for it is the manual for the 'curl'
program that comes with the Curl library. But essentially, it chooses the
local network interface through which to send the RPC. It causes the Curl
library to perform a "bind" operation on the socket it uses for the
communication. It can be the name of a network interface (e.g. on
Linux, "eth1") or an IP address of the interface or a host name that
resolves to the IP address of the interface. Unfortunately, you can't
explicitly state which form you're specifying, so there's some ambiguity.
Examples:
\fB-interface\fP=eth1
\fB-interface\fP=64.171.19.66
\fB-interface\fP=giraffe.giraffe-data.com
This option causes \fBxmlrpc\fP to default to using the Curl XML transport. You
may not specify any other transport.
.TP
.B
\fB-curlnoverifypeer\fP
This option gives the "no_ssl_verifypeer" option for the
Curl XML transport, which is essentially the CURLOPT_SSL_VERIFYPEER option
of the Curl library. See the \fBcurl_easy_setopt\fP() man page for details on
this, but essentially it means that the client does not authenticate the
server's certificate of identity -- it just believes whatever the server
says. You may want to use \fB-curlnoverifyhost\fP as well. Since you're not
authenticating the server's identity, there's not much sense in checking
it. This option causes \fBxmlrpc\fP to default to using the Curl XML transport.
You may not specify any other transport.
.TP
.B
\fB-curlnoverifyhost\fP
This option gives the "no_ssl_verifyhost" option for
the Curl XML transport, which is essentially the CURLOPT_SSL_VERIFYHOST
option of the Curl library. See the \fBcurl_easy_setopt\fP() man page for
details on this, but essentially it means that the client does not
verify the server's identity. It just assumes that if the server answers
the IP address of the server as indicated by the URL (probably via host
name), then it's the intended server. You may want to use \fB-curlnoverifypeer\fP
as well. As long as you don't care who the server says it is, there's no
point in authenticating its identity. This option causes \fBxmlrpc\fP to default
to using the Curl XML transport. You may not specify any other transport.
.SH EXAMPLES
$ \fBxmlrpc\fP http://localhost:8080/RPC2 sample.add i/3 i/5
.PP
Result:
Integer: 8
.PP
$ \fBxmlrpc\fP localhost:8080 sample.add i/3 i/5
.PP
Result:
Integer: 8
.PP
$ \fBxmlrpc\fP http://xmlrpc.example.com/~bryanh \
echostring "s/This is a string"
.PP
Result:
String: This is a string
.PP
$ \fBxmlrpc\fP http://xmlrpc.example.com/~bryanh \
echostring "This is a string in shortcut syntax"
.PP
Result:
String: This is a string in shortcut syntax
.PP
$ \fBxmlrpc\fP http://xmlrpc.example.com sample.add i/3 i/5 \
\fB-transport\fP=curl \fB-curlinterface\fP=eth1 \fB-username\fP=bryanh \fB-password\fP=passw0rd
.PP
Result:
Integer: 8
.SH LIMITATIONS
If you run \fBxmlrpc\fP in an environment in which programs get their arguments
encoded some way other than UTF-8, \fBxmlrpc\fP will generate garbage for the
XML-RPC call and display garbage for the XML-RPC response. Typically, you
control this aspect of the environment with a LANG environment variable.
One safe value for LANG is "C".
.SH SEE ALSO
\fBcurl\fP(1), http://\fBxmlrpc\fP-c.sourceforge.net/doc, http://xmlrpc.com
.SH AUTHOR
\fBxmlrpc\fP was written by Eric Kidd.
.PP
This manual page was written by Bryan Henderson and adapted for Debian by
Carlos Henrique Lima Melara.
|
