debian/man-pages/shib-metagen.pod

   1 =head1 NAME
   2
   3 shib-metagen - Generate metadata for a Shibboleth SP
   4
   5 =head1 SYNOPSIS
   6
   7 B<shib-metagen> [B<-c> I<cert> [B<-c> I<cert> ...]] [B<-e> I<entity-id>]
   8     [B<-h> I<host> [B<-h> I<host> ...]] [B<-n> I<host> [B<-n> I<host> ...]]
   9     [B<-o> I<organization>] [B<-a> I<admin> [B<-a> I<admin> ...]]
  10     [B<-s> I<support> [B<-s> I<support> ...]]
  11     [B<-t> I<tech> [B<-t> I<tech> ...]]
  12
  13 =head1 DESCRIPTION
  14
  15 Generate metadata for a Shibboleth SP.  The metadata is printed to
  16 standard output.  Most of the parameters are optional, but at least one of
  17 B<-h> or B<-n> must be given to specify the hostname to use in
  18 constructing URLs for the Shibboleth service for the SP.  Other metadata
  19 can be added by using the other command-line parameters.  Most parameters
  20 can be given multiple times.
  21
  22 =head1 OPTIONS
  23
  24 =over 4
  25
  26 =item B<-a> I<admin>
  27
  28 An administrative contact for this Shibboleth SP.  This option may be
  29 omitted, in which case administrative contact metadata is not included, or
  30 may be given multiple times to list multiple contacts.  I<admin> should be
  31 in the form C<I<first>/I<last>/I<email>> where I<first> is the given name
  32 and I<last> is the surname.
  33
  34 =item B<-c> I<cert>
  35
  36 Specifies the SSL certificate used to identify this Shibboleth SP.  This
  37 option may be given multiple times to specify multiple certificates.  If
  38 it is not given, the default certificate is F<sp-cert.pem> in the current
  39 working directory.
  40
  41 =item B<-e> I<entity-id>
  42
  43 The entity ID for this SP.  This must be a unique identifier for this SP
  44 and must be a URL.  If B<-o> is given, it is used as the URL for the
  45 organization running this Shibboleth SP.  If it is not specified, it
  46 defaults to C<https://I<host>/shibboleth> where I<host> is the argument to
  47 the first B<-h> option.
  48
  49 =item B<-h> I<host>
  50
  51 A hostname for this SP (possibly a virtual host).  Either this option or
  52 B<-n> must be specified at least once.  It should be repeated for every
  53 virtual host that responds to the Shibboleth protocol.  B<-h> should be
  54 used for hostnames or virtual hosts that use SSL.
  55
  56 =item B<-n> I<host>
  57
  58 A hostname for this SP (possibly a virtual host).  Either this option or
  59 B<-h> must be specified at least once.  It should be repeated for every
  60 virtual host that responds to the Shibboleth protocol.  B<-n> should be
  61 used for hostnames or virtual hosts that do not use SSL to protect the
  62 Shibboleth communication.
  63
  64 =item B<-o> I<organization>
  65
  66 The name of the organization that runs this Shibboleth SP.  This option
  67 may be given only once and may be omitted, in which case organization
  68 metadata is not included.  This is normally not necessary but may be used
  69 by other software systems for purposes such as displaying lists of
  70 entities with human-readable names.
  71
  72 =item B<-s> I<support>
  73
  74 A support contact for this Shibboleth SP.  This option may be omitted, in
  75 which case support contact metadata is not included, or may be given
  76 multiple times to list multiple contacts.  I<support> should be in the
  77 form C<I<first>/I<last>/I<email>> where I<first> is the given name and
  78 I<last> is the surname.
  79
  80 =item B<-t> I<tech>
  81
  82 A technical contact for this Shibboleth SP.  This option may be omitted,
  83 in which case technical contact metadata is not included, or may be given
  84 multiple times to list multiple contacts.  I<tech> should be in the form
  85 C<I<first>/I<last>/I<email>> where I<first> is the given name and I<last>
  86 is the surname.
  87
  88 =head1 AUTHOR
  89
  90 This manual page was written by Russ Allbery for Debian GNU/Linux.
  91
  92 =head1 COPYRIGHT
  93
  94 Copyright 2009 Russ Allbery.  This manual page is hereby placed into the
  95 public domain by its author.
  96
  97 =cut