annotate scripts/miscellaneous/perl.m @ 10791:3140cb7a05a1

Add spellchecker scripts for Octave and run spellcheck of documentation interpreter/doccheck: New directory for spelling/grammar scripts. interpreter/doccheck/README: Instructions for using scripts. interpreter/doccheck/spellcheck: Script to spellcheck a Texinfo file. interpreter/doccheck/aspell.conf: GNU Aspell configuration file for Octave documentation. interpreter/doccheck/aspell-octave.en.pws: Private Aspell dictionary. interpreter/doccheck/add_to_aspell_dict: Script to add new Octave-specific words to private Aspell dictionary. interpreter/octave.texi: New @nospell macro which forces Aspell to ignore the word marked by the macro. interpreter/mk_doc_cache.m: Skip new @nospell macro when building doc_cache.
author Rik <octave@nomad.inbox5.com>
date Sat, 17 Jul 2010 19:53:01 -0700
parents 95c3e38098bf
children be55736a0783
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9245
16f53d29049f update copyright notices
John W. Eaton <jwe@octave.org>
parents: 9051
diff changeset
1 ## Copyright (C) 2008, 2009 Julian Schnidder
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
2 ##
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
3 ## This file is part of Octave.
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
4 ##
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
8 ## your option) any later version.
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
9 ##
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
13 ## General Public License for more details.
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
14 ##
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
18
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
19 ## -*- texinfo -*-
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
20 ## @deftypefn {Function File} {[@var{output}, @var{status}] =} perl (@var{scriptfile})
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 7679
diff changeset
21 ## @deftypefnx {Function File} {[@var{output}, @var{status}] =} perl (@var{scriptfile}, @var{argument1}, @var{argument2}, @dots{})
10791
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
22 ## Invoke Perl script @var{scriptfile} with possibly a list of
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
23 ## command line arguments.
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
24 ## Returns output in @var{output} and status
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
25 ## in @var{status}.
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
26 ## @seealso{system}
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
27 ## @end deftypefn
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
28
7679
3c16e2414564 perl: don't provide default value for varargin
John W. Eaton <jwe@octave.org>
parents: 7675
diff changeset
29 function [output, status] = perl (script = "-e ''", varargin)
3c16e2414564 perl: don't provide default value for varargin
John W. Eaton <jwe@octave.org>
parents: 7675
diff changeset
30
3c16e2414564 perl: don't provide default value for varargin
John W. Eaton <jwe@octave.org>
parents: 7675
diff changeset
31 ## VARARGIN is intialized to {}(1x0) if no additional arguments are
3c16e2414564 perl: don't provide default value for varargin
John W. Eaton <jwe@octave.org>
parents: 7675
diff changeset
32 ## supplied, so there is no need to check for it, or provide an
3c16e2414564 perl: don't provide default value for varargin
John W. Eaton <jwe@octave.org>
parents: 7675
diff changeset
33 ## initial value in the argument list of the function definition.
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
34
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
35 if (ischar (script)
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
36 && ((nargin != 1 && iscellstr (varargin))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
37 || (nargin == 1 && ! isempty (script))))
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
38 [status, output] = system (cstrcat ("perl ", script,
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 9245
diff changeset
39 sprintf (" %s", varargin{:})));
7675
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
40 else
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
41 error ("perl: invalid arguments");
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
42 endif
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
43
8abada567409 perl.m: new function
Julian Schnidder <j.schnidder@gmx.de>
parents:
diff changeset
44 endfunction