Add man pages for mdquery and resolvertest
[shibboleth/sp.git] / debian / man-pages / mdquery.pod
1 =head1 NAME
2
3 mdquery - Query Shibboleth metadata
4
5 =head1 SYNOPSIS
6
7 B<mdquery> B<-e> I<entity> [B<-a> I<app>] [B<-nostrict>]
8
9 B<mdquery> B<-e> I<entity> B<-r> I<role> B<-p> I<protocol> [B<-a> I<app>]
10     [B<-ns> I<namespace>] [B<-nostrict>]
11
12 =head1 DESCRIPTION
13
14 B<mdquery> queries and displays Shibboleth SP metadata.  It is primarily a
15 debugging tool to use in conjunction with advice from the Shibboleth
16 mantaininers.  It can display either the metadata for an entity or the
17 metadata for a particular role.
18
19 =head1 OPTIONS
20
21 =over 4
22
23 =item B<-a> I<app>
24
25 Specifies the application ID for which to retrieve metadata.  If not given
26 the default is C<default>.
27
28 =item B<-e> I<entity>
29
30 Specifies the entity ID for which to show metadata.  Normally this is the
31 entity descriptor ID for an entity with which one is having a problem
32 (such as the entity ID for the local SP).
33
34 =item B<-nostrict>
35
36 Relax the strictness of checking (such as of expiration dates).
37
38 =item B<-ns> I<namespace>
39
40 When retrieving metadata for a particular role, specify the namespace.  If
41 not given, the default is the SAML20MD namespace.
42
43 =item B<-p> I<protocol>
44
45 Specify a protocol when retrieving metadata for a particular role.
46 Normally one would use the B<-saml10>, B<-saml11>, or B<-saml2> options to
47 specify the protocol name, but this option allows an arbitrary protocol to
48 be specified.
49
50 =item B<-saml10>
51
52 Specify a protocol of SAML 1.0.
53
54 =item B<-saml11>
55
56 Specify a protocol of SAML 1.1.
57
58 =item B<-saml2>
59
60 Specify a protocol of SAML 2.0.
61
62 =item B<-r> I<role>
63
64 Retrieve the metadata for a particular role.  Normally one would use the
65 B<-idp>, B<-aa>, B<-pdp>, or B<-sp> options to specify the role name, but
66 this option allows an arbitrary role to be specified.
67
68 =item B<-idp>
69
70 Specify a role of IDPSSODescriptor.
71
72 =item B<-aa>
73
74 Specify a role of AttributeAuthorityDescriptor.
75
76 =item B<-pdp>
77
78 Specify a role of PDPDescriptor.
79
80 =item B<-sp>
81
82 Specify a role of SPSSODescriptor.
83
84 =back
85
86 =head1 AUTHOR
87
88 This manual page was written by Russ Allbery for Debian GNU/Linux.
89
90 =head1 COPYRIGHT
91
92 Copyright 2008 Russ Allbery.  This manual page is hereby placed into the
93 public domain by its author.
94
95 =cut