initial load of upstream version 1.06.32
[xmlrpc-c] / tools / xml-rpc-api2txt.1
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH XML-RPC-API2TXT 1 "June 27, 2001"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 xml-rpc-api2txt \- Print out a description of an XML-RPC API as text
20 .SH SYNOPSIS
21 .B xml-rpc-api2txt
22 \fIserver-url\fR
23 .SH DESCRIPTION
24 xml-rpc-api2txt queries an XML-RPC server using the XML-RPC
25 Instrospection API designed by Edd Dumbill.  It then prints the
26 results to standard output in a nicely formatted form, suitable for
27 sending via e-mail.
28 .PP
29 You can find a list of supported XML-RPC server libraries (and patches
30 for many others) at \fBhttp://xmlrpc-c.sourceforge.net/hacks.php\fR.
31 .SH OPTIONS
32 .TP
33 .I server-url
34 The name of the server to query.  Try
35 \fBhttp://xmlrpc-c.sourceforge.net/cgi-bin/interop.cgi\fR.
36 .SH BUGS
37 xml-rpc-api2txt assumes that method descriptions are ASCII text, not
38 HTML as specified in the standard.  (In practice, both conventions are
39 often seen.)
40 .SH SEE ALSO
41 .BR xmlrpc-c (7),
42 .BR xml-rpc-api2cpp (1).
43 .PP
44 This program is part of xmlrpc-c.
45 .SH AUTHOR
46 This manual page was written by Eric Kidd <eric.kidd@pobox.com>.
47 It may be distributed under the same terms as the rest of xmlrpc-c.