2006-12-11 Miguel de Icaza <miguel@novell.com>
[mono-project.git] / man / wsdl.1
blobe2bb6ccd773bbd5d8c56dbd8afe3ea94e756bfc3
1 \"
2 .\" wsdl manual page.
3 .\" (C) 2003 Novell, Inc.
4 .\" Author:
5 .\"   Lluis Sanchez Gual (lluis@ximian.com)
6 .\"
7 .TH wsdl 1
8 .SH NAME
9 wsdl \- Mono's Web Service Proxy Generator
10 .SH SYNOPSIS
11 .PP
12 .B wsdl
13 [options] [path | url]
14 .SH DESCRIPTION
15 .I wsdl
16 is a tool for generating proxy classes that can be used to access to
17 web services.  The tool reads a WSDL document from the provided path
18 or url, and downloads referenced schemas or other WSDL documents if
19 needed.
20 .PP
21 This tool is used to target the 1.x API, for targetting the 2.x API,
22 please use the wsdl2 tool.
23 .PP
24 .SH OPTIONS
25 The following options are available:
26 .TP
27 .I "-appsettingurlkey:key" "-urlkey:key"
28 Specifies that the url for the services should be read from the <appsettings> section
29 of the configuration file, using the provided key.
30 .TP
31 .I "-appsettingbaseurl:url", "-baseurl:url"
32 Specifies a base URL for the service. The final URL will be constructed by
33 combining this value with the URL read from the
34 .I -appsettingurlkey
35 option, and the 
36 .I "-type:typename, assembly"
37 Generate a proxy for a compiled web service class. The URL parameter
38 can be used to providethe location of the service.
39 .I location
40 attribute specified in the WSDL document.
41 .TP
42 .I "-language:language", "-l"
43 Language of the code to generate. It can be CS for C# (default), Boo
44 for Boo and VB for Visual.Basic.
45 .TP
46 Alternatively you can specify a full type name for a CodeProvider, for
47 example, you could use this to generate code for the imaginary "MyLan"
48 language which has the following full type:
49 .nf
50         wsdl myservice.wsdl -language:MyLan.MyLanCodeProvider, MyLan.CodeDom, Version=1.0.0.0, Culture=neutral, PublicKeyToken=xxyy'
51 .fi
52 .TP
53 .I "-namespace:name", "-n:name"
54 The namespace of the generated classes. If none is specified, the default
55 namespace is used.
56 .TP
57 .I "-out:filename", "-o:filename"
58 The target file for generated code.
59 .TP
60 .I "-protocol:protocol", "-p:protocol"
61 The protocol for which to generate code. It can be Soap (default), HttpGet or
62 HttpPost.
63 .TP
64 .I "-sample:METHOD"
65 This will display XML request and reply of the sample invocations to
66 that SOAP message.  You can use the -protocol: option to render the
67 message in different forms.
68 .TP
69 .I "-server"
70 Generate a server skeleton instead of a client proxy.
71 .TP
72 .I "-nologo"
73 Supress the startup logo.
74 .TP
75 .I "-u:username", "-user:username"
76 The user name to use when connecting to the server.
77 .TP
78 .I "-p:password", "-password:password"
79 The password to use when connecting to the server.
80 .TP
81 .I "-d:domain", "-domain:domain"
82 The domain to use when connecting to the server.
83 .PP
84 .SH AUTHORS
85 Lluis Sanchez Gual (lluis@ximian.com)
86 .PP
87 .SH LICENSE
88 wsdl is released under the terms of the GNU GPL.
89 .PP
90 .SH SEE ALSO
91 disco(1), soapsuds(1), mono(1), mcs(1), wsdl2(1)