Merge branch 'upstream' into debian
[shibboleth/sp.git] / debian / man-pages / shibd.pod
1 =head1 NAME
2
3 shibd - Shibboleth daemon
4
5 =head1 SYNOPSIS
6
7 shibd [B<-tfFvh>] [B<-c> I<config>] [B<-d> I<prefix>] [B<-p> I<pidfile>]
8 [B<-w> I<seconds>] [B<-x> I<catalog>]
9
10 =head1 DESCRIPTION
11
12 B<shibd> is the Shibboleth daemon.  It handles attribute requests from the
13 Apache Shibboleth module and should run in conjunction with it.
14
15 =head1 OPTIONS
16
17 B<shibd> takes the following command-line options.
18
19 =over 4
20
21 =item B<-c> I<pathname>
22
23 Specifies the pathname of B<shibd>'s configuration file. Defaults to
24 /etc/shibboleth/shibboleth2.xml or the value of the SHIBSP_CONFIG
25 environment variable, if it is set.
26
27 =item B<-d> I<pathname>
28
29 Installation prefix. Defaults to /usr.
30
31 =item B<-F>
32
33 Stay in the foreground.  Normally, B<shibd> backgrounds itself after
34 starting up.
35
36 =item B<-f>
37
38 Force removal of listener socket.
39
40 =item B<-h>
41
42 Prints out a brief summary of the shibboleth options.
43
44 =item B<-p> I<pathname>
45
46 Specifies the pathname to use to write out the shibboleth PID file.
47
48 =item B<-w> I<seconds>
49
50 Seconds to wait for the background B<shibd> to start up before the
51 foreground process returns.  If not set, the default value is three
52 seconds.
53
54 =item B<-t>
55
56 Validates the general correctness of the configuration. Not all problems
57 can be detected this way, but the chance of successful startup is high if
58 the checking process does not log any errors.
59
60 =item B<-v>
61
62 Prints out the version string.
63
64 =item B<-x> I<pathname>
65
66 Specifies the XML schema catalog to use. Defaults to
67 /usr/share/xml/shibboleth/catalog.xml.
68
69 =back
70
71 =head1 AUTHORS
72
73 shibd is part of the Internet 2 Shibboleth project written by
74 Scott Cantor <cantor.2@osu.edu>.
75
76 =head1 COPYRIGHT AND LICENSE
77
78 Copyright 2005, 2006
79 Internet2/MACE
80
81 This program is free software; you may redistribute it and/or modify it
82 under the terms of the Apache 2.0 License <http://www.apache.org/licenses>.
83
84 =cut