annotate scripts/miscellaneous/unix.m @ 21633:dcf8922b724b

Deprecate printf, puts, and scanf. Make fputs a M-file. * libinterp/corefcn/file-io.cc: extracted printf, puts, and scanf to M-files. * scripts/deprecated/printf.m: new function, equivalent to version file-io.cc. * scripts/deprecated/puts.m: new function, equivalent to version file-io.cc. * scripts/deprecated/scanf.m: new function, equivalent to version file-io.cc. * scripts/deprecated/module.mk: added printf, puts, and scanf. * scripts/io/fputs.m: new function, equivalent to version file-io.cc. * scripts/io/module.mk: added fputs. * doc/interpreter/io.txi: adapted documentation to current implementation. * NEWS: announced changes. * doc/interpreter/basics.txi: replaced printf by fprintf. * doc/interpreter/stmt.txi: replaced printf by fprintf. * doc/interpreter/var.txi: replaced printf by fprintf. * doc/refcard/refcard.tex: removed printf and scanf. * examples/code/@FIRfilter/display.m: replaced printf by fprintf. * examples/code/@polynomial/display.m: replaced printf by fprintf. * scripts/@ftp/display.m: replaced printf by fprintf. * scripts/general/inputParser.m: replaced printf by fprintf. * scripts/general/methods.m: replaced printf by fprintf. * scripts/general/profexplore.m: replaced printf by fprintf. * scripts/general/profshow.m: replaced printf by fprintf. * scripts/help/help.m: replaced puts by fputs and printf by fprintf. * scripts/help/lookfor.m: replaced puts by fputs and printf by fprintf. * scripts/help/which.m: replaced printf by fprintf. * scripts/image/imformats.m: replaced printf by fprintf. * scripts/io/beep.m: replaced puts by fputs. * scripts/io/textread.m: replaced printf by fprintf. * scripts/java/javaclasspath.m: replaced printf by fprintf. * scripts/java/javamem.m: replaced printf by fprintf. * scripts/miscellaneous/dir.m: replaced printf by fprintf. * scripts/miscellaneous/dos.m: replaced printf by fprintf. * scripts/miscellaneous/fact.m: replaced printf by fprintf. * scripts/miscellaneous/info.m: replaced printf by fprintf. * scripts/miscellaneous/license.m: replaced printf by fprintf. * scripts/miscellaneous/ls.m: replaced puts by fputs. * scripts/miscellaneous/menu.m: replaced printf by fprintf. * scripts/miscellaneous/mkoctfile.m: replaced printf by fprintf. * scripts/miscellaneous/private/display_info_file.m: * scripts/miscellaneous/unix.m: replaced printf by fprintf. * scripts/miscellaneous/ver.m: replaced printf by fprintf. * scripts/miscellaneous/what.m: replaced printf by fprintf. * scripts/ode/ode23.m: replaced printf by fprintf. * scripts/ode/ode45.m: replaced printf by fprintf. * scripts/optimization/fminbnd.m: replaced printf by fprintf. * scripts/optimization/optimset.m: replaced puts by fputs and printf by fprintf. * scripts/optimization/sqp.m: replaced printf by fprintf. * scripts/pkg/pkg.m: replaced printf by fprintf. * scripts/pkg/private/describe.m: replaced printf by fprintf. * scripts/pkg/private/install.m: replaced printf by fprintf. * scripts/pkg/private/installed_packages.m: replaced printf by fprintf. * scripts/pkg/private/list_forge_packages.m: replaced puts by fputs and printf by fprintf. * scripts/pkg/private/rebuild.m: replaced printf by fprintf. * scripts/plot/util/__gnuplot_drawnow__.m: replaced puts by fputs and printf by fprintf. * scripts/signal/stft.m: replaced printf by fprintf. * scripts/sparse/bicg.m: replaced printf by fprintf. * scripts/sparse/bicgstab.m: replaced printf by fprintf. * scripts/sparse/cgs.m: replaced printf by fprintf. * scripts/sparse/pcg.m: replaced printf by fprintf. * scripts/sparse/pcr.m: replaced printf by fprintf. * scripts/sparse/qmr.m: replaced printf by fprintf. * scripts/statistics/models/logistic_regression.m: replaced printf by fprintf. * scripts/statistics/tests/anova.m: replaced printf by fprintf. * scripts/statistics/tests/bartlett_test.m: replaced printf by fprintf. * scripts/statistics/tests/chisquare_test_homogeneity.m: replaced printf by fprintf. * scripts/statistics/tests/chisquare_test_independence.m: replaced printf by fprintf. * scripts/statistics/tests/cor_test.m: replaced printf by fprintf. * scripts/statistics/tests/f_test_regression.m: replaced printf by fprintf. * scripts/statistics/tests/hotelling_test.m: replaced printf by fprintf. * scripts/statistics/tests/hotelling_test_2.m: replaced printf by fprintf. * scripts/statistics/tests/kolmogorov_smirnov_test.m: replaced printf by fprintf. * scripts/statistics/tests/kolmogorov_smirnov_test_2.m: replaced printf by fprintf. * scripts/statistics/tests/kruskal_wallis_test.m: replaced printf by fprintf. * scripts/statistics/tests/manova.m: replaced printf by fprintf. * scripts/statistics/tests/mcnemar_test.m: replaced printf by fprintf. * scripts/statistics/tests/prop_test_2.m: replaced printf by fprintf. * scripts/statistics/tests/run_test.m: replaced printf by fprintf. * scripts/statistics/tests/sign_test.m: replaced printf by fprintf. * scripts/statistics/tests/t_test.m: replaced printf by fprintf. * scripts/statistics/tests/t_test_2.m: replaced printf by fprintf. * scripts/statistics/tests/t_test_regression.m: replaced printf by fprintf. * scripts/statistics/tests/u_test.m: replaced printf by fprintf. * scripts/statistics/tests/var_test.m: replaced printf by fprintf. * scripts/statistics/tests/welch_test.m: replaced printf by fprintf. * scripts/statistics/tests/wilcoxon_test.m: replaced printf by fprintf. * scripts/statistics/tests/z_test.m: replaced printf by fprintf. * scripts/statistics/tests/z_test_2.m: replaced printf by fprintf. * scripts/strings/strtok.m: replaced printf by fprintf. * scripts/testfun/__run_test_suite__.m: replaced puts by fputs and printf by fprintf. * scripts/testfun/demo.m: replaced printf by fprintf. * scripts/testfun/example.m: replaced printf by fprintf. * scripts/testfun/private/compare_plot_demos.m: replaced printf by fprintf. * scripts/testfun/rundemos.m: replaced printf by fprintf. * scripts/testfun/runtests.m: replaced puts by fputs and printf by fprintf. * scripts/testfun/speed.m: replaced printf by fprintf. * scripts/testfun/test.m: replaced printf by fprintf. * scripts/time/calendar.m: replaced puts by fputs and printf by fprintf. * test/io.tst: replaced printf by fprintf.
author Kai T. Ohlhus <k.ohlhus@gmail.com>
date Wed, 20 Apr 2016 17:53:10 +0200
parents 516bb87ea72e
children 96518f623c91
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19596
diff changeset
1 ## Copyright (C) 2004-2015 John W. Eaton
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
2 ##
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
4 ##
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## your option) any later version.
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
9 ##
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
14 ##
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
18
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20515
diff changeset
20 ## @deftypefn {} {} unix ("@var{command}")
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20515
diff changeset
21 ## @deftypefnx {} {@var{status} =} unix ("@var{command}")
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20515
diff changeset
22 ## @deftypefnx {} {[@var{status}, @var{text}] =} unix ("@var{command}")
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 20515
diff changeset
23 ## @deftypefnx {} {[@dots{}] =} unix ("@var{command}", "-echo")
19223
eeb2a01cdc26 doc: Improve docstrings for dos() and unix().
Rik <rik@octave.org>
parents: 17744
diff changeset
24 ## Execute a system command if running under a Unix-like operating system,
eeb2a01cdc26 doc: Improve docstrings for dos() and unix().
Rik <rik@octave.org>
parents: 17744
diff changeset
25 ## otherwise do nothing.
eeb2a01cdc26 doc: Improve docstrings for dos() and unix().
Rik <rik@octave.org>
parents: 17744
diff changeset
26 ##
eeb2a01cdc26 doc: Improve docstrings for dos() and unix().
Rik <rik@octave.org>
parents: 17744
diff changeset
27 ## Octave waits for the external command to finish before returning the exit
eeb2a01cdc26 doc: Improve docstrings for dos() and unix().
Rik <rik@octave.org>
parents: 17744
diff changeset
28 ## status of the program in @var{status} and any output in @var{text}.
eeb2a01cdc26 doc: Improve docstrings for dos() and unix().
Rik <rik@octave.org>
parents: 17744
diff changeset
29 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 14138
diff changeset
30 ## When called with no output argument, or the @qcode{"-echo"} argument is
14018
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
31 ## given, then @var{text} is also sent to standard output.
19223
eeb2a01cdc26 doc: Improve docstrings for dos() and unix().
Rik <rik@octave.org>
parents: 17744
diff changeset
32 ## @seealso{dos, system, isunix, ismac, ispc}
4911
14027e0bafa4 [project @ 2004-07-22 19:58:06 by jwe]
jwe
parents: 4691
diff changeset
33 ## @end deftypefn
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
34
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
35 ## Author: octave-forge ???
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
36 ## Adapted by: jwe
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
37
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
38 function [status, text] = unix (command, echo_arg)
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
39
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
40 if (nargin < 1 || nargin > 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5659
diff changeset
41 print_usage ();
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
42 elseif (isunix ())
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
43 [status, text] = system (command);
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
44 if (nargin > 1 || nargout == 0)
21633
dcf8922b724b Deprecate printf, puts, and scanf. Make fputs a M-file.
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 20852
diff changeset
45 fprintf ("%s\n", text);
4691
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
46 endif
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
47 endif
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
48
bdc51b369a78 [project @ 2004-01-10 18:16:02 by jwe]
jwe
parents:
diff changeset
49 endfunction
14018
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
50
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
51
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
52 %!test
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
53 %! cmd = ls_command ();
20515
76f67400649e Use '-local' option to warning to simplify BIST tests.
Rik <rik@octave.org>
parents: 19697
diff changeset
54 %! warning ("off", "Octave:undefined-return-values", "local");
76f67400649e Use '-local' option to warning to simplify BIST tests.
Rik <rik@octave.org>
parents: 19697
diff changeset
55 %! [status, output] = unix (cmd);
14018
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
56 %!
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
57 %! if (isunix ())
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
58 %! assert (status, 0);
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
59 %! assert (ischar (output));
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
60 %! assert (! isempty (output));
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
61 %! else
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
62 %! assert (status, []);
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
63 %! assert (output, []);
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
64 %! endif
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
65
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
66 %!error unix ()
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
67 %!error unix (1, 2, 3)
5d5685216876 Deprecate shell_cmd function and update system, dos, unix commands
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
68