help.h

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