split the ruby module description off, as it's now insanely big.

okay jeremy@, nits by jmc@

page still needs some cleaning up, mainly breathing spaces... ;)

3 files changed, 209 insertions, 166 deletions

diff --git a/share/man/man5/Makefile b/share/man/man5/Makefile
index e1afce72c74..8694f622bea 100644
--- a/share/man/man5/Makefile
+++ b/share/man/man5/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.44 2011/09/25 08:00:32 espie Exp $
+#	$OpenBSD: Makefile,v 1.45 2011/12/05 20:03:25 espie Exp $
 #	$NetBSD: Makefile,v 1.14 1995/05/11 23:13:15 cgd Exp $
 
 # missing: dump.5 plot.5
@@ -10,8 +10,8 @@ MAN=	a.out.5 acct.5 bsd.port.mk.5 bsd.port.arch.mk.5 bsd.regress.mk.5 \
 	hosts.equiv.5 hosts.5 intro.5 link.5 login.conf.5 mixerctl.conf.5 \
 	mk.conf.5 moduli.5 motd.5 myname.5 netgroup.5 networks.5 passwd.5 \
 	pf.conf.5 pf.os.5 port-modules.5 printcap.5 protocols.5 \
-	remote.5 resolv.conf.5 rpc.5 services.5 shells.5 stab.5 spamd.conf.5 \
-	sysctl.conf.5 utmp.5 wsconsctl.conf.5
+	remote.5 resolv.conf.5 rpc.5 ruby-module.5 services.5 shells.5 \
+	stab.5 spamd.conf.5 sysctl.conf.5 utmp.5 wsconsctl.conf.5
 	
 MLINKS= dir.5 dirent.5 fs.5 inode.5 utmp.5 wtmp.5 utmp.5 lastlog.5
 MLINKS+= hosts.equiv.5 .rhosts.5
diff --git a/share/man/man5/port-modules.5 b/share/man/man5/port-modules.5
index 1e53c342408..b94f10c7f18 100644
--- a/share/man/man5/port-modules.5
+++ b/share/man/man5/port-modules.5
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: port-modules.5,v 1.116 2011/12/05 08:05:38 jmc Exp $
+.\"	$OpenBSD: port-modules.5,v 1.117 2011/12/05 20:03:25 espie Exp $
 .\"
 .\" Copyright (c) 2008 Marc Espie
 .\"
@@ -731,168 +731,8 @@ May affect the
 .Ar regress
 target.
 .It lang/ruby
