diff options
author | Lluis Sanchez <lluis@novell.com> | 2003-12-05 13:48:04 +0300 |
---|---|---|
committer | Lluis Sanchez <lluis@novell.com> | 2003-12-05 13:48:04 +0300 |
commit | e5d2ec807d5754f77590835a49b7cf49ba56b133 (patch) | |
tree | 570937bf25d9a8629a63ca8be8c631c32bdc76c6 /man | |
parent | d76a4b7b458be008ef660f1c78b928217fbc2e4d (diff) |
Added man pages for disco, wsdl and soapsuds tools
svn path=/trunk/mono/; revision=20801
Diffstat (limited to 'man')
-rw-r--r-- | man/Makefile.am | 2 | ||||
-rw-r--r-- | man/disco.1 | 68 | ||||
-rw-r--r-- | man/man.xml | 3 | ||||
-rw-r--r-- | man/soapsuds.1 | 126 | ||||
-rw-r--r-- | man/wsdl.1 | 71 |
5 files changed, 269 insertions, 1 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index 9b53cc492eb..2322bcb1114 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1,4 +1,4 @@ man_MANS = mcs.1 mono.1 monostyle.1 mono-config.5 sqlsharp.1 oldmono.1 ilasm.1 \ - cert2spc.1 cilc.1 genxs.1 + cert2spc.1 cilc.1 genxs.1 wsdl.1 disco.1 soapsuds.1 EXTRA_DIST = $(man_MANS) diff --git a/man/disco.1 b/man/disco.1 new file mode 100644 index 00000000000..e8e319ccc65 --- /dev/null +++ b/man/disco.1 @@ -0,0 +1,68 @@ +.\" +.\" disco manual page. +.\" (C) 2003 Novell, Inc. +.\" Author: +.\" Lluis Sanchez Gual (lluis@ximian.com) +.\" +.TH disco 1 +.SH NAME +disco \- Mono's Web Service Discovery Tool +.SH SYNOPSIS +.PP +.B disco +[options] url +.SH DESCRIPTION +.I disco +is a tool for discovering web services and for retireving the documents that +describe those services. +.PP +.I url +is the location of a DISCO document, which includes a list of WSDL documents, +XML schemas and references to other DISCO documents. +.PP +.I disco +downloads the DISCO document and all referenced documents (unless +the +.I "-nosave" +option is specified), and saves them to disk. +.SH OPTIONS +The following options are available: +.TP +.I "-nologo" +Supress the startup logo. +.TP +.I "-nosave" +Do not save the discovered documents to disk. The default is to save the documents. +.TP +.I "-o:directory", "-out:directory" +The directory where to save the discovered documents. +By default, documents are saved in the current directory. +.TP +.I "-u:username", "-user:username" +The user name to use when connecting to the server. +.TP +.I "-p:password", "-password:password" +The password to use when connecting to the server. +.TP +.I "-d:domain", "-domain:domain" +The domain to use when connecting to the server. +.TP +.I "-proxy:url" +The url of the proxy server to use for http requests. +.TP +.I "-proxyusername:username" +The user name to use when connecting to the proxy. +.TP +.I "-proxypassword:password" +The password to use when connecting to the proxy. +.TP +.I "-proxydomain:domain" +The domain to use when connecting to the proxy. +.SH AUTHORS +Lluis Sanchez Gual (lluis@ximian.com) +.PP +.SH LICENSE +disco is released under the terms of the GNU GPL. +.PP +.SH SEE ALSO +wsdl(1), soapsuds(1), mono(1), mcs(1) diff --git a/man/man.xml b/man/man.xml index b9116aef1af..8424f3ff959 100644 --- a/man/man.xml +++ b/man/man.xml @@ -15,4 +15,7 @@ <manpage name="chktrust" page="chktrust.1" /> <manpage name="signcode" page="signcode.1" /> <manpage name="sn" page="sn.1" /> +<manpage name="wsdl" page="wsdl.1" /> +<manpage name="disco" page="disco.1" /> +<manpage name="soapsuds" page="soapsuds.1" /> </manpages> diff --git a/man/soapsuds.1 b/man/soapsuds.1 new file mode 100644 index 00000000000..3159cd2256c --- /dev/null +++ b/man/soapsuds.1 @@ -0,0 +1,126 @@ +.\" +.\" soapsuds manual page. +.\" (C) 2003 Novell, Inc. +.\" Author: +.\" Lluis Sanchez Gual (lluis@ximian.com) +.\" +.TH soapsuds 1 +.SH NAME +soapsuds \- Mono's Remoting Proxy Generator +.SH SYNOPSIS +.PP +.B soapsuds +[options] [inputs] [outputs] +.SH DESCRIPTION +.I soapsuds +is a tool for generating WSDL documents and client proxies for remoting services. +A WSDL document describes the methods that a service provides together with XML schemas +of all referenced data structures. A client proxy is a class which offers the same methods +as the service it represents, but provides no implementation, it just forwards calls to the +remote service. +.PP +Generated client proxies are not strictly necessary, since the runtime can +automatically generate proxies from the original service types. However, it implies the need +of distributing the service class to all clients. In some scenarios a better approach is +to use soapsuds to generate a proxy class which has the same interface as the service, +but without any implementation. +.PP +.I soapsuds +can generate a WSDL document from a set of types specified with the option +.I -types +or can extract the types from an assembly specified with +.I -inputassemblyfile. +In this last case, soapsuds will include schemas for all serializable classes in +the WSDL document. +.PP +Taking as input a WSDL document (or anything from which such document can be generated) +the tool can generate source code for the client proxy (using the +.I -gc +option) or it can directly generate an assembly that implements the proxy (with the +.I -outputassemblyfile +option). soapsuds will also generate fake serializable classes for all types defined +in the schema. However, beware that those classes will lack the semantics of the +original classes, since only data structure is generated. +.PP +.SH INPUT SOURCES +The following sources are available (only one can be specified): +.TP +.I "-urltoschema:url" "-url:url" +Url from which to retrieve the WSDL document. +.TP +.I "-types:type1,assembly[,serviceEndPoint][;type2,assembly[,serviceEndPoint]]..." +Specifies types for which to generate a schema or proxy. If no service endpoint is +provided, the one provided with the +.I -serviceendpoint +option is used. +.TP +.I "-inputassemblyfile:file", "-ia:file" +Assembly that contains the types to export. +.TP +.I "-inputschemafile:schena", "-is:schema" +Schema from which to generate proxy classes. +.SH INPUT OPTIONS +The following options are available: +.TP +.I "-inputdirectory:directory", "-id:directory" +Directory where DLLs are located. +.TP +.I "-serviceendpoint:url", "-se:url" +Url of the service to be placed in the WSDL document. +.SH OUTPUTS +The following output options are available (more than one can be specified): +.TP +.I "-outputassemblyfile:file", "-oa:file" +Generates the proxy code and compiles it into an assembly with the provided name. +.TP +.I "-outputschemafile:file", "-os:file" +Generates a WSDL document that represents the provided types. +.TP +.I "-generatecode", "-gc" +Generates proxy source code for the provided WSDL document or types. +.SH OUTPUT OPTIONS +The following options are available: +.TP +.I "-outputdirectory:directory", "-od:directory" +Directory where generated files will be placed. +.TP +.I "-proxynamespace:namespace", "-pn:namespace" +Namespace of the generated proxy. +.TP +.I "-nowrappedproxy", "-nowp" +Do not generate a wrapped proxy. +.TP +.I "-wrappedproxy", "-wp" +Generate a wrapped proxy. +.TP +.I "-strongnamefile:file", "-sn:file" +Strong name file. +.SH GENERAL OPTIONS +The following options are available: +.TP +.I "-nologo" +Supress the startup logo. +.TP +.I "-u:username", "-user:username" +The user name to use when connecting to the server. +.TP +.I "-p:password", "-password:password" +The password to use when connecting to the server. +.TP +.I "-d:domain", "-domain:domain" +The domain to use when connecting to the server. +.TP +.I "-httpproxyname:name", "-hpn:name" +Name of the http proxy. +.TP +.I "-httpproxyport:port", "-hpp:port" +Port of the http proxy. +.PP +.SH AUTHORS +Lluis Sanchez Gual (lluis@ximian.com) +.PP +.SH LICENSE +wsdl is released under the terms of the GNU GPL. +.PP +.SH SEE ALSO +wsdl(1), disco(1), mono(1), mcs(1) diff --git a/man/wsdl.1 b/man/wsdl.1 new file mode 100644 index 00000000000..89db62003ae --- /dev/null +++ b/man/wsdl.1 @@ -0,0 +1,71 @@ +.\" +.\" wsdl manual page. +.\" (C) 2003 Novell, Inc. +.\" Author: +.\" Lluis Sanchez Gual (lluis@ximian.com) +.\" +.TH wsdl 1 +.SH NAME +wsdl \- Mono's Web Service Proxy Generator +.SH SYNOPSIS +.PP +.B wsdl +[options] [path | url] +.SH DESCRIPTION +.I wsdl +is a tool for generating proxy classes that can be used to access to web services. +The tool reads a WSDL document from the provided path or url, and downloads +referenced schemas or other WSDL documents if needed. +.PP +.SH OPTIONS +The following options are available: +.TP +.I "-appsettingurlkey:key" "-urlkey:key" +Specifies that the url for the services should be read from the <appsettings> section +of the configuration file, using the provided key. +.TP +.I "-appsettingbaseurl:url", "-baseurl:url" +Specifies a base URL for the service. The final URL will be constructed by +combining this value with the URL read from the +.I -appsettingurlkey +option, and the +.I location +attribute specified in the WSDL document. +.TP +.I "-language:language", "-l" +Language of the code to generate. It can be CS (default) or VB. +.TP +.I "-namespace:name", "-n:name" +The namespace of the generated classes. If none is specified, the default +namespace is used. +.TP +.I "-out:filename", "-o:filename" +The target file for generated code. +.TP +.I "-protocol:protocol", "-p:protocol" +The protocol for which to generate code. It can be Soap (default), HttpGet or +HttpPost. +.TP +.I "-server" +Generate a server skeleton instead of a client proxy. +.TP +.I "-nologo" +Supress the startup logo. +.TP +.I "-u:username", "-user:username" +The user name to use when connecting to the server. +.TP +.I "-p:password", "-password:password" +The password to use when connecting to the server. +.TP +.I "-d:domain", "-domain:domain" +The domain to use when connecting to the server. +.PP +.SH AUTHORS +Lluis Sanchez Gual (lluis@ximian.com) +.PP +.SH LICENSE +wsdl is released under the terms of the GNU GPL. +.PP +.SH SEE ALSO +disco(1), soapsuds(1), mono(1), mcs(1) |