Mercurial > hg > octave-lyh

annotate scripts/help/help.m @ 17289:bc924baa2c4e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Add new @qcode macro for code samples which are quoted. Macro handles options ("on") or properties ("position") more elegantly than @code{"text"}. * doc/interpreter/macros.texi: Add new @qcode macro. * doc/interpreter/tips.txi: Add documentation about @qcode macro. * doc/interpreter/basics.txi, doc/interpreter/container.txi, doc/interpreter/emacs.txi, doc/interpreter/errors.txi, doc/interpreter/eval.txi, doc/interpreter/expr.txi, doc/interpreter/external.txi, doc/interpreter/func.txi, doc/interpreter/grammar.txi, doc/interpreter/image.txi, doc/interpreter/install.txi, doc/interpreter/interp.txi, doc/interpreter/io.txi, doc/interpreter/matrix.txi, doc/interpreter/numbers.txi, doc/interpreter/oop.txi, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/quad.txi, doc/interpreter/sparse.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m, scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m, scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m, scripts/general/dblquad.m, scripts/general/display.m, scripts/general/genvarname.m, scripts/general/idivide.m, scripts/general/interp1.m, scripts/general/interp2.m, scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m, scripts/general/profexplore.m, scripts/general/profile.m, scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m, scripts/general/subsindex.m, scripts/general/triplequad.m, scripts/geometry/griddata.m, scripts/geometry/griddata3.m, scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m, scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m, scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m, scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/java/javaclasspath.m, scripts/java/usejava.m, scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m, scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m, scripts/optimization/fminunc.m, scripts/optimization/fsolve.m, scripts/optimization/fzero.m, scripts/optimization/glpk.m, scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m, scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m, scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m, scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m, scripts/plot/plot.m, scripts/plot/print.m, scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m, scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m, scripts/polynomial/conv.m, scripts/polynomial/polyout.m, scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m, scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m, scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/periodogram.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m, scripts/specfun/legendre.m, scripts/special-matrix/gallery.m, scripts/statistics/base/mean.m, scripts/statistics/base/moment.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/kolmogorov_smirnov_test.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m, scripts/strings/index.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/validatestring.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m, scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m, scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m, scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m, scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
author Rik <rik@octave.org>
date Mon, 19 Aug 2013 20:46:38 -0700
parents f4c8c66faf34
children 1c89599167a6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17251
f4c8c66faf34 maint: Update source file encodings to UTF-8 and fix character errors
Mike Miller <mtmiller@ieee.org>
parents: 16994
diff changeset
1 ## Copyright (C) 2009-2012 Søren Hauberg
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
2 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10632
diff changeset
3 ## This file is part of Octave.
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10632
diff changeset
4 ##
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10632
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
8 ## your option) any later version.
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
9 ##
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10632
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
13 ## General Public License for more details.
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
14 ##
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
11104
2c356a35d7f5 fix copyright notices
John W. Eaton <jwe@octave.org>
parents: 10632
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
18
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
19 ## -*- texinfo -*-
12344
68ac95d2460c Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
20 ## @deftypefn {Command} {} help @var{name}
11567
5c18da80e28a doc fixes
John W. Eaton <jwe@octave.org>
parents: 11565
diff changeset
21 ## @deftypefnx {Command} {} help @code{--list}
15026
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
22 ## @deftypefnx {Command} {} help @code{.}
17289
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17251
diff changeset
23 ## Display the help text for @var{name}. For example, the command
11567
5c18da80e28a doc fixes
John W. Eaton <jwe@octave.org>
parents: 11565
diff changeset
24 ## @kbd{help help} prints a short message describing the @code{help}
5c18da80e28a doc fixes
John W. Eaton <jwe@octave.org>
parents: 11565
diff changeset
25 ## command.
11565
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
26 ##
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
27 ## Given the single argument @code{--list}, list all operators,
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
28 ## keywords, built-in functions, and loadable functions available
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
29 ## in the current session of Octave.
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
30 ##
15026
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
31 ## Given the single argument @code{.}, list all operators available
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
32 ## in the current session of Octave.
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
33 ##
11567
5c18da80e28a doc fixes
John W. Eaton <jwe@octave.org>
parents: 11565
diff changeset
34 ## If invoked without any arguments, @code{help} display instructions
5c18da80e28a doc fixes
John W. Eaton <jwe@octave.org>
parents: 11565
diff changeset
35 ## on how to access help from the command line.
11565
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
36 ##
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
37 ## The help command can give you information about operators, but not the
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
38 ## comma and semicolons that are used as command separators. To get help
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
39 ## for those, you must type @kbd{help comma} or @kbd{help semicolon}.
9133
c0cef1436788 Update help text for sections 2.2 and 2.3 of basics.txi
Rik <rdrider0-list@yahoo.com>
parents: 8768
diff changeset
40 ## @seealso{doc, lookfor, which}
10625
07933067e4ab help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
41 ## @end deftypefn
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
42
10632
69a715c81eab help.m: avoid unnecessary use of varargout
John W. Eaton <jwe@octave.org>
parents: 10625
diff changeset
43 function retval = help (name)
8748
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
44
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
45 if (nargin == 0)
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
46
15227
fbecbce45898 also return help text as a string when nargin = 0 (bug #37183)
John W. Eaton <jwe@octave.org>
parents: 15026
diff changeset
47 text = "\n\
8748
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
48 For help with individual commands and functions type\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
49 \n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
50 help NAME\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
51 \n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
52 (replace NAME with the name of the command or function you would\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
53 like to learn more about).\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
54 \n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
55 For a more detailed introduction to GNU Octave, please consult the\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
56 manual. To read the manual from the prompt type\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
57 \n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
58 doc\n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
59 \n\
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
60 GNU Octave is supported and developed by its user community.\n\
15227
fbecbce45898 also return help text as a string when nargin = 0 (bug #37183)
John W. Eaton <jwe@octave.org>
parents: 15026
diff changeset
61 For more information visit http://www.octave.org.\n\n";
fbecbce45898 also return help text as a string when nargin = 0 (bug #37183)
John W. Eaton <jwe@octave.org>
parents: 15026
diff changeset
62
fbecbce45898 also return help text as a string when nargin = 0 (bug #37183)
John W. Eaton <jwe@octave.org>
parents: 15026
diff changeset
63 if (nargout == 0)
fbecbce45898 also return help text as a string when nargin = 0 (bug #37183)
John W. Eaton <jwe@octave.org>
parents: 15026
diff changeset
64 puts (text);
fbecbce45898 also return help text as a string when nargin = 0 (bug #37183)
John W. Eaton <jwe@octave.org>
parents: 15026
diff changeset
65 else
fbecbce45898 also return help text as a string when nargin = 0 (bug #37183)
John W. Eaton <jwe@octave.org>
parents: 15026
diff changeset
66 retval = text;
fbecbce45898 also return help text as a string when nargin = 0 (bug #37183)
John W. Eaton <jwe@octave.org>
parents: 15026
diff changeset
67 endif
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
68
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
69 elseif (nargin == 1 && ischar (name))
8748
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
70
11565
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
71 if (strcmp (name, "--list"))
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
72 tmp = do_list_functions ();
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
73 if (nargout == 0)
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
74 printf ("%s", tmp);
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
75 else
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
76 retval = tmp;
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
77 endif
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
78 return;
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
79 endif
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
80
15026
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
81 if (strcmp (name, "."))
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
82 tmp = do_list_operators ();
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
83 if (nargout == 0)
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
84 printf ("%s", tmp);
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
85 else
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
86 retval = tmp;
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
87 endif
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
88 return;
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
89 endif
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
90
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
91 ## Get help text
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
92 [text, format] = get_help_text (name);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11567
diff changeset
93
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
94 ## Take action depending on help text format
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
95 switch (lower (format))
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
96 case "plain text"
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
97 status = 0;
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
98 case "texinfo"
8768
e0fbf17a17bb __makeinfo__.m: rename from makeinfo.m
John W. Eaton <jwe@octave.org>
parents: 8748
diff changeset
99 [text, status] = __makeinfo__ (text, "plain text");
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
100 case "html"
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
101 [text, status] = strip_html_tags (text);
8631
52956d669506 Display sensible error message when the help text of an undocumented function is requested
Soren Hauberg <hauberg@gmail.com>
parents: 8630
diff changeset
102 case "not documented"
15466
d174210ce1ec use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
103 error ("help: '%s' is not documented\n", name);
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
104 case "not found"
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
105 do_contents (name);
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10445
diff changeset
106 return;
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
107 otherwise
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
108 error ("help: internal error: unsupported help text format: '%s'\n", format);
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
109 endswitch
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11567
diff changeset
110
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
111 ## Print text
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
112 if (status != 0)
8768
e0fbf17a17bb __makeinfo__.m: rename from makeinfo.m
John W. Eaton <jwe@octave.org>
parents: 8748
diff changeset
113 warning ("help: Texinfo formatting filter exited abnormally; raw Texinfo source of help text follows...\n");
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
114 endif
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
115
10625
07933067e4ab help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
116 if (nargout == 0)
07933067e4ab help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
117 which (name);
07933067e4ab help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
118 printf ("\n%s\n%s", text, __additional_help_message__ ());
07933067e4ab help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
119 else
10632
69a715c81eab help.m: avoid unnecessary use of varargout
John W. Eaton <jwe@octave.org>
parents: 10625
diff changeset
120 retval = text;
10625
07933067e4ab help.m: Allow docstring to be returned as output, and correct docstring.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
121 endif
8748
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
122
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
123 else
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
124 error ("help: invalid input\n");
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
125 endif
8748
d1eed318100f help.m: shorten default help text
John W. Eaton <jwe@octave.org>
parents: 8746
diff changeset
126
8575
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
127 endfunction
f134925a1cfa m-file implementation of help system
Soren Hauberg <soren@hauberg.org>
parents:
diff changeset
128
15026
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
129 function retval = do_list_operators ()
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
130
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
131 retval = sprintf ("*** operators:\n\n%s\n\n",
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
132 list_in_columns (__operators__ ()));
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
133 endfunction
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
134
11565
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
135 function retval = do_list_functions ()
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
136
15026
ae42d5a67ed9 help.m: Added option '.' (dot); 'help .' lists all operators
Sergey Dudoladov <sergey.dudoladov@gmail.com>
parents: 14363
diff changeset
137 operators = do_list_operators ();
11565
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
138
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
139 keywords = sprintf ("*** keywords:\n\n%s\n\n",
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
140 list_in_columns (__keywords__ ()));
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
141
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
142 builtins = sprintf ("*** builtins:\n\n%s\n\n",
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
143 list_in_columns (__builtins__ ()));
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
144
16724
b7667fcb9fbc Substitute ostrsplit() for strsplit().
Ben Abbott <bpabbott@mac.com>
parents: 16403
diff changeset
145 dirs = ostrsplit (path, pathsep);
11565
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
146 flist = "";
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
147 for i = 2:numel (dirs)
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
148 files = sort ({dir(fullfile (dirs{i}, "*.m")).name, ...
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
149 dir(fullfile (dirs{i}, "*.oct")).name, ...
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
150 dir(fullfile (dirs{i}, "*.mex")).name});
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
151
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
152 if (! isempty (files))
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
153 flist = sprintf ("%s*** functions in %s:\n\n%s\n\n",
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
154 flist, dirs{i}, list_in_columns (files));
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
155 endif
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
156 endfor
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
157
16994
333243133364 Use matrix concatenation for strings, rather than cstrcat(), for clarity and performance.
Rik <rik@octave.org>
parents: 16724
diff changeset
158 retval = [operators, keywords, builtins, flist];
11565
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
159
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
160 endfunction
21c3e1370b82 implement --list option for help function
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
161
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
162 function do_contents (name)
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
163
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
164 found = false;
8630
540165304f00 Allow displaying 'Contents.m' files.
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
165
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
166 dlist = find_dir_in_path (name, "all");
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
167
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
168 for i = 1:numel (dlist)
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
169 fname = make_absolute_filename (fullfile (dlist{i}, "Contents.m"));
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
170
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
171 [text, format] = get_help_text_from_file (fname);
8630
540165304f00 Allow displaying 'Contents.m' files.
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
172
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
173 ## Take action depending on help text format
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
174 switch (lower (format))
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
175 case "plain text"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10445
diff changeset
176 status = 0;
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
177 case "texinfo"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10445
diff changeset
178 [text, status] = __makeinfo__ (text, "plain text");
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
179 case "html"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10445
diff changeset
180 [text, status] = strip_html_tags (text);
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
181 endswitch
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
182
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
183 if (! isempty (text))
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
184 found = true;
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
185 ## Print text.
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
186 if (status != 0)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10445
diff changeset
187 warning ("help: Texinfo formatting filter exited abnormally; raw Texinfo source of help text follows...\n");
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
188 endif
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
189 printf ("%s:\n\n%s\n", fname, text);
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
190 endif
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
191
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
192 endfor
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
193
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
194 if (found)
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
195 puts (__additional_help_message__ ());
10445
62f8ae5ab2cc warn about missing matlab funcs in help
Jaroslav Hajek <highegg@gmail.com>
parents: 9806
diff changeset
196 else
11215
8b2a47a99701 help: print message if function not found
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
197 msg = feval (missing_function_hook, name);
8b2a47a99701 help: print message if function not found
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
198
8b2a47a99701 help: print message if function not found
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
199 if (isempty (msg))
15466
d174210ce1ec use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
200 msg = sprintf ("'%s' not found", name);
11215
8b2a47a99701 help: print message if function not found
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
201 endif
8b2a47a99701 help: print message if function not found
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
202
8b2a47a99701 help: print message if function not found
John W. Eaton <jwe@octave.org>
parents: 11104
diff changeset
203 error ("help: %s\n", msg);
8630
540165304f00 Allow displaying 'Contents.m' files.
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
204 endif
9806
8e345f2fe4d6 improved support for Contents.m files
John W. Eaton <jwe@octave.org>
parents: 9724
diff changeset
205
8630
540165304f00 Allow displaying 'Contents.m' files.
Soren Hauberg <hauberg@gmail.com>
parents: 8575
diff changeset
206 endfunction
13763
85d63b6e49cf help.m: Add functional tests
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
207
85d63b6e49cf help.m: Add functional tests
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
208
14214
2fe0f5fa8cc3 Replace to-be-deprecated findstr occurrences with strfind.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
209 %!assert (! isempty (strfind (help ("ls"), "List directory contents")))
13763
85d63b6e49cf help.m: Add functional tests
Rik <octave@nomad.inbox5.com>
parents: 12344
diff changeset
210 %!error <invalid input> help (42)
14214
2fe0f5fa8cc3 Replace to-be-deprecated findstr occurrences with strfind.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
211
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14214
diff changeset
212