-Sets
-.Ev MODRUBY_REV ,
-.Ev RUBY ,
-.Ev RAKE ,
-.Ev RSPEC ,
-.Ev MODRUBY_BIN_TESTRB ,
-.Ev MODRUBY_BIN_RSPEC ,
-.Ev MODRUBY_RUN_DEPENDS ,
-.Ev MODRUBY_LIB_DEPENDS ,
-.Ev MODRUBY_BUILD_DEPENDS ,
-.Ev MODRUBY_ICONV_DEPENDS ,
-.Ev MODRUBY_LIBDIR ,
-.Ev MODRUBY_DOCDIR ,
-.Ev MODRUBY_SITEARCHDIR ,
-.Ev MODRUBY_SITEDIR ,
-.Ev MODRUBY_ARCH ,
-.Ev MODRUBY_EXAMPLEDIR ,
-.Ev MODRUBY_RUBY_ADJ ,
-.Ev MODRUBY_ADJ_FILES ,
-.Ev GEM_BIN_SUFFIX ,
-.Ev GEM_MAN_SUFFIX ,
-.Ev MODRUBY_LIBREV ,
-.Ev MODRUBY_BINREV ,
-.Ev MODRUBY_PKGSPEC ,
-.Ev MODRUBY_PKG_PREFIX ,
-.Ev MODRUBY_RAKE_DEPENDS ,
-.Ev MODRUBY_RSPEC_DEPENDS ,
-.Ev MODRUBY_WANTLIB ,
-.Ev MODRUBY_FLAVOR ,
-.Ev MODRUBY_REGRESS ,
-.Ev MODRUBY_REGRESS_TARGET ,
-.Ev MODRUBY_REGRESS_DIR ,
-.Ev MODRUBY_REGRESS_ENV ,
-.Ev MODRUBY_BUILD_TARGET ,
-.Ev MODRUBY_INSTALL_TARGET ,
-.Ev MODRUBY_EXTRACT_TARGET ,
-.Ev GEM ,
-.Ev GEM_BIN ,
-.Ev GEM_LIB ,
-.Ev GEM_BASE_LIB ,
-.Ev GEM_ABS_PATH ,
-.Ev GEM_BASE_BIN ,
-and
-.Ev GEM_FLAGS .
-Appends to
-.Ev CATEGORIES
-and
-.Ev SUBST_VARS .
-Appends to
-.Ev BUILD_DEPENDS
-unless
-.Ev MODRUBY_BUILDDEP
-is set to No or
-.Ev NO_BUILD
-is set to Yes.
-Appends to
-.Ev RUN_DEPENDS
-unless
-.Ev MODRUBY_RUNDEP
-is set to No.
-.Ev RUBY ,
-.Ev RAKE ,
-and
-.Ev MODRUBY_BIN_TESTRB
-are the path to the ruby, rake, and
-testrb binaries for the related ruby implementation.
-.Ev RSPEC
-and
-.Ev MODRUBY_BIN_RSPEC
-are the path to the spec (rspec 1) and
-rspec (rspec 2) binaries for the related ruby implementation.
-.Ev MODRUBY_RUBY_ADJ
-is a command that takes filename arguments and replaces
-the /usr/bin/env ruby shebang lines with
-.Ev RUBY .
-.Ev MODRUBY_ADJ_FILES
-is a list of filename patterns that will automatically have
-.Ev MODRUBY_RUBY_ADJ
-called on them during pre-configure.
-Creates a do-regress target if
-.Ev MODRUBY_REGRESS
-is used and one is not already defined.
-.Ev MODRUBY_REGRESS
-can be set to ruby, rake, rspec, rspec2, or testrb to
-choose the appropriate binary to run the regress tests.
-.Ev MODRUBY_REGRESS_ENV
-can be used to set environment variables for the regress tests.
-.Ev MODRUBY_REGRESS_DIR
-can be used to set the directory in which to execute
-the regress tests, it defaults to
-.Ev WRKSRC .
-.Ev MODRUBY_REGRESS_TARGET
-sets the argument to the regress test program.
-Supports additional
-.Ev CONFIGURE_STYLE s,
-and setting specific
-.Ev CONFIGURE_STYLE s
-modifies some additional parameters.
-The "ruby gem"
-.Ev CONFIGURE_STYLE
-should be used for pure ruby gems without C extensions.
-This adds
-.Ev PKG_ARCH
-= * and adds ruby19, rbx, and jruby
-.Ev FLAVOR s
-to the port, so the same port can build packages for multiple versions of ruby.
-The "ruby gem ext"
-.Ev CONFIGURE_STYLE
-should be used for ruby gems with C extensions.
-This adds
-.Ev SHARED_ONLY = Yes
-and adds
-.Ev MODRUBY_LIB_DEPENDS
-to
-.Ev LIB_DEPENDS
-and
-c, m, and
-.Ev MODRUBY_WANTLIB
-to
-.Ev WANTLIB.
-It also adds ruby19, rbx, and jruby
-.Ev FLAVOR s
-to the port.
-The "ruby extconf"
-.Ev CONFIGURE_STYLE
-is similar to the "ruby gem ext"
-.Ev CONFIGURE_STYLE ,
-except that it is used when the package is not distributed as a ruby gem.
-In order for ruby 1.9, rubinius, and jruby packages to be built from the same
-port directory, any gem dependencies specified in the port should use this
-format: category/ruby-foo,${MODRUBY_FLAVOR}.
-Use of a ruby19, rbx, or jruby
-.Ev FLAVOR
-causes the
-.Ev FULLPKGNAME
-to use the
-.Ev FLAVOR
-instead of ruby as the package prefix.
-Specifying
-.Ev MODRUBY_FLAVOR
-is necessary so that if you are building a ruby 1.9
-package for the current port, it depends on the ruby 1.9 package of the
-dependencies.
-For ruby gem ports that can work on both ruby 1.8 and ruby 1.9, any binary
-file entries in the PLIST should be appended with
-.Ev GEM_BIN_SUFFIX .
-This is because the ruby 1.8 and ruby 1.9 gem binaries are both installed to
-.Ev LOCALBASE /bin,
-and ruby 1.9 installs the binaries with a 19 suffix.
-Any man pages and other files that would be installed to locations not
-specific to a ruby implementation (such as under
-.Ev LOCALBASE /share),
-should use
-.Ev GEM_MAN_SUFFIX
-before the extension so the different
-.Ev FLAVOR s
-do not conflict.
-make update-plist currently removes
-.Ev GEM_BIN_SUFFIX
-and
-.Ev GEM_MAN_SUFFIX ,
-so be careful when updating gem ports with binaries or man pages.
+See
+.Xr ruby-module 5 .
 .It lang/tcl
 Sets
 .Ev MODTCL_VERSION ,
