man/yahns.1 in yahns-1.11.0 vs man/yahns.1 in yahns-1.12.0
- old
+ new
@@ -1,76 +1,207 @@
-.TH yahns 1 "" "yahns user manual"
-.SH NAME
-.PP
-yahns - multi-threaded, non-blocking application server for Ruby
-.SH SYNOPSYS
-.PP
-yahns -c CONFIG_FILE [-D|--daemonize]
-.SH DESCRIPTION
-.PP
-yahns(1) is the primary interface for launching a yahns application
-server.
-The configuration file is documented in yahns_config(5).
-yahns hosts Rack HTTP applications, but may support others in the future
-such as DRb.
-.SH SIGNALS
-.PP
-The following UNIX signals may be sent to the running yahns process.
+.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.ie \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.el \{\
+. de IX
+..
+.\}
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "YAHNS 1"
+.TH YAHNS 1 "1994-10-02" "yahns 1.11.0.19.g1843" "yahns user manual"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+yahns \- multi\-threaded, non\-blocking application server for Ruby
+.SH "SYNOPSYS"
+.IX Header "SYNOPSYS"
+yahns \-c \s-1CONFIG_FILE\s0 [\-D|\-\-daemonize]
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+\&\fIyahns\fR\|(1) is the primary interface for launching a yahns application
+server. The configuration file is documented in \fIyahns_config\fR\|(5).
+yahns hosts Rack \s-1HTTP\s0 applications, but may support others in the
+future such as DRb.
+.SH "SIGNALS"
+.IX Header "SIGNALS"
+The following \s-1UNIX\s0 signals may be sent to the running yahns process.
If yahns is configured for worker_processes (optional), signals should
only be sent to the master process.
-.IP \[bu] 2
-INT/TERM/QUIT - graceful shutdown.
-If repeated (any of these signals is sent twice), shutdown occurs
-immediately.
-.IP \[bu] 2
-USR1 - reopen all logs owned by the master and all workers.
+.IP "\s-1INT/TERM/QUIT\s0" 4
+.IX Item "INT/TERM/QUIT"
+Graceful shutdown. If repeated (any of these signals
+is sent twice), shutdown occurs immediately.
+.IP "\s-1USR1\s0" 4
+.IX Item "USR1"
+Reopen all logs owned by the master and all workers.
This scans the Ruby ObjectSpace for all open File objects with the
O_APPEND file flag and buffering disabled (IO#sync==false)
-.IP \[bu] 2
-USR2 - reexecute the running binary.
-A separate QUIT should be sent to
-.IP \[bu] 2
-HUP - if worker_processes are not used, this will reexecute the running
-binary and gracefully exit the running process.
-If worker_processes are used, this will reload config file, app, and
-gracefully restart all workers
-.IP \[bu] 2
-WINCH - gracefully stops workers but keep the master running.
+.IP "\s-1USR2\s0" 4
+.IX Item "USR2"
+Reexecute the running binary. A separate \s-1QUIT\s0 should be sent to
+the original process once the child is verified to
+be up and running.
+.IP "\s-1HUP\s0" 4
+.IX Item "HUP"
+If worker_processes are not used, this will reexecute the running
+binary and gracefully exit the running process. If worker_processes are
+used, this will reload config file, app, and gracefully restart all workers
+.IP "\s-1WINCH\s0" 4
+.IX Item "WINCH"
+Gracefully stops workers but keep the master running.
This will only work for daemonized processes and only if the
worker_processes configuration directive is used.
-.IP \[bu] 2
-TTIN - increment the number of worker processes by one (only if the
-worker_processes directive is used)
-.IP \[bu] 2
-TTOU - decrement the number of worker processes by one (only if the
-worker_processes directive is used)
-.SH ENVIRONMENT
+.IP "\s-1TTIN\s0" 4
+.IX Item "TTIN"
+Increment the number of worker processes by one
+(only if the worker_processes directive is used)
+.IP "\s-1TTOU\s0" 4
+.IX Item "TTOU"
+Decrement the number of worker processes by one
+(only if the worker_processes directive is used)
+.SH "ENVIRONMENT"
+.IX Header "ENVIRONMENT"
+\&\fIyahns\fR\|(1) itself requires no special environment variables. However,
+environment variables such as \s-1RACK_ENV\s0 and \s-1RAILS_ENV\s0 can affect Rack and
+Rails applications it hosts. Ruby and C library implementation-specific
+environment variables will also affect it.
.PP
-yahns(1) itself requires no special environment variables.
-However, environment variables such as RACK_ENV and RAILS_ENV can affect
-Rack and Rails applications it hosts.
-Ruby and C library implementation-specific environment variables will
-also affect it.
+yahns will update the \s-1PWD\s0 (current working directory) env if the
+working_directory directive is set (see \fIyahns_config\fR\|(5)).
.PP
-yahns will update the PWD (current working directory) env if the
-working_directory directive is set (see yahns_config(5)).
-.PP
-LISTEN_FDS and LISTEN_PID variables are used in our emulation of
-sd_listen_fds(3) function.
-See sd_listen_fds(3) manpage for more details.
-.SH FILES
-.PP
-See yahns_config(5) for documentation on the configuration file format.
-.SH CONTACT
-.PP
-All feedback welcome via plain-text mail to <yahns-public@yhbt.net>
-.PD 0
-.P
-.PD
+\&\s-1LISTEN_FDS\s0 and \s-1LISTEN_PID\s0 variables are used in our emulation
+of \fIsd_listen_fds\fR\|(3) function. See \fIsd_listen_fds\fR\|(3) manpage
+for more details.
+.SH "FILES"
+.IX Header "FILES"
+See \fIyahns_config\fR\|(5) for documentation on the configuration file format.
+.SH "CONTACT"
+.IX Header "CONTACT"
+All feedback welcome via plain-text mail to mailto:yahns\-public@yhbt.net <mailto:yahns-public@yhbt.net>
No subscription is necessary to post to the mailing list.
-.SH COPYRIGHT
-.PP
-Copyright (C) 2013-2015 all contributors <yahns-public@yhbt.net>
-License: GPLv3 or later <http://www.gnu.org/licenses/gpl-3.0.txt>
-.SH SEE ALSO
-.PP
-yahns-rackup(1), yahns_config(5), sd_listen_fds(3)
+Mail archives are available at http://yhbt.net/yahns\-public/ <http://yhbt.net/yahns-public/>
+.SH "COPYRIGHT"
+.IX Header "COPYRIGHT"
+Copyright (C) 2013\-2016 all contributors mailto:yahns\-public@yhbt.net <mailto:yahns-public@yhbt.net>
+License: \s-1GPL\-3\s0.0+ http://www.gnu.org/licenses/gpl\-3.0.txt <http://www.gnu.org/licenses/gpl-3.0.txt>
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fIyahns\-rackup\fR\|(1), \fIyahns_config\fR\|(5), \fIsd_listen_fds\fR\|(3)