1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
## Copyright (C) 2005-2013 Søren Hauberg
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Command} {} doc @var{function_name}
## Display documentation for the function @var{function_name}
## directly from an online version of
## the printed manual, using the GNU Info browser. If invoked without
## any arguments, the manual is shown from the beginning.
##
## For example, the command @kbd{doc rand} starts the GNU Info browser
## at the @code{rand} node in the online version of the manual.
##
## Once the GNU Info browser is running, help for using it is available
## using the command @kbd{C-h}.
## @seealso{help}
## @end deftypefn
## Author: Soren Hauberg <soren@hauberg.org>
## Adapted-by: jwe
function retval = doc (fname)
if (nargin == 0 || nargin == 1)
ftype = 0;
if (nargin == 1)
## Get the directory where the function lives.
## FIXME -- maybe we should have a better way of doing this.
if (ischar (fname))
ftype = exist (fname);
else
error ("doc: expecting argument to be a character string");
endif
else
fname = "";
endif
## if GUI is running, let it display the function
if isguirunning ()
__octave_link_show_doc__ (fname);
else
if (ftype == 2 || ftype == 3)
ffile = which (fname);
else
ffile = "";
endif
if (isempty (ffile))
info_dir = octave_config_info ("infodir");
else
info_dir = fileparts (ffile);
endif
## Determine if a file called doc.info exist in the same
## directory as the function.
info_file_name = fullfile (info_dir, "doc.info");
[stat_info, err] = stat (info_file_name);
if (err < 0)
info_file_name = info_file ();
if (! exist (info_file_name, "file")
&& ! exist ([info_file_name ".gz"], "file"))
__gripe_missing_component__ ("doc", "info-file");
endif
endif
## FIXME -- don't change the order of the arguments below because
## the info-emacs-info script currently expects --directory DIR as
## the third and fourth arguments. Someone should fix that.
cmd = sprintf ("\"%s\" --file \"%s\" --directory \"%s\"",
info_program (), info_file_name, info_dir);
have_fname = ! isempty (fname);
if (have_fname)
status = system (sprintf ("%s --index-search \"%s\"", cmd, fname));
endif
if (! (have_fname && status == 0))
status = system (cmd);
if (status == 127)
warning ("unable to find info program '%s'", info_program ());
endif
endif
if (nargout > 0)
retval = status;
endif
endif
else
print_usage ();
endif
endfunction
%!test
%! ifile = info_file ();
%! if (exist (ifile) != 2 && exist (sprintf ("%s.gz", ifile)) != 2)
%! error ("Info file %s or %s.gz does not exist!", ifile, ifile);
%! endif
|
