help.h

Go to the documentation of this file.
00001 /*
00002 
00003 Copyright (C) 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2005, 2006,
00004               2007, 2009 John W. Eaton
00005 
00006 This file is part of Octave.
00007 
00008 Octave is free software; you can redistribute it and/or modify it
00009 under the terms of the GNU General Public License as published by the
00010 Free Software Foundation; either version 3 of the License, or (at your
00011 option) any later version.
00012 
00013 Octave is distributed in the hope that it will be useful, but WITHOUT
00014 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00015 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00016 for more details.
00017 
00018 You should have received a copy of the GNU General Public License
00019 along with Octave; see the file COPYING.  If not, see
00020 <http://www.gnu.org/licenses/>.
00021 
00022 */
00023 
00024 #if !defined (octave_help_h)
00025 #define octave_help_h 1
00026 
00027 #include <iosfwd>
00028 #include <string>
00029 
00030 class string_vector;
00031 
00032 extern string_vector make_name_list (void);
00033 
00034 extern OCTINTERP_API std::string raw_help (const std::string&, bool&);
00035 
00036 // Name of the doc cache file specified on the command line.
00037 // (--doc-cache-file file)
00038 extern std::string Vdoc_cache_file;
00039 
00040 // Name of the info file specified on command line.
00041 // (--info-file file)
00042 extern std::string Vinfo_file;
00043 
00044 // Name of the info reader we'd like to use.
00045 // (--info-program program)
00046 extern std::string Vinfo_program;
00047 
00048 extern std::string do_which (const std::string& name);
00049 
00050 #endif
00051 
00052 /*
00053 ;;; Local Variables: ***
00054 ;;; mode: C++ ***
00055 ;;; End: ***
00056 */
	Octave-Forge - Extra packages for GNU Octave
	Home · Packages · Developers · Documentation · FAQ · Bugs · Mailing Lists · Links · Code
Navigation

help.h
