.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "DH_OCTAVE_CHECK 1"
.TH DH_OCTAVE_CHECK 1 "2023-04-30" "1.4.0" "dh-octave"
.\" 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_octave_check \- automatically run an Octave\-Forge package test suite
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBdh_octave_check\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBdh_octave_check\fR performs the automated tests present in both \fI*.m\fR
and \*(C+ files in the sub-directories of the current directory, which
should be the top-level source directory of an Octave add-on package.
It also runs the script \fIdebian/check.m\fR, if it exists.
.SH "ENVIRONMENT VARIABLES"
.IX Header "ENVIRONMENT VARIABLES"
Some aspects of the execution of \fBdh_octave_check\fR can be controlled
through the environment variables listed below.  These variables can
also be set in file \f(CW\*(C`debian/checkvars\*(C'\fR, which is sourced by
\&\fBdh_octave_check\fR.
.IP "\s-1DH_OCTAVE_EXCLUDE_TEST\s0" 4
.IX Item "DH_OCTAVE_EXCLUDE_TEST"
A space-separated list with the the names of the files whose unit
tests should not be run.
.IP "\s-1DH_OCTAVE_TEST_OPT\s0" 4
.IX Item "DH_OCTAVE_TEST_OPT"
The optional second argument for Octave’s test function.  Allowed
values are \f(CW"quiet"\fR, \f(CW"normal"\fR, and \f(CW"verbose"\fR.
.IP "\s-1DH_OCTAVE_TEST_ENV\s0" 4
.IX Item "DH_OCTAVE_TEST_ENV"
Prefix for calling the Octave command.  It can be used for setting
environment variables to Sensible values (for instance
\&\f(CW"LD_PRELOAD="\fR) and specifying another program under which Octave
must be run (like \f(CW"xvfb\-run"\fR).
.IP "octave" 4
.IX Item "octave"
Name of the Octave binary to run (defaults to \f(CW"octave\-cli"\fR).
.IP "octave_options" 4
.IX Item "octave_options"
Command line options for Octave (defaults to \f(CW"\-\-no\-history \-\-silent
\&\-\-no\-init\-file \-\-no\-window\-system"\fR).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdebhelper\fR\|(7), \fBdh\fR\|(1), \fBdh_octave_substvar\fR\|(1), \fBdh_octave_clean\fR\|(1),
\&\fBdh_octave_version\fR\|(1), \fBdh_octave_changelogs\fR\|(1), \fBdh_octave_examples\fR\|(1)
.PP
This program is meant to be used together with debhelper for Debian
packages derived from Octave-Forge packages.
It is recommended to enable it by adding the dh-sequence-octave
virtual package to Build-Depends, Build-Depends-Arch or
Build-Depends-Indep.
This is equivalent to adding dh-octave to the same field and adding
\&\-\-with=octave to the dh sequencer in debian/rules, except that only
\&\-arch/\-indep/profiled builds are affected.
This is also slightly more simple in the most common case.
.SH "AUTHOR"
.IX Header "AUTHOR"
Rafael Laboissière <rafael@debian.org>