From bug-request at octave dot org Wed Mar 15 11:41:29 2006
Subject: Re: [Pkg-octave-devel] Update for mkoctfile manpage
From: "Keith Goodman" <kwgoodman at gmail dot com>
To: "John W. Eaton" <jwe at bevo dot che dot wisc dot edu>
Cc: "Rafael Laboissiere" <rafael at debian dot org>,         "Thomas Weber" <thomas.weber.mail@gmail.com>, bug@octave.org,         pkg-octave-devel@lists.alioth.debian.org
Date: Wed, 15 Mar 2006 09:39:38 -0800

On 3/15/06, John W. Eaton <jwe at bevo dot che dot wisc dot edu> wrote:
> On  1-Nov-2005, Rafael Laboissiere wrote:
>
> | * Thomas Weber <thomas dot weber dot mail at gmail dot com> [2005-11-01 21:44]:
> |
> | > mkoctfile -p knows more options than mentioned in the current manpage.
> | > The attached patch is taken against mkoctfile.1 from
> | > svn://svn.debian.org/svn/pkg-octave/tags/packages/octave2.1/2.1.64-3/debian/mkoctfile.1
> | >
> | > (Sorry, I didn't find a copy in the normal trunk).
> |
> | It is normal that you did not find the file in trunk because it has been
> | integrated upstream since a while.  Therefore, I am Cc:ing this message to
> | bug at octave dot org dot 
>
> I updated the mkoctfile help text and the mkoctfile.1 man page to
> include all the configuration variables that it currently knows about.

Do you think that there are some users who will type mkoctfile at the
Octave prompt? Or try "help mkoctfile".

Is it worth it to make a mkoctfile.m that contains only the help text
and instructions to run mkoctfile from the shell?

Actually you can't make a m-file with only a help string:

function y=fx(x)
% help text

-----------------------------------------------------------------------------
>> help fx
error: invalid character `ÿ' (ASCII 255) near line 3, column 2
parse error near line 3 of file /home/keith/tmp/fx.m

  syntax error




help: `fx' is not documented
-----------------------------------------------------------------------------

function y=fx(x)
% help text
y = x;

-----------------------------------------------------------------------------
>> help fx
fx is the user-defined function from the file
/home/keith/tmp/fx.m

help text

>>



-------------------------------------------------------------
Octave is freely available under the terms of the GNU GPL.

Octave's home on the web:  http://www.octave.org
How to fund new projects:  http://www.octave.org/funding.html
Subscription information:  http://www.octave.org/archive.html
-------------------------------------------------------------