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
|
function op1=ltfathelp(varargin)
%-*- texinfo -*-
%@deftypefn {Function} ltfathelp
%@verbatim
%LTFATHELP Help on the LTFAT toolbox
% Usage: ltfathelp;
% v=ltfathelp('version');
% mlist=ltfathelp('modules');
%
% LTFATHELP displays some general help on the LTFAT toolbox.
%
% LTFATHELP('version') returns the version number.
%
% LTFATHELP('modules') returns a cell array of installed modules and
% corresponding version numbers.
%
%@end verbatim
%@strong{Url}: @url{http://ltfat.github.io/doc/ltfathelp.html}
%@seealso{ltfatstart}
%@end deftypefn
% Copyright (C) 2005-2016 Peter L. Soendergaard <peter@sonderport.dk>.
% This file is part of LTFAT version 2.3.1
%
% This program 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.
%
% This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
% AUTHOR : Peter L. Soendergaard.
% TESTING: NA
% REFERENCE: NA
% Verify that comp_pgauss is in path
if ~exist('comp_pgauss','file')
disp(' ');
disp('--- LTFAT - The Linear Time Frequency Analysis toolbox. ---');
disp(' ')
disp('To start the toolbox, call LTFATSTART as the first command.');
disp(' ');
return;
end;
bp=ltfatbasepath;
definput.keyvals.versiondata=[];
definput.keyvals.modulesdata=[];
definput.flags.mode={'general','version','modules'};
[flags,kv]=ltfatarghelper({},definput,varargin);
if flags.do_general
disp(' ');
disp('--- LTFAT - The Linear Time Frequency Analysis toolbox. ---');
disp(' ')
disp(['Version ',kv.versiondata]);
disp(' ');
disp('Installed modules:');
disp(' ');
disp('Name: Version: Description');
modinfo=ltfathelp('modules');
for ii=1:length(modinfo);
s=sprintf(' %-15s %7s %s',modinfo{ii}.name,modinfo{ii}.version, ...
modinfo{ii}.description);
disp(s);
end;
disp('Type "help modulename" where "modulename" is the name of one')
disp('of the modules to see help on that module.')
disp(' ');
disp('For other questions, please don''t hesitate to send an email to ltfat-help@lists.sourceforge.net.');
end;
if flags.do_version
op1=kv.versiondata;
end;
if flags.do_modules
op1={};
for ii=1:numel(kv.modulesdata)
p=kv.modulesdata{ii};
% Get the first line of the help file
[FID, MSG] = fopen ([bp,p.name,filesep,'Contents.m'],'r');
if FID==-1
error('Module %s does not contain a Contents.m file.',p.name);
end;
firstline = fgetl (FID);
fclose(FID);
% Load the information into the cell array.
op1{ii}.name=p.name;
op1{ii}.version=p.version;
op1{ii}.description=firstline(2:end);
end;
end;
|