diff --git a/share/man/man5/ruby-module.5 b/share/man/man5/ruby-module.5
new file mode 100644
index 00000000000..d5e5f2ea894
--- /dev/null
+++ b/share/man/man5/ruby-module.5
@@ -0,0 +1,203 @@
+.\"	$OpenBSD: ruby-module.5,v 1.1 2011/12/05 20:03:25 espie Exp $
+.\"
+.\" Copyright (c) 2008 Marc Espie, Jeremy Evans
+.\"
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd $Mdocdate: December 5 2011 $
+.Dt RUBY-MODULE 5
+.Os
+.Sh NAME
+.Nm ruby-module
+.Nd lang/ruby port module
+.Sh DESCRIPTION
+This manual page documents the behavior of setting
+.Li MODULE=lang/ruby
+in the
+.Xr ports 7
+tree.
+.Pp
+Sets
+.Ev MODRUBY_REV ,
+.Ev RUBY ,
+.Ev RAKE ,
+.Ev RSPEC ,
+.Ev MODRUBY_BIN_TESTRB ,
+.Ev MODRUBY_BIN_RSPEC ,
+.Ev MODRUBY_RUN_DEPENDS ,
+.Ev MODRUBY_LIB_DEPENDS ,
+.Ev MODRUBY_BUILD_DEPENDS ,
+.Ev MODRUBY_ICONV_DEPENDS ,
+.Ev MODRUBY_LIBDIR ,
+.Ev MODRUBY_DOCDIR ,
+.Ev MODRUBY_SITEARCHDIR ,
+.Ev MODRUBY_SITEDIR ,
+.Ev MODRUBY_ARCH ,
+.Ev MODRUBY_EXAMPLEDIR ,
+.Ev MODRUBY_RUBY_ADJ ,
+.Ev MODRUBY_ADJ_FILES ,
+.Ev GEM_BIN_SUFFIX ,
+.Ev GEM_MAN_SUFFIX ,
+.Ev MODRUBY_LIBREV ,
+.Ev MODRUBY_BINREV ,
+.Ev MODRUBY_PKGSPEC ,
+.Ev MODRUBY_PKG_PREFIX ,
+.Ev MODRUBY_RAKE_DEPENDS ,
+.Ev MODRUBY_RSPEC_DEPENDS ,
+.Ev MODRUBY_WANTLIB ,
+.Ev MODRUBY_FLAVOR ,
+.Ev MODRUBY_REGRESS ,
+.Ev MODRUBY_REGRESS_TARGET ,
+.Ev MODRUBY_REGRESS_DIR ,
+.Ev MODRUBY_REGRESS_ENV ,
+.Ev MODRUBY_BUILD_TARGET ,
+.Ev MODRUBY_INSTALL_TARGET ,
+.Ev MODRUBY_EXTRACT_TARGET ,
+.Ev GEM ,
+.Ev GEM_BIN ,
+.Ev GEM_LIB ,
+.Ev GEM_BASE_LIB ,
+.Ev GEM_ABS_PATH ,
+.Ev GEM_BASE_BIN ,
+and
+.Ev GEM_FLAGS .
+Appends to
+.Ev CATEGORIES
+and
+.Ev SUBST_VARS .
+Appends to
+.Ev BUILD_DEPENDS
+unless
+.Ev MODRUBY_BUILDDEP
+is set to No or
+.Ev NO_BUILD
+is set to Yes.
+Appends to
+.Ev RUN_DEPENDS
+unless
+.Ev MODRUBY_RUNDEP
+is set to No.
+.Ev RUBY ,
+.Ev RAKE ,
+and
+.Ev MODRUBY_BIN_TESTRB
+are the path to the ruby, rake, and
+testrb binaries for the related ruby implementation.
+.Ev RSPEC
+and
+.Ev MODRUBY_BIN_RSPEC
+are the path to the spec (rspec 1) and
+rspec (rspec 2) binaries for the related ruby implementation.
+.Ev MODRUBY_RUBY_ADJ
+is a command that takes filename arguments and replaces
+the /usr/bin/env ruby shebang lines with
+.Ev RUBY .
+.Ev MODRUBY_ADJ_FILES
+is a list of filename patterns that will automatically have
+.Ev MODRUBY_RUBY_ADJ
+called on them during pre-configure.
+Creates a do-regress target if
+.Ev MODRUBY_REGRESS
+is used and one is not already defined.
+.Ev MODRUBY_REGRESS
+can be set to ruby, rake, rspec, rspec2, or testrb to
+choose the appropriate binary to run the regress tests.
+.Ev MODRUBY_REGRESS_ENV
+can be used to set environment variables for the regress tests.
+.Ev MODRUBY_REGRESS_DIR
+can be used to set the directory in which to execute
+the regress tests, it defaults to
+.Ev WRKSRC .
+.Ev MODRUBY_REGRESS_TARGET
+sets the argument to the regress test program.
+Supports additional
+.Ev CONFIGURE_STYLE Ns s ,
+and setting specific
+.Ev CONFIGURE_STYLE Ns s
+modifies some additional parameters.
+The "ruby gem"
+.Ev CONFIGURE_STYLE
+should be used for pure ruby gems without C extensions.
+This adds
+.Ev PKG_ARCH
+= * and adds ruby19, rbx, and jruby
+.Ev FLAVOR Ns s
+to the port, so the same port can build packages for multiple versions of ruby.
+The "ruby gem ext"
+.Ev CONFIGURE_STYLE
+should be used for ruby gems with C extensions.
+This adds
+.Ev SHARED_ONLY Ns =Yes
+and adds
+.Ev MODRUBY_LIB_DEPENDS
+to
+.Ev LIB_DEPENDS
+and
+c, m, and
+.Ev MODRUBY_WANTLIB
+to
+.Ev WANTLIB .
+It also adds ruby19, rbx, and jruby
+.Ev FLAVOR Ns s
+to the port.
+The "ruby extconf"
+.Ev CONFIGURE_STYLE
+is similar to the "ruby gem ext"
+.Ev CONFIGURE_STYLE ,
+except that it is used when the package is not distributed as a ruby gem.
+In order for ruby 1.9, rubinius, and jruby packages to be built from the same
+port directory, any gem dependencies specified in the port should use this
+format: category/ruby-foo,${MODRUBY_FLAVOR}.
+Use of a ruby19, rbx, or jruby
+.Ev FLAVOR
+causes the
+.Ev FULLPKGNAME
+to use the
+.Ev FLAVOR
+instead of ruby as the package prefix.
+Specifying
+.Ev MODRUBY_FLAVOR
+is necessary so that if you are building a ruby 1.9
+package for the current port, it depends on the ruby 1.9 package of the
+dependencies.
+For ruby gem ports that can work on both ruby 1.8 and ruby 1.9, any binary
+file entries in the PLIST should be appended with
+.Ev GEM_BIN_SUFFIX .
+This is because the ruby 1.8 and ruby 1.9 gem binaries are both installed to
+.Ev LOCALBASE Ns /bin ,
+and ruby 1.9 installs the binaries with a 19 suffix.
+Any man pages and other files that would be installed to locations not
+specific to a ruby implementation (such as under
+.Ev LOCALBASE Ns /share ) ,
+should use
+.Ev GEM_MAN_SUFFIX
+before the extension so the different
+.Ev FLAVOR Ns s
+do not conflict.
+make update-plist currently removes
+.Ev GEM_BIN_SUFFIX
+and
+.Ev GEM_MAN_SUFFIX ,
+so be careful when updating gem ports with binaries or man pages.
+.Sh SEE ALSO
+.Xr port-modules 5