From e1b76e37aae33a54cf5463caab41421684d88221 Mon Sep 17 00:00:00 2001 From: Russ Allbery Date: Fri, 21 Aug 2009 11:14:36 -0700 Subject: [PATCH] Update the shibd man page for new upstream options Also alphabetize the options, clarify the options with arguments in the SYNOPSIS, and add a bit more of a summary of what shibd is for. --- debian/man-pages/shibd.pod | 45 +++++++++++++++++++++++++++++---------------- 1 file changed, 29 insertions(+), 16 deletions(-) diff --git a/debian/man-pages/shibd.pod b/debian/man-pages/shibd.pod index 955e634..3769121 100644 --- a/debian/man-pages/shibd.pod +++ b/debian/man-pages/shibd.pod @@ -4,11 +4,13 @@ shibd - Shibboleth daemon =head1 SYNOPSIS -shibd [B<-dcxtfpvh>] +shibd [B<-tfFvh>] [B<-c> I] [B<-d> I] [B<-p> I] +[B<-w> I] [B<-x> I] =head1 DESCRIPTION -B is the Shibboleth daemon. +B is the Shibboleth daemon. It handles attribute requests from the +Apache Shibboleth module and should run in conjunction with it. =head1 OPTIONS @@ -16,42 +18,53 @@ B takes the following command-line options. =over 4 -=item B<-d> I - -Installation prefix. Defaults to /usr. - =item B<-c> I -Specifies the pathname of shibd's configuration file. Defaults to +Specifies the pathname of B's configuration file. Defaults to /etc/shibboleth/shibboleth2.xml or the value of the SHIBSP_CONFIG environment variable, if it is set. -=item B<-x> I +=item B<-d> I -Specifies the XML schema catalog to use. Defaults to -/usr/share/xml/shibboleth/catalog.xml. +Installation prefix. Defaults to /usr. -=item B<-t> +=item B<-F> -Validates the general correctness of the configuration. Not all problems -can be detected this way, but the chance of successful startup is high if -the checking process does not log any errors. +Stay in the foreground. Normally, B backgrounds itself after +starting up. =item B<-f> Force removal of listener socket. +=item B<-h> + +Prints out a brief summary of the shibboleth options. + =item B<-p> I Specifies the pathname to use to write out the shibboleth PID file. +=item B<-w> I + +Seconds to wait for the background B to start up before the +foreground process returns. If not set, the default value is three +seconds. + +=item B<-t> + +Validates the general correctness of the configuration. Not all problems +can be detected this way, but the chance of successful startup is high if +the checking process does not log any errors. + =item B<-v> Prints out the version string. -=item B<-h> +=item B<-x> I -Prints out a brief summary of the shibboleth options. +Specifies the XML schema catalog to use. Defaults to +/usr/share/xml/shibboleth/catalog.xml. =back -- 2.1.4