git.maemo.org Git - xmlrpc-c/blob - tools/xml-rpc-api2cpp/xml-rpc-api2cpp.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-API2CPP 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-api2cpp \- Make a C++ wrapper class for an XML-RPC API
  20 .SH SYNOPSIS
  21 .B xml-rpc-api2cpp
  22 \fIserver-url\fR \fIremote-method-prefix\fR \fIc++-class-name\fR
  23 .SH DESCRIPTION
  24 xml-rpc-api2cpp queries an XML-RPC server using the XML-RPC
  25 Instrospection API designed by Edd Dumbill.  It then prints a C++
  26 wrapper class to standard output.  This class can be used with
  27 xmlrpc-c's C++ API.
  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 .TP
  37 .I remote-method-prefix
  38 The prefix of the methods to wrap.  For example, to wrap all the
  39 system.* calls, you could specify "system".
  40 .TP
  41 .I c++-class-name
  42 The name of the C++ class to generate.  Try "SystemProxy".
  43 .SH BUGS
  44 xml-rpc-api2cpp can't talk to certain PHP servers based on Edd
  45 Dumbill's PHP library, because the trailing bytes of the XML-RPC
  46 message get truncated in HTTP pipelining mode.  It's not clear whether
  47 this is a PHP, Apache or w3c-libwww bug.
  48 .PP
  49 xml-rpc-api2cpp assumes that method descriptions are ASCII text, not
  50 HTML as specified in the standard.  (In practice, both conventions are
  51 often seen.)  It may also get unhappy if method descriptions contain
  52 "*/".
  53 .PP
  54 In general, error messages and diagnostics are still fairly poor.
  55 .SH SEE ALSO
  56 .BR xmlrpc-c (7),
  57 .BR xml-rpc-api2txt (1).
  58 .PP
  59 This program is part of xmlrpc-c.
  60 .SH AUTHOR
  61 This manual page was written by Eric Kidd <eric.kidd@pobox.com>.
  62 It may be distributed under the same terms as the rest of xmlrpc-c.