octave-nkf: src/help.cc annotate

annotate src/help.cc @ 8812:7d48766c21a5

use consistent format for doc strings of internal functions

author	John W. Eaton <jwe@octave.org>
date	Thu, 19 Feb 2009 02:16:34 -0500
parents	2a49c32d4322
children	31f864877246

rev	line source
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	1 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	2
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	3 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	4 2002, 2003, 2004, 2005, 2006, 2007 John W. Eaton
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	5
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	6 This file is part of Octave.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	7
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	8 Octave is free software; you can redistribute it and/or modify it
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	9 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	11 option) any later version.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	12
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	13 Octave is distributed in the hope that it will be useful, but WITHOUT
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	16 for more details.
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	17
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	18 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: 7001 diff changeset	19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	20 <http://www.gnu.org/licenses/>.
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	21
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	22 */
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	23
240 a99f28f5e351 [project @ 1993-11-30 20:24:36 by jwe] jwe parents: 1 diff changeset	24 #ifdef HAVE_CONFIG_H
1192 b6360f2d4fa6 [project @ 1995-03-30 21:38:35 by jwe] jwe parents: 1155 diff changeset	25 #include <config.h>
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	26 #endif
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	27
1343 94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1315 diff changeset	28 #include <cstdlib>
94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1315 diff changeset	29 #include <cstring>
94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1315 diff changeset	30
5769 2b9a5ce46678 [project @ 2006-04-18 15:57:06 by jwe] jwe parents: 5768 diff changeset	31 #include <algorithm>
3503 d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe] jwe parents: 3408 diff changeset	32 #include <iostream>
d14c483b3c12 [project @ 2000-02-01 04:06:07 by jwe] jwe parents: 3408 diff changeset	33 #include <fstream>
5765 7ba9ad1fec11 [project @ 2006-04-17 05:05:15 by jwe] jwe parents: 5738 diff changeset	34 #include <sstream>
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	35 #include <string>
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	36
1350 5f63d83dd694 [project @ 1995-09-05 07:37:59 by jwe] jwe parents: 1343 diff changeset	37 #ifdef HAVE_UNISTD_H
2442 f667d7ec08b9 [project @ 1996-10-30 18:46:22 by jwe] jwe parents: 2371 diff changeset	38 #ifdef HAVE_SYS_TYPES_H
1295 34295bf6aac6 [project @ 1995-05-01 18:24:48 by jwe] jwe parents: 1288 diff changeset	39 #include <sys/types.h>
2442 f667d7ec08b9 [project @ 1996-10-30 18:46:22 by jwe] jwe parents: 2371 diff changeset	40 #endif
1295 34295bf6aac6 [project @ 1995-05-01 18:24:48 by jwe] jwe parents: 1288 diff changeset	41 #include <unistd.h>
34295bf6aac6 [project @ 1995-05-01 18:24:48 by jwe] jwe parents: 1288 diff changeset	42 #endif
1343 94bedeb289e5 [project @ 1995-09-04 00:29:21 by jwe] jwe parents: 1315 diff changeset	43
3295 35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	44 #include "cmd-edit.h"
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	45 #include "file-ops.h"
6253 f1676652d808 [project @ 2007-01-24 20:43:36 by jwe] jwe parents: 6243 diff changeset	46 #include "file-stat.h"
2926 66ef74ee5d9f [project @ 1997-05-05 03:20:52 by jwe] jwe parents: 2900 diff changeset	47 #include "oct-env.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	48 #include "str-vec.h"
3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	49
2492 06595bc7f2d0 [project @ 1996-11-09 00:13:50 by jwe] jwe parents: 2470 diff changeset	50 #include <defaults.h>
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	51 #include "defun.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	52 #include "dirfns.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	53 #include "error.h"
2202 31b62b7c5d2d [project @ 1996-05-15 06:07:11 by jwe] jwe parents: 2189 diff changeset	54 #include "gripes.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	55 #include "help.h"
2177 0bddc913621b [project @ 1996-05-13 16:36:11 by jwe] jwe parents: 2124 diff changeset	56 #include "input.h"
5832 5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe] jwe parents: 5823 diff changeset	57 #include "load-path.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	58 #include "oct-obj.h"
2976 641689f67673 [project @ 1997-05-15 20:27:04 by jwe] jwe parents: 2962 diff changeset	59 #include "ov-usr-fcn.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	60 #include "pager.h"
3018 5708b8bb4f06 [project @ 1997-06-03 21:48:05 by jwe] jwe parents: 3016 diff changeset	61 #include "parse.h"
1466 2f85a175308f [project @ 1995-09-22 07:48:59 by jwe] jwe parents: 1443 diff changeset	62 #include "pathsearch.h"
3295 35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	63 #include "procstream.h"
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	64 #include "pt-pr-code.h"
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	65 #include "sighandlers.h"
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	66 #include "symtab.h"
2694 13f134a00f12 [project @ 1997-02-18 15:33:28 by jwe] jwe parents: 2692 diff changeset	67 #include "syswait.h"
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	68 #include "toplev.h"
8672 2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	69 #include "unwind-prot.h"
242 742c4795aea9 [project @ 1993-11-30 21:26:43 by jwe] jwe parents: 240 diff changeset	70 #include "utils.h"
1352 19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe] jwe parents: 1350 diff changeset	71 #include "variables.h"
3301 02866242d3ae [project @ 1999-10-20 04:10:46 by jwe] jwe parents: 3296 diff changeset	72 #include "version.h"
5447 051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	73 #include "quit.h"
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	74
2202 31b62b7c5d2d [project @ 1996-05-15 06:07:11 by jwe] jwe parents: 2189 diff changeset	75 // Name of the info file specified on command line.
31b62b7c5d2d [project @ 1996-05-15 06:07:11 by jwe] jwe parents: 2189 diff changeset	76 // (--info-file file)
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3503 diff changeset	77 std::string Vinfo_file;
2202 31b62b7c5d2d [project @ 1996-05-15 06:07:11 by jwe] jwe parents: 2189 diff changeset	78
31b62b7c5d2d [project @ 1996-05-15 06:07:11 by jwe] jwe parents: 2189 diff changeset	79 // Name of the info reader we'd like to use.
31b62b7c5d2d [project @ 1996-05-15 06:07:11 by jwe] jwe parents: 2189 diff changeset	80 // (--info-program program)
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	81 std::string Vinfo_program;
2202 31b62b7c5d2d [project @ 1996-05-15 06:07:11 by jwe] jwe parents: 2189 diff changeset	82
3686 9507d6de9bbd [project @ 2000-06-29 16:30:44 by jwe] jwe parents: 3584 diff changeset	83 // Name of the makeinfo program to run.
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	84 static std::string Vmakeinfo_program = "makeinfo";
3686 9507d6de9bbd [project @ 2000-06-29 16:30:44 by jwe] jwe parents: 3584 diff changeset	85
2189 d01936305d99 [project @ 1996-05-14 03:31:57 by jwe] jwe parents: 2177 diff changeset	86 // If TRUE, don't print additional help message in help and usage
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe] jwe parents: 2177 diff changeset	87 // functions.
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	88 static bool Vsuppress_verbose_help_message = false;
2189 d01936305d99 [project @ 1996-05-14 03:31:57 by jwe] jwe parents: 2177 diff changeset	89
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	90 #include <map>
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	91
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	92 typedef std::map<std::string, std::string> map_type;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	93 typedef map_type::value_type pair_type;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	94 typedef map_type::const_iterator map_iter;
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	95
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	96 template<typename T, std::size_t z>
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	97 std::size_t
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	98 size (T const (&)[z])
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	99 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	100 return z;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	101 }
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	102
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	103 // FIXME -- The descriptions could easily be in texinfo -- should they?
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	104 const static pair_type operators[] =
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	105 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	106 pair_type ("!",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	107 "Logical not operator. See also `~'.\n"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	108
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	109 pair_type ("!=",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	110 "Logical not equals operator. See also `~='.\n"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	111
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	112 pair_type ("\"",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	113 "String delimiter.\n"),
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	114
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	115 pair_type ("#",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	116 "Begin comment character. See also `%'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	117
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	118 pair_type ("%",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	119 "Begin comment charcter. See also `#'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	120
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	121 pair_type ("&",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	122 "Element by element logical and operator. See also `&&'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	123
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	124 pair_type ("&&",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	125 "Logical and operator (with short-circuit evaluation). See also `&'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	126
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	127 pair_type ("'",
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	128 "Matrix transpose operator. For complex matrices, computes the\n\
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	129 complex conjugate (Hermitian) transpose. See also `.''\n\
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	130 \n\
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	131 The single quote character may also be used to delimit strings, but\n\
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	132 it is better to use the double quote character, since that is never\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	133 ambiguous"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	134
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	135 pair_type ("(",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	136 "Array index or function argument delimiter."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	137
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	138 pair_type (")",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	139 "Array index or function argument delimiter."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	140
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	141 pair_type ("*",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	142 "Multiplication operator. See also `.*'"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	143
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	144 pair_type ("**",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	145 "Power operator. See also `^', `.**', and `.^'"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	146
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	147 pair_type ("+",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	148 "Addition operator."),
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	149
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	150 pair_type ("++",
5339 4266ef7972b2 [project @ 2005-05-05 19:06:25 by jwe] jwe parents: 5307 diff changeset	151 "Increment operator. As in C, may be applied as a prefix or postfix\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	152 operator."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	153
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	154 pair_type (",",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	155 "Array index, function argument, or command separator."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	156
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	157 pair_type ("-",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	158 "Subtraction or unary negation operator."),
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	159
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	160 pair_type ("--",
5339 4266ef7972b2 [project @ 2005-05-05 19:06:25 by jwe] jwe parents: 5307 diff changeset	161 "Decrement operator. As in C, may be applied as a prefix or postfix\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	162 operator."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	163
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	164 pair_type (".'",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	165 "Matrix transpose operator. For complex matrices, computes the\n\
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	166 transpose, not the complex conjugate transpose. See also `''."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	167
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	168 pair_type (".*",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	169 "Element by element multiplication operator. See also `*'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	170
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	171 pair_type (".**",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	172 "Element by element power operator. See also `**', `^', and `.^'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	173
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	174 pair_type ("./",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	175 "Element by element division operator. See also `/' and `\\'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	176
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	177 pair_type (".^",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	178 "Element by element power operator. See also `**', `^', and `.^'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	179
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	180 pair_type ("/",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	181 "Right division. See also `\\' and `./'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	182
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	183 pair_type (":",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	184 "Select entire rows or columns of matrices."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	185
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	186 pair_type (";",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	187 "Array row or command separator. See also `,'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	188
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	189 pair_type ("<",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	190 "Less than operator."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	191
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	192 pair_type ("<=",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	193 "Less than or equals operator."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	194
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	195 pair_type ("=",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	196 "Assignment operator."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	197
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	198 pair_type ("==",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	199 "Equality test operator."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	200
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	201 pair_type (">",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	202 "Greater than operator."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	203
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	204 pair_type (">=",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	205 "Greater than or equals operator."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	206
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	207 pair_type ("[",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	208 "Return list delimiter. See also `]'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	209
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	210 pair_type ("\\",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	211 "Left division operator. See also `/' and `./'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	212
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	213 pair_type ("]",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	214 "Return list delimiter. See also `['."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	215
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	216 pair_type ("^",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	217 "Power operator. See also `', `.^', and `..'"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	218
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	219 pair_type ("\|",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	220 "Element by element logical or operator. See also `\|\|'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	221
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	222 pair_type ("\|\|",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	223 "Logical or operator (with short-circuit evaluation). See also `\|'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	224
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	225 pair_type ("~",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	226 "Logical not operator. See also `!' and `~'."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	227
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	228 pair_type ("~=",
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	229 "Logical not equals operator. See also `!='."),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	230 };
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	231
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	232 const static pair_type keywords[] =
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	233 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	234 pair_type ("break",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	235 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	236 @deffn Keyword break\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	237 Exit the innermost enclosing do, while or for loop.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	238 @seealso{do, while, for, continue}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	239 @end deffn"),
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4686 diff changeset	240
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	241 pair_type ("case",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	242 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	243 @deffn Keyword case @{@var{value}@}\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	244 A case statement in an switch. Octave cases are exclusive and do not\n\
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4686 diff changeset	245 fall-through as do C-language cases. A switch statement must have at least\n\
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	246 one case. See @code{switch} for an example.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	247 @seealso{switch}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	248 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	249
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	250 pair_type ("catch",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	251 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	252 @deffn Keyword catch\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	253 Begin the cleanup part of a try-catch block.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	254 @seealso{try}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	255 @end deffn"),
1489 3e705c864019 [project @ 1995-09-28 05:38:26 by jwe] jwe parents: 1488 diff changeset	256
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	257 pair_type ("continue",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	258 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	259 @deffn Keyword continue\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	260 Jump to the end of the innermost enclosing do, while or for loop.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	261 @seealso{do, while, for, break}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	262 @end deffn"),
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4686 diff changeset	263
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	264 pair_type ("do",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	265 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	266 @deffn Keyword do\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	267 Begin a do-until loop. This differs from a do-while loop in that the\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	268 body of the loop is executed at least once.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	269 @seealso{while}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	270 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	271
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	272 pair_type ("else",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	273 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	274 @deffn Keyword else\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	275 Alternate action for an if block. See @code{if} for an example.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	276 @seealso{if}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	277 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	278
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	279 pair_type ("elseif",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	280 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	281 @deffn Keyword elseif (@var{condition})\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	282 Alternate conditional test for an if block. See @code{if} for an example.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	283 @seealso{if}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	284 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	285
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	286 pair_type ("end",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	287 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	288 @deffn Keyword end\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	289 Mark the end of any @code{for}, @code{if}, @code{do}, @code{while}, or @code{function} block.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	290 @seealso{for, if, do, while, function}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	291 @end deffn"),
928 2f91e7098f8c [project @ 1994-11-15 21:53:40 by jwe] jwe parents: 867 diff changeset	292
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	293 pair_type ("end_try_catch",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	294 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	295 @deffn Keyword end_try_catch\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	296 Mark the end of an @code{try-catch} block.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	297 @seealso{try, catch}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	298 @end deffn"),
1489 3e705c864019 [project @ 1995-09-28 05:38:26 by jwe] jwe parents: 1488 diff changeset	299
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	300 pair_type ("end_unwind_protect",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	301 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	302 @deffn Keyword end_unwind_protect\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	303 Mark the end of an unwind_protect block.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	304 @seealso{unwind_protect}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	305 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	306
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	307 pair_type ("endfor",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	308 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	309 @deffn Keyword endfor\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	310 Mark the end of a for loop. See @code{for} for an example.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	311 @seealso{for}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	312 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	313
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	314 pair_type ("endfunction",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	315 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	316 @deffn Keyword endfunction\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	317 Mark the end of a function.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	318 @seealso{function}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	319 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	320
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	321 pair_type ("endif",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	322 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	323 @deffn Keyword endif\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	324 Mark the end of an if block. See @code{if} for an example.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	325 @seealso{if}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	326 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	327
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	328 pair_type ("endswitch",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	329 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	330 @deffn Keyword endswitch\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	331 Mark the end of a switch block. See @code{switch} for an example.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	332 @seealso{switch}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	333 @end deffn"),
5122 695509577dc6 [project @ 2005-01-26 22:15:11 by jwe] jwe parents: 5041 diff changeset	334
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	335 pair_type ("endwhile",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	336 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	337 @deffn Keyword endwhile\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	338 Mark the end of a while loop. See @code{while} for an example.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	339 @seealso{do, while}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	340 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	341
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	342 pair_type ("for",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	343 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	344 @deffn Keyword for @var{i} = @var{range}\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	345 Begin a for loop.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	346 @example\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	347 for i = 1:10\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	348 i\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	349 endfor\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	350 @end example\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	351 @seealso{do, while}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	352 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	353
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	354 pair_type ("function",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	355 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	356 @deffn Keyword function @var{outputs} = function (@var{input}, ...)\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	357 @deffnx Keyword function {} function (@var{input}, ...)\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	358 @deffnx Keyword function @var{outputs} = function\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	359 Begin a function body with @var{outputs} as results and @var{inputs} as\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	360 parameters.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	361 @seealso{return}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	362 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	363
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	364 pair_type ("global",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	365 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	366 @deffn Keyword global\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	367 Declare variables to have global scope.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	368 @example\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	369 global @var{x};\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	370 if isempty (@var{x})\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	371 x = 1;\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	372 endif\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	373 @end example\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	374 @seealso{persistent}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	375 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	376
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	377 pair_type ("if",
5393 c8783205a7c6 [project @ 2005-06-15 17:03:54 by jwe] jwe parents: 5339 diff changeset	378 "-- texinfo --\n\
c8783205a7c6 [project @ 2005-06-15 17:03:54 by jwe] jwe parents: 5339 diff changeset	379 @deffn Keyword if (@var{cond}) @dots{} endif\n\
c8783205a7c6 [project @ 2005-06-15 17:03:54 by jwe] jwe parents: 5339 diff changeset	380 @deffnx Keyword if (@var{cond}) @dots{} else @dots{} endif\n\
c8783205a7c6 [project @ 2005-06-15 17:03:54 by jwe] jwe parents: 5339 diff changeset	381 @deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} endif\n\
c8783205a7c6 [project @ 2005-06-15 17:03:54 by jwe] jwe parents: 5339 diff changeset	382 @deffnx Keyword if (@var{cond}) @dots{} elseif (@var{cond}) @dots{} else @dots{} endif\n\
c8783205a7c6 [project @ 2005-06-15 17:03:54 by jwe] jwe parents: 5339 diff changeset	383 Begin an if block.\n\
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	384 @example\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	385 x = 1;\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	386 if (x == 1)\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	387 disp (\"one\");\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	388 elseif (x == 2)\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	389 disp (\"two\");\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	390 else\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	391 disp (\"not one or two\");\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	392 endif\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	393 @end example\n\
5646 2b20d1707f29 [project @ 2006-03-06 22:38:32 by jwe] jwe parents: 5644 diff changeset	394 @seealso{switch}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	395 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	396
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	397 pair_type ("otherwise",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	398 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	399 @deffn Keyword otherwise\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	400 The default statement in a switch block (similar to else in an if block).\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	401 @seealso{switch}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	402 @end deffn"),
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4686 diff changeset	403
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	404 pair_type ("persistent",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	405 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	406 @deffn Keyword persistent @var{var}\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	407 Declare variables as persistent. A variable that has been declared\n\
5623 691de3e3c2f8 [project @ 2006-02-15 18:32:32 by jwe] jwe parents: 5594 diff changeset	408 persistent within a function will retain its contents in memory between\n\
691de3e3c2f8 [project @ 2006-02-15 18:32:32 by jwe] jwe parents: 5594 diff changeset	409 subsequent calls to the same function. The difference between persistent\n\
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	410 variables and global variables is that persistent variables are local in \n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	411 scope to a particular function and are not visible elsewhere.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	412 @seealso{global}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	413 @end deffn"),
4686 c7ae43dfdea4 [project @ 2004-01-06 19:29:23 by jwe] jwe parents: 4469 diff changeset	414
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	415 pair_type ("replot",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	416 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	417 @deffn Keyword replot\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	418 Replot a graphic.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	419 @seealso{plot}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	420 @end deffn"),
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4686 diff changeset	421
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	422 pair_type ("return",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	423 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	424 @deffn Keyword return\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	425 Return from a function.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	426 @seealso{function}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	427 @end deffn"),
928 2f91e7098f8c [project @ 1994-11-15 21:53:40 by jwe] jwe parents: 867 diff changeset	428
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	429 pair_type ("static",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	430 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	431 @deffn Keyword static\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	432 This function has been deprecated in favor of persistent.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	433 @seealso{persistent}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	434 @end deffn"),
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4686 diff changeset	435
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	436 pair_type ("switch",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	437 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	438 @deffn Keyword switch @var{statement}\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	439 Begin a switch block.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	440 @example\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	441 yesno = \"yes\"\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	442 \n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	443 switch yesno\n\
5832 5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe] jwe parents: 5823 diff changeset	444 case @{\"Yes\" \"yes\" \"YES\" \"y\" \"Y\"@}\n\
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	445 value = 1;\n\
5832 5e41e06f6a78 [project @ 2006-05-26 21:41:32 by jwe] jwe parents: 5823 diff changeset	446 case @{\"No\" \"no\" \"NO\" \"n\" \"N\"@}\n\
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	447 value = 0;\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	448 otherwise\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	449 error (\"invalid value\");\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	450 endswitch\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	451 @end example\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	452 @seealso{if, case, otherwise}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	453 @end deffn"),
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4686 diff changeset	454
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	455 pair_type ("try",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	456 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	457 @deffn Keyword try\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	458 Begin a try-catch block.\n\
6138 c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	459 \n\
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	460 If an error occurs within a try block, then the catch code will be run and\n\
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	461 execution will proceed after the catch block (though it is often\n\
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	462 recommended to use the lasterr function to re-throw the error after cleanup\n\
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	463 is completed).\n\
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	464 @seealso{catch,unwind_protect}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	465 @end deffn"),
1489 3e705c864019 [project @ 1995-09-28 05:38:26 by jwe] jwe parents: 1488 diff changeset	466
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	467 pair_type ("until",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	468 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	469 @deffn Keyword until\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	470 End a do-until loop.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	471 @seealso{do}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	472 @end deffn"),
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4686 diff changeset	473
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	474 pair_type ("unwind_protect",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	475 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	476 @deffn Keyword unwind_protect\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	477 Begin an unwind_protect block.\n\
6138 c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	478 \n\
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	479 If an error occurs within the first part of an unwind_protect block\n\
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	480 the commands within the unwind_protect_cleanup block are executed before\n\
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	481 the error is thrown. If an error is not thrown, then the\n\
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	482 unwind_protect_cleanup block is still executed (in other words, the\n\
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	483 unwind_protect_cleanup will be run with or without an error in the\n\
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	484 unwind_protect block).\n\
c5874b47d571 [project @ 2006-11-03 18:26:11 by jwe] jwe parents: 6099 diff changeset	485 @seealso{unwind_protect_cleanup,try}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	486 @end deffn"),
928 2f91e7098f8c [project @ 1994-11-15 21:53:40 by jwe] jwe parents: 867 diff changeset	487
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	488 pair_type ("unwind_protect_cleanup",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	489 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	490 @deffn Keyword unwind_protect_cleanup\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	491 Begin the cleanup section of an unwind_protect block.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	492 @seealso{unwind_protect}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	493 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	494
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	495 pair_type ("varargin",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	496 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	497 @deffn Keyword varargin\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	498 Pass an arbitrary number of arguments into a function.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	499 @seealso{varargout, nargin, nargout}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	500 @end deffn"),
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4686 diff changeset	501
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	502 pair_type ("varargout",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	503 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	504 @deffn Keyword varargout\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	505 Pass an arbitrary number of arguments out of a function.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	506 @seealso{varargin, nargin, nargout}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	507 @end deffn"),
5040 b6ff3a0d3d17 [project @ 2004-09-27 13:50:01 by jwe] jwe parents: 4686 diff changeset	508
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	509 pair_type ("while",
5818 66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	510 "-- texinfo --\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	511 @deffn Keyword while\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	512 Begin a while loop.\n\
66a426e608cc [project @ 2006-05-17 16:45:41 by jwe] jwe parents: 5814 diff changeset	513 @seealso{do}\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	514 @end deffn"),
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	515 };
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	516
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	517 // Return a copy of the operator or keyword names.
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	518 static string_vector
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	519 names (const map_type& lst)
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	520 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	521 string_vector retval (lst.size ());
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	522 int j = 0;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	523 for (map_iter iter = lst.begin (); iter != lst.end (); iter ++)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	524 retval [j++] = iter->first;
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	525 return retval;
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	526 }
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	527
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	528 const static map_type operators_map (operators, operators + size (operators));
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	529 const static map_type keywords_map (keywords, keywords + size (keywords));
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	530 const static string_vector keyword_names = names (keywords_map);
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	531
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	532 // FIXME -- It's not likely that this does the right thing now.
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	533
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	534 string_vector
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	535 make_name_list (void)
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	536 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	537 const int key_len = keyword_names.length ();
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	538
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	539 const string_vector bif = symbol_table::built_in_function_names ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	540 const int bif_len = bif.length ();
4009 27e461aed956 [project @ 2002-07-31 09:33:03 by jwe] jwe parents: 3917 diff changeset	541
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7438 diff changeset	542 // FIXME -- is this really necessary here?
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	543 const string_vector glb = symbol_table::global_variable_names ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	544 const int glb_len = glb.length ();
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	545
7752 40c428ea3408 initial implementation of dbup and dbdown John W. Eaton <jwe@octave.org> parents: 7438 diff changeset	546 // FIXME -- is this really necessary here?
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	547 const string_vector top = symbol_table::top_level_variable_names ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	548 const int top_len = top.length ();
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	549
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	550 string_vector lcl;
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	551 if (! symbol_table::at_top_level ())
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	552 lcl = symbol_table::variable_names ();
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	553 const int lcl_len = lcl.length ();
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	554
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	555 const string_vector ffl = load_path::fcn_names ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	556 const int ffl_len = ffl.length ();
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	557
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	558 const string_vector afl = autoloaded_functions ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	559 const int afl_len = afl.length ();
5592 61d6cebd243b [project @ 2006-01-12 17:55:22 by dbateman] dbateman parents: 5576 diff changeset	560
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	561 const int total_len = key_len + bif_len + glb_len + top_len + lcl_len
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	562 + ffl_len + afl_len;
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	563
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	564 string_vector list (total_len);
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	565
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	566 // Put all the symbols in one big list.
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	567
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	568 int j = 0;
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	569 int i = 0;
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	570 for (i = 0; i < key_len; i++)
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	571 list[j++] = keyword_names[i];
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	572
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	573 for (i = 0; i < bif_len; i++)
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	574 list[j++] = bif[i];
4009 27e461aed956 [project @ 2002-07-31 09:33:03 by jwe] jwe parents: 3917 diff changeset	575
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	576 for (i = 0; i < glb_len; i++)
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	577 list[j++] = glb[i];
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	578
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	579 for (i = 0; i < top_len; i++)
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	580 list[j++] = top[i];
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	581
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	582 for (i = 0; i < lcl_len; i++)
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	583 list[j++] = lcl[i];
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	584
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	585 for (i = 0; i < ffl_len; i++)
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	586 list[j++] = ffl[i];
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	587
5592 61d6cebd243b [project @ 2006-01-12 17:55:22 by dbateman] dbateman parents: 5576 diff changeset	588 for (i = 0; i < afl_len; i++)
61d6cebd243b [project @ 2006-01-12 17:55:22 by dbateman] dbateman parents: 5576 diff changeset	589 list[j++] = afl[i];
61d6cebd243b [project @ 2006-01-12 17:55:22 by dbateman] dbateman parents: 5576 diff changeset	590
3016 f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	591 return list;
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	592 }
f512c16826d1 [project @ 1997-06-03 03:16:13 by jwe] jwe parents: 3014 diff changeset	593
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	594 static bool
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	595 looks_like_html (const std::string& msg)
3014 38de16594cb4 [project @ 1997-06-02 20:28:09 by jwe] jwe parents: 3013 diff changeset	596 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	597 const size_t p1 = msg.find ('\n');
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	598 std::string t = msg.substr (0, p1);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	599 const size_t p2 = t.find ("<html"); // FIXME: this comparison should be case-insensitive
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	600
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	601 return (p2 != std::string::npos);
2470 1e673f0648b5 [project @ 1996-11-05 21:46:06 by jwe] jwe parents: 2442 diff changeset	602 }
3014 38de16594cb4 [project @ 1997-06-02 20:28:09 by jwe] jwe parents: 3013 diff changeset	603
38de16594cb4 [project @ 1997-06-02 20:28:09 by jwe] jwe parents: 3013 diff changeset	604 static bool
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3503 diff changeset	605 looks_like_texinfo (const std::string& msg, size_t& p1)
3295 35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	606 {
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	607 p1 = msg.find ('\n');
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	608
3523 b80bbb43a1a9 [project @ 2000-02-02 10:25:52 by jwe] jwe parents: 3503 diff changeset	609 std::string t = msg.substr (0, p1);
3295 35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	610
8021 85184151822e fix typo in NPOS change John W. Eaton <jwe@octave.org> parents: 8019 diff changeset	611 if (p1 == std::string::npos)
3295 35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	612 p1 = 0;
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	613
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	614 size_t p2 = t.find ("-- texinfo --");
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	615
8021 85184151822e fix typo in NPOS change John W. Eaton <jwe@octave.org> parents: 8019 diff changeset	616 return (p2 != std::string::npos);
3295 35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	617 }
35a6d027772c [project @ 1999-10-19 10:13:02 by jwe] jwe parents: 3259 diff changeset	618
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	619 static bool
6243 7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	620 raw_help_from_symbol_table (const std::string& nm, std::string& h,
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	621 std::string& w, bool& symbol_found)
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	622 {
c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	623 bool retval = false;
c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	624
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	625 octave_value val = symbol_table::find_function (nm);
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	626
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	627 if (val.is_defined ())
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	628 {
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	629 octave_function *fcn = val.function_value ();
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	630
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	631 if (fcn)
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	632 {
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	633 symbol_found = true;
5399 db34dff19947 [project @ 2005-06-17 21:16:20 by jwe] jwe parents: 5393 diff changeset	634
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	635 h = fcn->doc_string ();
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	636
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	637 retval = true;
52956d669506 Display sensible error message when the help text of an undocumented function is requested Soren Hauberg <hauberg@gmail.com> parents: 8630 diff changeset	638
52956d669506 Display sensible error message when the help text of an undocumented function is requested Soren Hauberg <hauberg@gmail.com> parents: 8630 diff changeset	639 w = fcn->fcn_file_name ();
6243 7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	640
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	641 if (w.empty ())
52956d669506 Display sensible error message when the help text of an undocumented function is requested Soren Hauberg <hauberg@gmail.com> parents: 8630 diff changeset	642 w = fcn->is_user_function ()
52956d669506 Display sensible error message when the help text of an undocumented function is requested Soren Hauberg <hauberg@gmail.com> parents: 8630 diff changeset	643 ? "command-line function" : "built-in function";
6243 7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	644 }
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	645 }
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	646
6243 7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	647 return retval;
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	648 }
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	649
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	650 static bool
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	651 raw_help_from_file (const std::string& nm, std::string& h,
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	652 std::string& file, bool& symbol_found)
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	653 {
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	654 bool retval = false;
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	655
8672 2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	656 // FIXME -- this is a bit of a kluge...
2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	657 unwind_protect_bool (reading_script_file);
2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	658 reading_script_file = true;
2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	659
6243 7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	660 h = get_help_from_file (nm, symbol_found, file);
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	661
8672 2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	662 unwind_protect::run ();
2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	663
6243 7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	664 if (h.length () > 0)
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	665 retval = true;
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	666
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	667 return retval;
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	668 }
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	669
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	670 static bool
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	671 raw_help_from_map (const std::string& nm, std::string& h,
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	672 const map_type& map, bool& symbol_found)
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	673 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	674 map_iter idx = map.find (nm);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	675 symbol_found = (idx != map.end ());
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	676 h = (symbol_found) ? idx->second : "";
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	677 return symbol_found;
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	678 }
c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	679
6243 7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	680 std::string
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	681 raw_help (const std::string& nm, bool& symbol_found)
6243 7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	682 {
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	683 std::string h;
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	684 std::string w;
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	685 std::string f;
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	686
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	687 (raw_help_from_symbol_table (nm, h, w, symbol_found)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	688 \|\| raw_help_from_file (nm, h, f, symbol_found)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	689 \|\| raw_help_from_map (nm, h, operators_map, symbol_found)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	690 \|\| raw_help_from_map (nm, h, keywords_map, symbol_found));
6243 7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	691
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	692 return h;
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	693 }
7924a9086c08 [project @ 2007-01-17 21:47:50 by jwe] jwe parents: 6138 diff changeset	694
1140 26d986865487 [project @ 1995-02-26 03:23:43 by jwe] jwe parents: 1118 diff changeset	695 static void
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	696 do_get_help_text (const std::string name, std::string& text,
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	697 std::string& format)
1140 26d986865487 [project @ 1995-02-26 03:23:43 by jwe] jwe parents: 1118 diff changeset	698 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	699 bool symbol_found = false;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	700 text = raw_help (name, symbol_found);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	701
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	702 format = "Not found";
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	703 if (symbol_found)
1140 26d986865487 [project @ 1995-02-26 03:23:43 by jwe] jwe parents: 1118 diff changeset	704 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	705 size_t idx = -1;
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	706 if (text.empty ())
52956d669506 Display sensible error message when the help text of an undocumented function is requested Soren Hauberg <hauberg@gmail.com> parents: 8630 diff changeset	707 {
52956d669506 Display sensible error message when the help text of an undocumented function is requested Soren Hauberg <hauberg@gmail.com> parents: 8630 diff changeset	708 format = "Not documented";
52956d669506 Display sensible error message when the help text of an undocumented function is requested Soren Hauberg <hauberg@gmail.com> parents: 8630 diff changeset	709 }
52956d669506 Display sensible error message when the help text of an undocumented function is requested Soren Hauberg <hauberg@gmail.com> parents: 8630 diff changeset	710 else if (looks_like_texinfo (text, idx))
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	711 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	712 format = "texinfo";
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	713 text.erase (0, idx);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	714 }
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	715 else if (looks_like_html (text))
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	716 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	717 format = "html";
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	718 }
5399 db34dff19947 [project @ 2005-06-17 21:16:20 by jwe] jwe parents: 5393 diff changeset	719 else
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	720 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	721 format = "plain text";
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	722 }
1140 26d986865487 [project @ 1995-02-26 03:23:43 by jwe] jwe parents: 1118 diff changeset	723 }
26d986865487 [project @ 1995-02-26 03:23:43 by jwe] jwe parents: 1118 diff changeset	724 }
26d986865487 [project @ 1995-02-26 03:23:43 by jwe] jwe parents: 1118 diff changeset	725
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	726 DEFUN (get_help_text, args, , "-- texinfo --\n\
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	727 @deftypefn {Loadable Function} {[@var{text}, @var{format}] =} get_help_text (@var{name})\n\
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	728 Returns the help text of a given function.\n\
3168 1c267910655d [project @ 1998-04-19 01:22:38 by jwe] jwe parents: 3164 diff changeset	729 \n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	730 This function returns the raw help text @var{text} and an indication of\n\
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	731 its format for the function @var{name}. The format indication @var{format}\n\
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	732 is a string that can be either @t{\"texinfo\"}, @t{\"html\"}, or\n\
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	733 @t{\"plain text\"}.\n\
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3330 diff changeset	734 \n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	735 To convert the help text to other formats, use the @code{makeinfo} function.\n\
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	736 \n\
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	737 @seealso{makeinfo}\n\
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	738 @end deftypefn")
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	739 {
2086 bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe] jwe parents: 1996 diff changeset	740 octave_value_list retval;
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	741
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	742 if (args.length () == 1)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	743 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	744 const std::string name = args (0).string_value ();
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	745
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	746 if (! error_state)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	747 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	748 std::string text;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	749 std::string format;
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	750
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	751 do_get_help_text (name, text, format);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	752
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	753 retval(1) = format;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	754 retval(0) = text;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	755 }
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	756 else
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	757 error ("get_help_text: invalid input");
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	758 }
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	759 else
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	760 print_usage ();
529 7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	761
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	762 return retval;
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	763 }
7ea224e713cd [project @ 1994-07-20 18:54:27 by jwe] jwe parents: 389 diff changeset	764
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	765 // Return a cell array of strings containing the names of all
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	766 // operators.
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	767
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	768 DEFUN (__operators__, , ,
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	769 "-- texinfo --\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	770 @deftypefn {Function File} __operators__ ()\n\
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	771 Undocumented internal function.\n\
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	772 @end deftypefn")
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	773 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	774 return octave_value (Cell (names (operators_map)));
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	775 }
c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	776
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	777 // Return a cell array of strings containing the names of all
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	778 // keywords.
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	779
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	780 DEFUN (__keywords__, , ,
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	781 "-- texinfo --\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	782 @deftypefn {Function File} __keywords__ ()\n\
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	783 Undocumented internal function.\n\
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	784 @end deftypefn")
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	785 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	786 return octave_value (Cell (names (keywords_map)));
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	787 }
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	788
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	789 // Return a cell array of strings containing the names of all builtin
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	790 // functions.
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	791
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	792 DEFUN (__builtins__, , ,
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	793 "-- texinfo --\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	794 @deftypefn {Function File} __builtins__ ()\n\
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	795 Undocumented internal function.\n\
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	796 @end deftypefn")
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	797 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	798 const string_vector bif = symbol_table::built_in_function_names ();
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	799
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	800 return octave_value (Cell (bif));
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	801 }
c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	802
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	803 static std::string
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	804 do_which (const std::string& name, std::string& type)
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	805 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	806 std::string file;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	807
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	808 type = std::string ();
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	809
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	810 octave_value val = symbol_table::find_function (name);
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	811
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	812 if (val.is_defined ())
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	813 {
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	814 octave_function *fcn = val.function_value ();
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	815
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	816 if (fcn)
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	817 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	818 file = fcn->fcn_file_name ();
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	819
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	820 if (file.empty ())
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	821 {
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	822 if (fcn->is_user_function ())
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	823 type = "command-line function";
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	824 else
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	825 type = "built-in function";
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	826 }
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	827 else
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	828 type = val.is_user_script ()
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	829 ? std::string ("script") : std::string ("function");
7336 745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	830 }
745a8299c2b5 [project @ 2007-12-28 20:56:55 by jwe] jwe parents: 7272 diff changeset	831 }
8672 2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	832 else
2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	833 {
2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	834 // We might find a file that contains only a doc string.
2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	835
2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	836 file = load_path::find_fcn_file (name);
2a49c32d4322 allow help to work with files containing only comments John W. Eaton <jwe@octave.org> parents: 8631 diff changeset	837 }
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	838
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	839 return file;
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	840 }
c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	841
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	842 std::string
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	843 do_which (const std::string& name)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	844 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	845 std::string retval;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	846
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	847 std::string type;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	848
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	849 retval = do_which (name, type);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	850
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	851 return retval;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	852 }
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	853
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	854 DEFUN (__which__, args, ,
3361 4f40efa995c1 [project @ 1999-11-19 21:19:37 by jwe] jwe parents: 3356 diff changeset	855 "-- texinfo --\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	856 @deftypefn {Built-in Function} {} __which__ (@var{name}, @dots{})\n\
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	857 Undocumented internal function.\n\
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	858 @end deftypefn")
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	859 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	860 octave_value retval;
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	861
1968 a2e206524aa0 [project @ 1996-02-17 02:54:24 by jwe] jwe parents: 1957 diff changeset	862 string_vector argv = args.make_argv ("which");
1755 3a9462b655f1 [project @ 1996-01-22 04:47:22 by jwe] jwe parents: 1742 diff changeset	863
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	864 if (! error_state)
c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	865 {
c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	866 int argc = argv.length ();
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	867
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	868 if (argc > 1)
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	869 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	870 Octave_map m (dim_vector (1, argc-1));
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	871
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	872 Cell names (1, argc-1);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	873 Cell files (1, argc-1);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	874 Cell types (1, argc-1);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	875
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	876 for (int i = 1; i < argc; i++)
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	877 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	878 std::string name = argv[i];
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	879
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	880 std::string type;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	881
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	882 std::string file = do_which (name, type);
3141 292ff0bf484b [project @ 1998-02-03 08:11:07 by jwe] jwe parents: 3018 diff changeset	883
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	884 names(i-1) = name;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	885 files(i-1) = file;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	886 types(i-1) = type;
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	887 }
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	888
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	889 m.assign ("name", names);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	890 m.assign ("file", files);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	891 m.assign ("type", types);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	892
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	893 retval = m;
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	894 }
3355 c4983fc7318f [project @ 1999-11-18 05:20:50 by jwe] jwe parents: 3333 diff changeset	895 else
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5818 diff changeset	896 print_usage ();
581 bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	897 }
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	898
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	899 return retval;
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	900 }
bc813f5eb025 [project @ 1994-08-07 01:02:15 by jwe] jwe parents: 572 diff changeset	901
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	902 // FIXME -- Are we sure this function always does the right thing?
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	903 inline bool
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	904 file_is_in_dir (const std::string filename, const std::string dir)
5447 051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	905 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	906 if (filename.find (dir) == 0)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	907 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	908 const int dir_len = dir.size ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	909 const int filename_len = filename.size ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	910 const int max_allowed_seps = file_ops::is_dir_sep (dir [dir_len-1]) ? 0 : 1;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	911
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	912 int num_seps = 0;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	913 for (int i = dir_len; i < filename_len; i++)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	914 if (file_ops::is_dir_sep (filename [i]))
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	915 num_seps ++;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	916
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	917 return (num_seps <= max_allowed_seps);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	918 }
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	919 else
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	920 return false;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	921 }
5447 051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	922
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	923 // Return a cell array of strings containing the names of all
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	924 // functions available in DIRECTORY. If no directory is given, search
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	925 // the current path.
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	926
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	927 DEFUN (__list_functions__, args, ,
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	928 "-- texinfo --\n\
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	929 @deftypefn {Function File} {@var{retval} =} __list_functions__ ()\n\
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	930 @deftypefnx{Function File} {@var{retval} =} __list_functions__ (@var{directory})\n\
8812 7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	931 Undocumented internal function.\n\
7d48766c21a5 use consistent format for doc strings of internal functions John W. Eaton <jwe@octave.org> parents: 8672 diff changeset	932 @end deftypefn")
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	933 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	934 octave_value_list retval;
5447 051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	935
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	936 // Get list of functions
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	937 const string_vector ffl = load_path::fcn_names ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	938 const int ffl_len = ffl.length ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	939 const string_vector afl = autoloaded_functions ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	940 const int afl_len = afl.length ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	941
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	942 if (args.length () == 0)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	943 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	944 Cell C (ffl_len + afl_len, 1);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	945 int j = 0;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	946 for (int i = 0; i < ffl_len; i++)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	947 C (j++, 0) = octave_value (ffl [i]);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	948 for (int i = 0; i < afl_len; i++)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	949 C (j++, 0) = octave_value (afl [i]);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	950
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	951 retval.append (octave_value (C));
5447 051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	952 }
051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	953 else
051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	954 {
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	955 // Get input
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	956 std::string dir = args (0).string_value ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	957 if (error_state)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	958 error ("__list_functions__: input must be a string");
5447 051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	959 else
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	960 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	961 dir = file_ops::canonicalize_file_name (dir);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	962
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	963 // FIXME -- This seems very inefficient. Is there a better way?
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	964 std::list<std::string> list;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	965 for (int i = 0; i < ffl_len; i++)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	966 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	967 const std::string filename = do_which (ffl [i]);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	968 if (file_is_in_dir (filename, dir))
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	969 list.push_back (ffl [i]);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	970 }
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	971 for (int i = 0; i < afl_len; i++)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	972 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	973 const std::string filename = do_which (afl [i]);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	974 if (file_is_in_dir (filename, dir))
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	975 list.push_back (afl [i]);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	976 }
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	977
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	978 Cell C (list.size (), 1);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	979 int j = 0;
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	980 for (std::list<std::string>::const_iterator iter = list.begin ();
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	981 iter != list.end (); iter++)
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	982 {
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	983 C (j++, 0) = octave_value (*iter);
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	984 }
5447 051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	985
8575 f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	986 retval.append (octave_value (C));
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	987 }
f134925a1cfa m-file implementation of help system Soren Hauberg <soren@hauberg.org> parents: 8503 diff changeset	988 }
5447 051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	989
051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	990 return retval;
051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	991 }
051ddd7a6681 [project @ 2005-09-14 05:18:23 by jwe] jwe parents: 5399 diff changeset	992
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	993 DEFUN (info_file, args, nargout,
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	994 "-- texinfo --\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	995 @deftypefn {Built-in Function} {@var{val} =} info_file ()\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	996 @deftypefnx {Built-in Function} {@var{old_val} =} info_file (@var{new_val})\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	997 Query or set the internal variable that specifies the name of the\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	998 Octave info file. The default value is\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	999 @code{\"@var{octave-home}/info/octave.info\"}, in\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1000 which @var{octave-home} is the directory where all of Octave is installed.\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1001 @seealso{info_program, doc, help, makeinfo_program}\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1002 @end deftypefn")
2202 31b62b7c5d2d [project @ 1996-05-15 06:07:11 by jwe] jwe parents: 2189 diff changeset	1003 {
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1004 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_file);
2202 31b62b7c5d2d [project @ 1996-05-15 06:07:11 by jwe] jwe parents: 2189 diff changeset	1005 }
31b62b7c5d2d [project @ 1996-05-15 06:07:11 by jwe] jwe parents: 2189 diff changeset	1006
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1007 DEFUN (info_program, args, nargout,
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1008 "-- texinfo --\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1009 @deftypefn {Built-in Function} {@var{val} =} info_program ()\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1010 @deftypefnx {Built-in Function} {@var{old_val} =} info_program (@var{new_val})\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1011 Query or set the internal variable that specifies the name of the\n\
7096 81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7082 diff changeset	1012 info program to run. The default value is\n\
3686 9507d6de9bbd [project @ 2000-06-29 16:30:44 by jwe] jwe parents: 3584 diff changeset	1013 @code{\"@var{octave-home}/libexec/octave/@var{version}/exec/@var{arch}/info\"}\n\
9507d6de9bbd [project @ 2000-06-29 16:30:44 by jwe] jwe parents: 3584 diff changeset	1014 in which @var{octave-home} is the directory where all of Octave is\n\
9507d6de9bbd [project @ 2000-06-29 16:30:44 by jwe] jwe parents: 3584 diff changeset	1015 installed, @var{version} is the Octave version number, and @var{arch}\n\
9507d6de9bbd [project @ 2000-06-29 16:30:44 by jwe] jwe parents: 3584 diff changeset	1016 is the system type (for example, @code{i686-pc-linux-gnu}). The\n\
9507d6de9bbd [project @ 2000-06-29 16:30:44 by jwe] jwe parents: 3584 diff changeset	1017 default initial value may be overridden by the environment variable\n\
9507d6de9bbd [project @ 2000-06-29 16:30:44 by jwe] jwe parents: 3584 diff changeset	1018 @code{OCTAVE_INFO_PROGRAM}, or the command line argument\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1019 @code{--info-program NAME}.\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1020 @seealso{info_file, doc, help, makeinfo_program}\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1021 @end deftypefn")
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1022 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1023 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (info_program);
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1024 }
3686 9507d6de9bbd [project @ 2000-06-29 16:30:44 by jwe] jwe parents: 3584 diff changeset	1025
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1026 DEFUN (makeinfo_program, args, nargout,
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1027 "-- texinfo --\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1028 @deftypefn {Built-in Function} {@var{val} =} makeinfo_program ()\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1029 @deftypefnx {Built-in Function} {@var{old_val} =} makeinfo_program (@var{new_val})\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1030 Query or set the internal variable that specifies the name of the\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1031 makeinfo program that Octave runs to format help text containing\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1032 Texinfo markup commands. The default initial value is @code{\"makeinfo\"}.\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1033 @seealso{info_file, info_program, doc, help}\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1034 @end deftypefn")
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1035 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1036 return SET_NONEMPTY_INTERNAL_STRING_VARIABLE (makeinfo_program);
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1037 }
2202 31b62b7c5d2d [project @ 1996-05-15 06:07:11 by jwe] jwe parents: 2189 diff changeset	1038
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1039 DEFUN (suppress_verbose_help_message, args, nargout,
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1040 "-- texinfo --\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1041 @deftypefn {Built-in Function} {@var{val} =} suppress_verbose_help_message ()\n\
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1042 @deftypefnx {Built-in Function} {@var{old_val} =} suppress_verbose_help_message (@var{new_val})\n\
7001 8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe] jwe parents: 6620 diff changeset	1043 Query or set the internal variable that controls whether Octave\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1044 will add additional help information to the end of the output from\n\
3332 7c03933635c6 [project @ 1999-11-02 06:57:12 by jwe] jwe parents: 3330 diff changeset	1045 the @code{help} command and usage messages for built-in commands.\n\
5794 1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1046 @end deftypefn")
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1047 {
1138ced03f14 [project @ 2006-05-08 20:23:04 by jwe] jwe parents: 5780 diff changeset	1048 return SET_INTERNAL_VARIABLE (suppress_verbose_help_message);
2189 d01936305d99 [project @ 1996-05-14 03:31:57 by jwe] jwe parents: 2177 diff changeset	1049 }
d01936305d99 [project @ 1996-05-14 03:31:57 by jwe] jwe parents: 2177 diff changeset	1050
1 78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	1051 /*
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	1052 ;;; Local Variables: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	1053 ;;; mode: C++ ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	1054 ;;; End: ***
78fd87e624cb [project @ 1993-08-08 01:13:40 by jwe] jwe parents: diff changeset	1055 */

Mercurial > hg > octave-nkf

annotate src/help.cc @ 8812:7d48766c21a5