.\" 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 "DH_RUBY 1" .TH DH_RUBY 1 "2012-05-17" "" "" .\" 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" dh_ruby \- debhelper7 build system for Ruby software .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBdh_ruby\fR [\fI\s-1OPTIONS\s0\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBdh_ruby\fR is a Debhelper 7 build system for Ruby software. It will automatically build and install files contained in Ruby packages, trying to work as close to Rubygems as possible but respecting Debian standards for Ruby packages. .PP dh_ruby can automatically run your tests against all supported Ruby versions, see the \*(L"\s-1FILES\s0\*(R" section below. .PP See dh_ruby \-\-help for details. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-\-clean\fR, \fB\-\-configure\fR, \fB\-\-build\fR, \fB\-\-test\fR, \fB\-\-install\fR" 4 .IX Item "--clean, --configure, --build, --test, --install" Commands called by debhelper at various steps of the build process. .IP "\fB\-h\fR, \fB\-\-help\fR" 4 .IX Item "-h, --help" Displays \fBdh_ruby\fR usage information. .IP "\fB\-v\fR, \fB\-\-version\fR" 4 .IX Item "-v, --version" Displays \fBdh_ruby\fR version information. .IP "\fB\-\-setuprb\fR" 4 .IX Item "--setuprb" This option indicates that the build should use \fIsetup.rb\fR rather than the usual gem-based build. To take effect, this option must come first ! .SH "ENVIRONMENT VARIABLES" .IX Header "ENVIRONMENT VARIABLES" .IP "\fI\s-1DH_RUBY_IGNORE_TESTS\s0\fR" 4 .IX Item "DH_RUBY_IGNORE_TESTS" This is a space-separated list of tests that dh_ruby will ignore during package build. The available test names are \*(L"require-rubygems\*(R" plus the names of all supported Ruby versions. At the time of writing, only \*(L"ruby1.8\*(R" and \*(L"ruby1.9.1\*(R" are supported. .Sp If set to \*(L"all\*(R", all tests will be ignored during the package build. .IP "\fI\s-1DH_RUBY_USE_DH_AUTO_INSTALL_DESTDIR\s0\fR" 4 .IX Item "DH_RUBY_USE_DH_AUTO_INSTALL_DESTDIR" If this variable is defined (to anything), dh_ruby will respect the directory informed by \fIdh_auto_install\fR\|(1), usually \fIdebian/tmp\fR. By default, gem2deb will install files to debian/\fIpackage\fR, where \fIpackage\fR is the first binary package listed in debian/control. .Sp This is useful for multi-binary source packages, where you will have all files installed to \fIdebian/tmp\fR, and can them split the files into separate packages by using debian/\fIpackage\fR.install. .IP "\fI\s-1DH_RUBY_GEMSPEC\s0\fR" 4 .IX Item "DH_RUBY_GEMSPEC" Determines which file contain the gem specification with package metadata. By default, dh_ruby will read metadata from a .gemspec file in the root of source package directory. You can use this variable to override that if want to provide custom metadata for the Debian package. .Sp In the case there are more than one .gemspec in the source package root, you will \fIneed\fR to use \s-1DH_RUBY_GEMSPEC\s0 to instruct dh_ruby about which one to use. .SH "FILES" .IX Header "FILES" .IP "debian/\fIruby\-test\-files.yaml\fR, debian/\fIruby\-tests.rake\fR, debian/\fIruby\-tests.rb\fR" 4 .IX Item "debian/ruby-test-files.yaml, debian/ruby-tests.rake, debian/ruby-tests.rb" Theses files can be used to explicitly tell dh_ruby how to run the tests in your package. When running the tests, dh_ruby will automatically set \s-1RUBYLIB\s0 to include the appropriate directories where the package files were installed in your package to make sure the tests use them instead of the files in the source directory. .Sp \&\fBYour package can only contain at most one of these files.\fR .Sp debian/\fIruby\-test\-files.yaml\fR must contain a \s-1YAML\s0 document with a list of test files to be run. If the package metadata contains an explicit list of test files, \fIgem2deb\fR\|(1) will automatically generate this file for you. Example from ruby-mime-types: .Sp .Vb 3 \& \-\-\- \& \- test/test_mime_type.rb \& \- test/test_mime_types.rb .Ve .Sp debian/\fIruby\-tests.rake\fR can be used to run the tests with \fIrake\fR\|(1). If you use this file, your package must Build-Depend on the \fIrake\fR package. You can use anything you would use in a regular Rakefile, but you must define a default task. gem2deb includes utility test task that makes it easier for you by creating a default task automatically. Example: .Sp .Vb 4 \& require \*(Aqgem2deb/rake/testtask\*(Aq \& Gem2Deb:Rake::TestTask.new do |t| \& t.test_files = FileList[\*(Aqtest/*_test.rb\*(Aq] \& end .Ve .Sp If debian/\fIruby\-tests.rb\fR exists, it will be run with each supported Ruby version, and must finish with a exit status of \fI0\fR, otherwise dh_ruby assumes the tests failed. A simple example: .Sp .Vb 7 \& require \*(Aqtest/unit\*(Aq \& require \*(Aqmypackage\*(Aq # if \*(Aqmypackage.rb\*(Aq or \*(Aqmypackage.so\*(Aq was not installed properly, this will fail \& class MyPackageTest < Test::Unit::TestCase \& def test_features \& assert_equal 4, MyPackage.sum(2,2) \& end \& end .Ve .IP "debian/\fIrequire\-rubygems.overrides\fR" 4 .IX Item "debian/require-rubygems.overrides" Fine-tune the \*(L"require-rubygems\*(R" test. If the package has a very good reason to actually `require \*(L"rubygems\*(R"`, you can use this file as a whitelist of files allowed to have `require \*(L"rubygems\*(R"`. .Sp This file is expect to contain a \s-1YAML\s0 document with a list of files that must be ignored when checking for `require \*(L"rubygems\*(R"` lines. Example: .Sp .Vb 3 \& \-\-\- \& \- debian/ruby\-foo/usr/lib/ruby/vendor_ruby/foo.rb \& \- debian/ruby\-foo/usr/lib/ruby/vendor_ruby/foo/rubygems.rg .Ve .Sp As you can see above, you have to list filenames based on their corresponding install locations in the package temporary install directory, i.e. `debian/${pkg}/..` .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBgem2deb\fR(1) .SH "COPYRIGHT AND AUTHORS" .IX Header "COPYRIGHT AND AUTHORS" Copyright (c) 2011, Lucas Nussbaum .PP This program is free software: you can redistribute it and/or modify it under the terms of the \s-1GNU\s0 General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. .PP This program is distributed in the hope that it will be useful, but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0. See the \&\s-1GNU\s0 General Public License for more details. .PP You should have received a copy of the \s-1GNU\s0 General Public License along with this program. If not, see .