Merge pull request #5714 from alexischr/update_bockbuild
[mono.git] / man / httpcfg.1
1 .\" 
2 .\" httpcfg manual page.
3 .\" Copyright 2006 Novell
4 .\" Author:
5 .\"   Miguel de Icaza (miguel@novell.com)
6 .\"
7 .TH Mono "httpcfg"
8 .SH NAME
9 httpcfg \- Mono Certificate Management for HttpListener
10 .SH SYNOPSIS
11 .PP
12 .B httpcfg [options] certificate
13 .SH DESCRIPTION
14 This tool is used to manage the certificates used by the HttpListener
15 embeddable server class when the HttpListener is configured as an
16 HTTPS server instead of an HTTP server.   
17 .PP
18 You must select one of the possible actions: add, delete or list.
19 .PP
20 When adding a certificate (-add), you must provide the following
21 information: a certificate (with the -cert flag) a Private Key file
22 (with the -pvk argument, the filename is typically "key") and a port
23 number (with the -port flag).
24 .PP
25 When deleting a certificate (-del or -delete) you need to provide the
26 port number.
27 .SH PARAMETERS
28 .TP
29 .I "-add"
30 Adds a new certificate/private key combination for being used at a
31 given port by the HttpListener API.
32 .TP
33 .I "-del," "-delete"
34 Deletes the certificates associated for the port specified (must be
35 specified separatedly).
36 .TP
37 .I "-list"
38 List all known certificates. 
39 .TP
40 .I "-port PORT"
41 Specifies the port to add certificates to, or remove certificates
42 from. 
43 .TP
44 .I "-pvk FILE"
45 Specifies the Private Key file.  
46 .TP
47 .I "-cert CERT"
48 Specifies the certificate file to use.
49 .SH EXAMPLES
50 .nf
51 httpcfg -add -port 8081 -pvk myfile.pvk -cert MyCert
52 .fi
53 .PP
54 For more details on creating the certificate file and the private key,
55 see the following web page:
56 .PP
57 http://www.mono-project.com/docs/web/using-clientcertificates-with-xsp/
58 .SH FILES
59 The certificates are stored in the ~/.mono/httplistener directory
60 .SH AUTHOR
61 .B httpcfg
62 was written by Gonzalo Paniagua.
63 .SH COPYRIGHT
64 Copyright (C) 2006 Novell. 
65 .SH MAILING LISTS
66 Visit http://lists.ximian.com/mailman/listinfo/mono-devel-list for details.
67 .SH WEB SITE
68 Visit http://www.mono-project.com for details
69 .SH SEE ALSO
70 .B makecert(1), signcode(1), cert2spc(1)
71 .PP
72 The private key format:
73 .nf
74 http://www.drh-consultancy.demon.co.uk/pvk.html
75 .fi