Mercurial > octave-nkf

comparison scripts/miscellaneous/edit.m @ 10793:be55736a0783

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammarcheck the documentation from m-files.
author Rik <octave@nomad.inbox5.com>
date Sun, 18 Jul 2010 20:35:16 -0700
parents d1978e7364ad
children 693e22af08ae
comparison
equal deleted inserted replaced
10792:91342260063e 10793:be55736a0783
28 ## @itemize @bullet 28 ## @itemize @bullet
29 ## @item 29 ## @item
30 ## If the function @var{name} is available in a file on your path and 30 ## If the function @var{name} is available in a file on your path and
31 ## that file is modifiable, then it will be edited in place. If it 31 ## that file is modifiable, then it will be edited in place. If it
32 ## is a system function, then it will first be copied to the directory 32 ## is a system function, then it will first be copied to the directory
33 ## @code{HOME} (see further down) and then edited. 33 ## @env{HOME} (see further down) and then edited.
34 ## If no file is found, then the m-file 34 ## If no file is found, then the m-file
35 ## variant, ending with ".m", will be considered. If still no file 35 ## variant, ending with ".m", will be considered. If still no file
36 ## is found, then variants with a leading "@@" and then with both a 36 ## is found, then variants with a leading "@@" and then with both a
37 ## leading "@@" and trailing ".m" will be considered. 37 ## leading "@@" and trailing ".m" will be considered.
38 ## 38 ##
39 ## @item 39 ## @item
40 ## If @var{name} is the name of a function defined in the interpreter but 40 ## If @var{name} is the name of a function defined in the interpreter but
41 ## not in an m-file, then an m-file will be created in @code{HOME} 41 ## not in an m-file, then an m-file will be created in @env{HOME}
42 ## to contain that function along with its current definition. 42 ## to contain that function along with its current definition.
43 ## 43 ##
44 ## @item 44 ## @item
45 ## If @code{name.cc} is specified, then it will search for @code{name.cc} 45 ## If @code{name.cc} is specified, then it will search for @code{name.cc}
46 ## in the path and try to modify it, otherwise it will create a new 46 ## in the path and try to modify it, otherwise it will create a new
47 ## @file{.cc} file in @code{HOME}. If @var{name} happens to be an 47 ## @file{.cc} file in @env{HOME}. If @var{name} happens to be an
48 ## m-file or interpreter defined function, then the text of that 48 ## m-file or interpreter defined function, then the text of that
49 ## function will be inserted into the .cc file as a comment. 49 ## function will be inserted into the .cc file as a comment.
50 ## 50 ##
51 ## @item 51 ## @item
52 ## If @var{name.ext} is on your path then it will be edited, otherwise 52 ## If @var{name.ext} is on your path then it will be edited, otherwise
53 ## the editor will be started with @file{HOME/name.ext} as the 53 ## the editor will be started with @file{HOME/name.ext} as the
54 ## filename. If @file{name.ext} is not modifiable, it will be copied to 54 ## filename. If @file{name.ext} is not modifiable, it will be copied to
55 ## @code{HOME} before editing. 55 ## @env{HOME} before editing.
56 ## 56 ##
57 ## @strong{WARNING!} You may need to clear name before the new definition 57 ## @strong{WARNING!} You may need to clear name before the new definition
58 ## is available. If you are editing a .cc file, you will need 58 ## is available. If you are editing a .cc file, you will need
59 ## to mkoctfile @file{name.cc} before the definition will be available. 59 ## to mkoctfile @file{name.cc} before the definition will be available.
60 ## @end itemize 60 ## @end itemize
69 ## The following control fields are used: 69 ## The following control fields are used:
70 ## 70 ##
71 ## @table @samp 71 ## @table @samp
72 ## @item editor 72 ## @item editor
73 ## This is the editor to use to modify the functions. By default it uses 73 ## This is the editor to use to modify the functions. By default it uses
74 ## Octave's @code{EDITOR} built-in function, which comes from 74 ## Octave's @env{EDITOR} built-in function, which comes from
75 ## @code{getenv("EDITOR")} and defaults to @code{emacs}. Use @code{%s} 75 ## @code{getenv("EDITOR")} and defaults to @code{emacs}. Use @code{%s}
76 ## In place of the function name. For example, 76 ## In place of the function name. For example,
77 ## @table @samp 77 ## @table @samp
78 ## @item [EDITOR, " %s"] 78 ## @item [EDITOR, " %s"]
79 ## Use the editor which Octave uses for @code{bug_report}. 79 ## Use the editor which Octave uses for @code{bug_report}.