about summary refs log tree commit homepage
path: root/Documentation/yahns_config.pod
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/yahns_config.pod')
-rw-r--r--Documentation/yahns_config.pod31
1 files changed, 17 insertions, 14 deletions
diff --git a/Documentation/yahns_config.pod b/Documentation/yahns_config.pod
index 858aaf1..cc1ea71 100644
--- a/Documentation/yahns_config.pod
+++ b/Documentation/yahns_config.pod
@@ -1,5 +1,3 @@
-% yahns_config(5) yahns user manual
-
 =head1 NAME
 
 yahns_config - configuration file description for L<yahns(1)>
@@ -28,7 +26,7 @@ An app with the same :TYPE and APP_ARGUMENTS may be defined multiple
 times with different &BLOCK contents (with different listeners and
 buffering settings).
 
-See the APP-LEVEL DIRECTIVES section for details on what goes into
+See the L</APP-LEVEL DIRECTIVES> section for details on what goes into
 the &BLOCK.
 
 This directive may be specified multiple times for different or
@@ -37,7 +35,7 @@ identical applications.
 If the "working_directory" directive is used, all app directives may
 only be specified after setting "working_directory".
 
-For Rack HTTP applications, see RACK APP ARGUMENTS for more
+For Rack HTTP applications, see L</RACK APP ARGUMENTS> for more
 information.
 
 =item before_exec &BLOCK
@@ -104,7 +102,7 @@ Default: none
 
 As a top-level directive, this configures or defines a queue.
 If no NAME is specified, a default queue (named :default) is
-assumed.  See the QUEUE-LEVEL DIRECTIVES section for details.
+assumed.  See the L</QUEUE-LEVEL DIRECTIVES> section for details.
 
 A &BLOCK must be given if used as a top-level directive.  This
 behaves slightly differently inside an app &BLOCK.  This may also
@@ -418,7 +416,7 @@ one of the yahns instances is stopped while using this.
 
 This is supported on *BSD systems and Linux 3.9 or later.
 
-ref: https://lwn.net/Articles/542629/
+ref: L<https://lwn.net/Articles/542629/>
 
 Default: false (unset)
 
@@ -435,22 +433,21 @@ Default: none
 An example which seems to work is:
 
   require 'openssl'
-  ctx = OpenSSL::SSL::SSLContext.new
-  ctx.cert =
-    OpenSSL::X509::Certificate.new(
-      IO.read('/etc/ssl/certs/example.crt')
-    )
-  ctx.extra_chain_cert = [
+  ssl_ctx = OpenSSL::SSL::SSLContext.new
+  ssl_ctx.cert = OpenSSL::X509::Certificate.new(
+    IO.read('/etc/ssl/certs/example.crt')
+  )
+  ssl_ctx.extra_chain_cert = [
     OpenSSL::X509::Certificate.new(
       IO.read('/etc/ssl/certs/chain.crt')
     )
   ]
-  ctx.key = OpenSSL::PKey::RSA.new(
+  ssl_ctx.key = OpenSSL::PKey::RSA.new(
     IO.read('/etc/ssl/private/example.key')
   )
 
   app(:rack, "/path/to/my/app/config.ru") do
-    listen 443, ssl_ctx: ctx
+    listen 443, ssl_ctx: ssl_ctx
   end
 
 =item umask: MODE
@@ -645,6 +642,12 @@ See the examples/ directory in the git source tree.
 
   git clone git://yhbt.net/yahns.git
 
+=head1 CONTACT
+
+All feedback welcome via plain-text mail to L<mailto:yahns-public@yhbt.net>
+No subscription is necessary to post to the mailing list.
+List archives are available at L<http://yhbt.net/yahns-public/>
+
 =head1 COPYRIGHT
 
 Copyright (C) 2013-2016 all contributors L<mailto:yahns-public@yhbt.net>